Source: https://dev-docs.nebula-graph.io/v5.3.2/visualization/studio/install/ Documentation version: v5.3.2 # Install NebulaGraph Studio Download a package for your operating system and CPU architecture from [GitHub Releases](https://github.com/vesoft-inc/nebula-ng-studio/releases/tag/v5.3.2), or deploy the container image with Docker Compose. You do not need to download the source code or build an image. The [quick start](https://dev-docs.nebula-graph.io/v5.3.2/get-started/deploy/) starts NebulaGraph Studio with NebulaGraph Database Developer Edition by default, so you can [connect and run your first query](https://dev-docs.nebula-graph.io/v5.3.2/get-started/first-query/#connect) directly. To switch to a separate installation described here, first run `ACCEPT_EULA=Y docker compose up -d --scale studio=0` in the directory containing NebulaGraph Database Developer Edition's `compose.yaml`. This disables the supplied Studio container and frees port `7001`. For PowerShell syntax, see the [PowerShell startup command instructions](https://dev-docs.nebula-graph.io/v5.3.2/get-started/deploy/#powershell). ## Download v5.3.2 packages Choose a package for your operating system and CPU architecture, then click its filename to download it. To verify the download, also click Checksum in the same row. | Format | Architecture | Package | SHA-256 checksum file | TAR | x86-64 | [nebula-studio-5.3.2-linux-amd64.tar.gz](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio-5.3.2-linux-amd64.tar.gz) | [Checksum](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio-5.3.2-linux-amd64.tar.gz.sha256) | TAR | ARM64 | [nebula-studio-5.3.2-linux-arm64.tar.gz](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio-5.3.2-linux-arm64.tar.gz) | [Checksum](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio-5.3.2-linux-arm64.tar.gz.sha256) | RPM | x86-64 | [nebula-studio-5.3.2-1.x86_64.rpm](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio-5.3.2-1.x86_64.rpm) | [Checksum](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio-5.3.2-1.x86_64.rpm.sha256) | RPM | ARM64 | [nebula-studio-5.3.2-1.aarch64.rpm](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio-5.3.2-1.aarch64.rpm) | [Checksum](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio-5.3.2-1.aarch64.rpm.sha256) | DEB | x86-64 | [nebula-studio_5.3.2-1_amd64.deb](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio_5.3.2-1_amd64.deb) | [Checksum](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio_5.3.2-1_amd64.deb.sha256) | DEB | ARM64 | [nebula-studio_5.3.2-1_arm64.deb](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio_5.3.2-1_arm64.deb) | [Checksum](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio_5.3.2-1_arm64.deb.sha256) TAR packages work on Linux. Use an RPM package on an RPM-based distribution or a DEB package on a DEB-based distribution. You can also download a package with `wget`. For example, to download the Linux x86-64 TAR package: ```` wget https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio-5.3.2-linux-amd64.tar.gz ```` To download a different format or architecture, replace the filename in the command with the matching filename from the table. Text in `<...>` is a placeholder; replace it with the actual filename before running a command. After downloading, you can run `sha256sum -c ` with the matching checksum file. Port `7001` is used by default; make sure it is available. For Docker Compose, see [Deploy with Docker Compose](https://dev-docs.nebula-graph.io/v5.3.2/visualization/studio/install/#deploy-with-docker-compose). ## Install from a TAR package 1. Extract the downloaded TAR package in the directory where you want to install NebulaGraph Studio: ```` tar -xzf ```` 2. Enter the extracted directory containing `bin`, `etc`, and `scripts`. Edit `etc/config.yaml` if needed. See [NebulaGraph Studio configurations](https://dev-docs.nebula-graph.io/v5.3.2/visualization/studio/configs/). 3. Start the service and check its status: ```` sudo ./scripts/studio.service start all sudo ./scripts/studio.service status all ```` ## Install from an RPM package In the directory containing the downloaded RPM package, install and start the service: ```` sudo rpm -i sudo systemctl start nebula-studio.service sudo systemctl status nebula-studio.service ```` You can edit `/etc/nebula-studio/config.yaml` after installation. Restart the service after editing it. ## Install from a DEB package In the directory containing the downloaded DEB package, install and start the service: ```` sudo dpkg -i sudo systemctl start nebula-studio.service sudo systemctl status nebula-studio.service ```` You can edit `/etc/nebula-studio/config.yaml` after installation. Restart the service after editing it. ## Deploy with Docker Compose 1. Install [Docker and Docker Compose](https://docs.docker.com/compose/install/). 2. Create `studio-compose.yaml` in your deployment directory. The [Docker Hub image](https://hub.docker.com/r/vesoft/nebula-studio/tags) includes the default configuration, so no configuration file is needed: ```` name: nebula-studio services: studio: image: vesoft/nebula-studio:5.3.2 init: true extra_hosts: - 'host.docker.internal:host-gateway' ports: - '7001:7001' # environment: # - STUDIO_TOKEN_SECRET=${STUDIO_TOKEN_SECRET} # - STUDIO_ENCRYPT_PASSPHRASE=${STUDIO_ENCRYPT_PASSPHRASE} # - STUDIO_GRAPHD_DEFAULT_HOST=${STUDIO_GRAPHD_DEFAULT_HOST} # - STUDIO_GRAPHD_DEFAULT_PORT=${STUDIO_GRAPHD_DEFAULT_PORT} # - STUDIO_HEALTHCHECK_URL=${STUDIO_HEALTHCHECK_URL} volumes: - studio-data:/app/data restart: unless-stopped stop_grace_period: 10s volumes: studio-data: ```` When logging in to NebulaGraph Studio, enter `host.docker.internal` in the Graph host field if the Graph service runs on the same machine as Docker. If it runs on a different machine, enter that machine's IP address or domain name. Enter the Graph service's port. Do not use `localhost`: it refers to the NebulaGraph Studio container. 3. Start and check the service: ```` docker compose -f studio-compose.yaml up -d docker compose -f studio-compose.yaml ps ```` Container data is stored in the `studio-data` volume. Recreating the container does not delete the volume. ### Optional environment variables The commented environment variables in the example are optional. To use one, uncomment its line and `environment:`, then set its value on the machine running Compose or in a `.env` file next to `studio-compose.yaml`. The names are fixed; you supply the values. | Variable | Purpose | `STUDIO_TOKEN_SECRET` | Secret used to sign login tokens. | `STUDIO_ENCRYPT_PASSPHRASE` | Passphrase used to encrypt authentication information. It must be 16, 24, or 32 bytes long. | `STUDIO_GRAPHD_DEFAULT_HOST` | Default Graph service address shown on the login page. | `STUDIO_GRAPHD_DEFAULT_PORT` | Default Graph service port shown on the login page. | `STUDIO_HEALTHCHECK_URL` | Custom health check URL. In production, set stable values for the first two variables if login sessions must survive restarts. See [NebulaGraph Studio configurations](https://dev-docs.nebula-graph.io/v5.3.2/visualization/studio/configs/) for details. After changing environment variables, run `docker compose -f studio-compose.yaml up -d` to apply the new values. ### Customize the configuration Mount a configuration file only if you need to change the defaults: 1. Download `config-release.yaml` from the [repository](https://github.com/vesoft-inc/nebula-ng-studio/blob/v5.3.2/apps/server/etc/config-release.yaml). Save it next to `studio-compose.yaml` and edit it. 2. Add a bind mount under the `studio` service's `volumes`: ```` volumes: - studio-data:/app/data - ./config-release.yaml:/app/etc/config-release.yaml:ro ```` 3. Run `docker compose -f studio-compose.yaml up -d` to recreate the container with the mount. For later edits to the mounted file, run `docker compose -f studio-compose.yaml restart studio` to apply them. ## Verify the installation When the service is running, open `http://:7001` in a browser. If you changed the Docker Compose port mapping, use the new port on the machine running Docker. ## What's next [Connect to NebulaGraph Database Developer Edition](https://dev-docs.nebula-graph.io/v5.3.2/visualization/studio/connect/)