tsai
/
abp
mirror of https://github.com/abpframework/abp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Open Source Web Application Framework for ASP.NET Core
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
47190 Commits
281 Branches
302 Tags
2.4 GiB
 
 
 
 
 
 
Tree: 5c7aaf147c
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5c7aaf147c'
${ noResults }
abp/docs/en/studio/installation.md

4.7 KiB
Raw Blame History 

//[doc-seo]
{
    "Description": "Learn how to install ABP Studio, including system requirements and optional tools, to kickstart your development with ABP Framework."
}

Installing ABP Studio

This document explains how to install the ABP Studio tool.

Pre-requirements

ABP Studio automatically installs most of the required dependencies. When you first launch the application, it will check for and install the following components if missed:

  • .NET SDK
  • Node.js
  • ABP CLI
  • mkcert (for HTTPS development)
  • WireGuard (for Kubernetes operations)

However, the following should be manually installed:

Docker (Required for Kubernetes Operations)

ABP Studio needs Docker for Docker and Kubernetes operations. Install Docker by following the guidelines on the official Docker website.

Package Manager Prerequisites

  • Windows: The automatic installation process uses winget. If not already installed, ABP Studio will attempt to install it.
  • macOS: The automatic installation process uses brew. If not already installed, you'll need to install it manually from brew.sh.

Installation

Follow these steps to install ABP Studio:

  1. Download ABP Studio: Visit abp.io to download the latest version of ABP Studio.

abp-studio-download-page

  1. Run the Installer: Execute the installer and follow the on-screen instructions to install ABP Studio on your computer.

  2. First Launch: When you first launch ABP Studio, it will automatically check for and install required dependencies. This process may take several minutes, and you'll see progress indicators for each component being installed.

Login

After installation is complete, you can log in to access all features:

  1. Launch ABP Studio: Open ABP Studio on your desktop.

  2. Login Credentials: Enter your abp.io login credentials when prompted.

Changing the UI Theme

ABP Studio allows you to customize the user interface theme according to your preferences. You can change the UI theme as in the image below:

preference-theme-change

Upgrading

ABP Studio periodically checks for updates in the background, and when a new version of ABP Studio is available, you will be notified through a modal. The modal will prompt you to update to the latest version as follows:

new-version-available-window

When you see the "New Version Available" window, follow these steps to upgrade ABP Studio seamlessly:

  1. Click the "OK" button in the modal to initiate the download of the new version.
  2. A progress indicator will display the download status.
  3. Once the download is complete, a new modal will appear with the "Install and Relaunch" buttons.
  4. Click on the "Install and Relaunch" button to complete the installation process.

Installing a Specific Version

There is no official support for installing an older version of ABP Studio yet. But, if you want to install an older version of ABP Studio, you can use approach explained here https://github.com/enisn/AbpDevTools?tab=readme-ov-file#switch-abp-studio-version

Troubleshooting

Shell Environment Detection (macOS and Linux)

ABP Studio normally detects the shell environment automatically, so you do not need to configure the following variables. Use them only if Studio cannot find a tool that is available in your terminal, such as a user-managed .NET or Node.js installation.

On macOS and Linux, ABP Studio starts a shell during application startup and imports the environment variables printed by it. By default, Studio starts the shell as an interactive login shell and runs env.

Variable Description Fallback
ABP_STUDIO_SHELL Overrides the shell executable used to load the environment. Set it to a valid, non-empty executable path. When unset, SHELL, then /bin/zsh on macOS or /bin/bash on Linux
ABP_STUDIO_SHELL_ARGS Replaces the complete argument string passed to the selected shell. When unset or empty, -i -l -c 'env'

Set these variables in the environment that launches ABP Studio, then restart the application. Usually, you only need to override the shell executable. For example:

export ABP_STUDIO_SHELL=/bin/bash
export ABP_STUDIO_SHELL_ARGS="-i -l -c 'env'"

Note: Custom ABP_STUDIO_SHELL_ARGS must make the shell exit successfully and print the environment to standard output as newline-separated NAME=value entries. These settings have no effect on Windows.