# 服务器离线部署与配置

此文档适用于服务器已有 Nginx 的场景。部署包不包含 .env，因为其中存放数据库密码、JWT Secret、LiveKit Secret 和初始管理员密码。

## 1. 在构建机生成部署包

构建机需要 Docker，并能拉取镜像。

~~~bash
cd /path/to/ScreenShare
chmod +x scripts/package-release.sh
sudo ./scripts/package-release.sh 0.1.0
~~~

生成文件：

~~~text
release/screen-share-0.1.0.tar.gz
~~~

如使用 sudo 运行，按需将 release 目录归还给当前用户：

~~~bash
sudo chown -R $USER:$USER release
~~~

## 2. 传输并导入服务器

服务器需要 Docker Compose，但不需要访问镜像仓库。

~~~bash
scp release/screen-share-0.1.0.tar.gz deploy@your-server:/opt/
ssh deploy@your-server
cd /opt
tar -xzf screen-share-0.1.0.tar.gz
cd screen-share-0.1.0
sudo docker load -i images.tar
~~~

## 3. 创建服务器 .env

~~~bash
cp .env.example .env
chmod 600 .env
~~~

必须修改下列值，且不要提交或传回 Git：

~~~dotenv
POSTGRES_PASSWORD=替换为随机数据库密码
LIVEKIT_API_KEY=生产环境Key
LIVEKIT_API_SECRET=替换为随机LiveKit密钥
LIVEKIT_PUBLIC_URL=wss://share.example.com
AUTH_JWT_SECRET=替换为随机JWT密钥
BOOTSTRAP_ADMIN_PASSWORD=替换为强管理员密码
SCREENSHARE_VERSION=0.1.0
~~~

DOMAIN 仅供文档和 Nginx 示例使用；本项目由你已有的 Nginx 终止 HTTPS。

## 4. 配置 Nginx

复制 infra/nginx/screenshare.conf.example 的 server 配置到现有 Nginx 站点，将 share.example.com、证书路径改为真实值。map 指令只能在 http 块中声明一次。

验证并重载：

~~~bash
sudo nginx -t
sudo systemctl reload nginx
~~~

## 5. 启动服务

~~~bash
sudo docker compose --env-file .env up -d
sudo docker compose ps
sudo docker compose logs -f api
~~~

首次 API 启动会执行 Flyway 迁移并创建 bootstrap 管理员。浏览器访问 https://share.example.com。

## 6. 防火墙与安全组

开放：

~~~text
TCP 80, 443, 7881
UDP 50000-50100
~~~

不要开放 PostgreSQL 5432、API 8080、LiveKit HTTP/WebSocket 7880；它们只绑定到服务器 127.0.0.1。

## 7. 更新版本

在构建机用新版本号重新打包，例如 0.1.1。服务器上导入新 images.tar，修改 .env 中 SCREENSHARE_VERSION，再重建服务：

~~~bash
sudo docker load -i images.tar
sed -i 's/^SCREENSHARE_VERSION=.*/SCREENSHARE_VERSION=0.1.1/' .env
sudo docker compose --env-file .env up -d
~~~

PostgreSQL 卷会保留；Flyway 会自动执行新增迁移。数据库升级前建议备份卷或执行 pg_dump。