Source: https://dev-docs.yueshu.com.cn/v5.3.2/visualization/studio/install/
Documentation version: v5.3.2

# 安装悦数图管理

可以从 [GitHub Releases](https://github.com/vesoft-inc/nebula-ng-studio/releases/tag/v5.3.2) 下载适合操作系统和处理器架构的安装包，也可以使用 Docker Compose 部署容器镜像。无需下载源码或自行构建镜像。

按[快速开始](https://dev-docs.yueshu.com.cn/v5.3.2/get-started/deploy/)部署悦数图数据库开发版时，悦数图管理默认已随悦数图数据库开发版启动，可直接[连接并完成首次查询](https://dev-docs.yueshu.com.cn/v5.3.2/get-started/first-query/#connect)。要改用本页的独立部署方式，先在悦数图数据库开发版的`compose.yaml`所在目录执行`ACCEPT_EULA=Y docker compose up -d --scale studio=0`，停用配套 Studio 容器并释放`7001`端口。此命令的 PowerShell 写法见 [PowerShell 启动命令说明](https://dev-docs.yueshu.com.cn/v5.3.2/get-started/deploy/#powershell)。

## 下载 v5.3.2 安装包

根据操作系统和处理器架构选择安装包，单击文件名下载。如需校验文件完整性，再单击同一行的“校验文件”。

 | 格式 | 架构 | 安装包 | SHA-256 校验文件
 | 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) | [校验文件](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) | [校验文件](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) | [校验文件](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) | [校验文件](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) | [校验文件](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) | [校验文件](https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio_5.3.2-1_arm64.deb.sha256)

TAR 包适用于 Linux；RPM 包适用于使用 RPM 的 Linux 发行版；DEB 包适用于使用 DEB 的 Linux 发行版。也可以在命令行使用`wget`下载。以下以 Linux x86-64 的 TAR 包为例：

````
wget https://github.com/vesoft-inc/nebula-ng-studio/releases/download/v5.3.2/nebula-studio-5.3.2-linux-amd64.tar.gz

````

如需下载其他格式或架构的包，将命令中的文件名替换为上表对应的文件名。文中的`<...>`是占位符，执行命令前需替换为实际文件名。下载后，可使用对应的校验文件运行`sha256sum -c <校验文件名>`。默认访问端口为`7001`，请先确认该端口可用。使用 Docker Compose 时，请参见[使用 Docker Compose 部署](https://dev-docs.yueshu.com.cn/v5.3.2/visualization/studio/install/#docker-compose)。

## 使用 TAR 包安装

1. 

在准备安装的目录解压已下载的 TAR 包：

````
tar -xzf <下载的TAR文件>

````

2. 

进入解压后包含`bin`、`etc`和`scripts`的目录。按需修改`etc/config.yaml`。配置项说明参见[悦数图管理配置](https://dev-docs.yueshu.com.cn/v5.3.2/visualization/studio/configs/)。

3. 启动服务并查看状态：

````
sudo ./scripts/studio.service start all
sudo ./scripts/studio.service status all

````

## 使用 RPM 包安装

在已下载的 RPM 包所在目录，安装并启动服务：

````
sudo rpm -i <下载的RPM文件>
sudo systemctl start nebula-studio.service
sudo systemctl status nebula-studio.service

````

安装后可在`/etc/nebula-studio/config.yaml`修改配置。修改后需重启服务。

## 使用 DEB 包安装

在已下载的 DEB 包所在目录，安装并启动服务：

````
sudo dpkg -i <下载的DEB文件>
sudo systemctl start nebula-studio.service
sudo systemctl status nebula-studio.service

````

安装后可在`/etc/nebula-studio/config.yaml`修改配置。修改后需重启服务。

## 使用 Docker Compose 部署

1. 安装 [Docker 和 Docker Compose](https://docs.docker.com/compose/install/)。
2. 

在部署目录创建`studio-compose.yaml`。[Docker Hub 镜像](https://hub.docker.com/r/vesoft/nebula-studio/tags)已包含默认配置，无需准备配置文件：

````
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:

````

登录悦数图管理时，如果 Graph 服务与 Docker 运行在同一台机器上，Graph 地址填写`host.docker.internal`；如果在另一台机器上，填写那台机器的 IP 地址或域名。端口填写 Graph 服务实际使用的端口。不要填写`localhost`，它只会指向悦数图管理容器。

3. 

启动并查看状态：

````
docker compose -f studio-compose.yaml up -d
docker compose -f studio-compose.yaml ps

````

容器数据保存在`studio-data`卷中，重新创建容器不会删除该卷。

### 可选环境变量

示例中注释的环境变量均非必填。需要使用时，取消对应行和`environment:`的注释，并在运行 Compose 的机器上设置变量值，或在`studio-compose.yaml`所在目录的`.env`文件中设置。变量名固定，变量值由您填写。

 | 变量 | 用途
 | `STUDIO_TOKEN_SECRET` | 登录令牌的签名密钥。
 | `STUDIO_ENCRYPT_PASSPHRASE` | 加密认证信息的口令，须为 16、24 或 32 字节。
 | `STUDIO_GRAPHD_DEFAULT_HOST` | 登录页显示的默认 Graph 服务地址。
 | `STUDIO_GRAPHD_DEFAULT_PORT` | 登录页显示的默认 Graph 服务端口。
 | `STUDIO_HEALTHCHECK_URL` | 自定义健康检查 URL。

生产环境如需在重启后保留登录会话，应为前两个变量设置稳定的值。更多信息，请参见[悦数图管理配置](https://dev-docs.yueshu.com.cn/v5.3.2/visualization/studio/configs/)。修改环境变量后，运行`docker compose -f studio-compose.yaml up -d`使新值生效。

### 自定义配置

只有需要修改默认配置时，才需要挂载配置文件：

1. 从[仓库](https://github.com/vesoft-inc/nebula-ng-studio/blob/v5.3.2/apps/server/etc/config-release.yaml)下载`config-release.yaml`，保存到`studio-compose.yaml`所在目录并修改。
2. 

在`studio`服务的`volumes`中增加一行，将文件挂载到容器：

````
volumes:
  - studio-data:/app/data
  - ./config-release.yaml:/app/etc/config-release.yaml:ro

````

3. 

运行`docker compose -f studio-compose.yaml up -d`，让 Compose 重新创建容器并应用挂载。以后只修改已挂载的配置文件时，运行`docker compose -f studio-compose.yaml restart studio`使修改生效。

## 验证安装

服务运行后，在浏览器中访问`http://<部署机器地址>:7001`。如果通过 Docker Compose 修改了端口映射，请使用修改后的宿主机端口。

## 下一步

[连接悦数图数据库开发版集群](https://dev-docs.yueshu.com.cn/v5.3.2/visualization/studio/connect/)