部署指南

本文说明如何安装和部署构建产物。仓库维护者准备版本、创建 tag 和监控正式发布时，请参阅发布指南。

推荐发布流程（CI/CD）

发布和部署优先使用仓库里的 Package workflow（.github/workflows/package.yml），不要手动在本机跑构建脚本作为正式产物来源。

• 手动打包：进入 GitHub Actions → Package → Run workflow，选择 dev 或 main；手动运行只上传 Actions artifacts。
• 正式发布：在 main 上推送 v* tag；CI 会构建包并发布到 GitHub Release。
• CI 产物：dinotty-macos 包含 .dmg，dinotty-linux 包含桌面 .deb / .AppImage 和服务端 dinotty-server_*.deb，dinotty-windows 包含 NSIS 安装包和 portable .exe。
• 产物暂存：CI 会把包复制到 dist/package-artifacts/ 后上传，手动运行的 artifacts 默认保留 14 天。

本地脚本定位

./scripts/build.sh 和 ./scripts/build-linux-deb.sh 只用于本地修改代码后的临时构建、验证或排障；正式部署和发布请走上面的 CI/CD 流程。

# macOS，在仓库根目录运行；仅用于本地改代码后的临时构建
./scripts/build.sh native
./scripts/build.sh list

# 远程构建 Linux deb；仅用于本地改代码后的临时排障
./scripts/build-linux-deb.sh

Linux systemd 部署（推荐使用 CI deb）

从 Package workflow 的 dinotty-linux artifact 或 GitHub Release 下载服务端 deb 后安装：

sudo apt install ./dinotty-server_*.deb

# 管理命令
systemctl status dinotty       # 查看状态
systemctl restart dinotty      # 重启
systemctl stop dinotty         # 停止
journalctl -u dinotty -f       # 查看实时日志

# 修改配置后重启
sudo vim /etc/dinotty/env      # 编辑端口、Token、日志级别
sudo systemctl restart dinotty

deb 安装后会部署 dinotty-server、systemd unit 和 /etc/dinotty/env.example，并启用/启动 dinotty.service。

如果只是本地改代码后的临时二进制验证，可以显式传入本地构建产物：

sudo bash deploy/systemd/install.sh --bin target/release/dinotty-server --token your-secret-token
sudo bash deploy/systemd/uninstall.sh

Linux 桌面包

从 CI 的 dinotty-linux artifact 或 GitHub Release 获取桌面包：

# deb 安装包
sudo apt install ./Dinotty*.deb

# 或直接运行 AppImage
chmod +x ./Dinotty*.AppImage
./Dinotty*.AppImage

macOS 桌面包

从 CI 的 dinotty-macos artifact 或 GitHub Release 下载 .dmg，打开后按系统提示安装。

Windows 桌面包

从 CI 的 dinotty-windows artifact 或 GitHub Release 下载：

• NSIS 安装包：适合正常安装和卸载。
• portable .exe：适合免安装测试。

如需开机自启，可以使用 Windows 任务计划程序、NSSM 或 WinSW 包装 portable 可执行文件。

Docker 部署

Docker 镜像当前仍按本地 Compose 流程构建：

cd deploy/docker

# 配置环境变量
cp .env.example .env
# 编辑 .env 设置 DINOTTY_TOKEN、WORKSPACE_DIR 等

# 构建并启动（支持 amd64 和 arm64）
docker compose up -d --build

# 管理命令
docker compose logs -f         # 查看日志
docker compose restart         # 重启
docker compose down            # 停止并移除

# 多架构构建并推送
docker buildx build --platform linux/amd64,linux/arm64 \
  -t your-registry/dinotty:latest --push \
  -f deploy/docker/Dockerfile .

Windows 上可通过 Docker Desktop 使用 Linux 容器部署；.env 中的工作区路径需要按 Docker Desktop 的挂载路径填写。

跨平台包

跨平台桌面包由 Package workflow 的 matrix 统一生成：

平台	CI 环境	产物
macOS	macos-latest	.dmg
Linux	ubuntu-22.04	桌面 .deb / .AppImage、服务端 dinotty-server_*.deb
Windows	windows-latest	NSIS .exe、portable .exe

配置说明

参数	方式	默认值	说明
端口	--port / -p	8999	服务监听端口
Token	DINOTTY_TOKEN 环境变量或配置文件	未配置 / 首次设置	访问认证令牌，为空时进入首次设置流程
日志级别	RUST_LOG 环境变量	info	trace / debug / info / warn / error
Shell	Unix: SHELL；Windows: DINOTTY_SHELL	自动检测	Windows 优先 DINOTTY_SHELL，再尝试 pwsh.exe、powershell.exe、%ComSpec% / cmd.exe

配置与数据目录

平台	配置目录	插件目录
Linux	~/.config/dinotty	~/.dinotty/plugins
macOS	~/Library/Application Support/dinotty	~/.dinotty/plugins
Windows	%APPDATA%\dinotty	%USERPROFILE%\.dinotty\plugins

Token、settings.json、审计日志和 webhook secrets 存放在配置目录；插件持久化数据存放在用户目录下的 .dinotty/plugin-data。