From 2224195d056c1cf00606adb2aa545bb2c784f182 Mon Sep 17 00:00:00 2001 From: zijunchiang Date: Thu, 17 Sep 2026 03:07:23 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E8=A1=A5=E9=BD=90=E9=83=A8=E7=BD=B2?= =?UTF-8?q?=E5=BF=85=E9=9C=80=E7=9A=84=20Gitea=20=E5=9F=9F=E5=90=8D?= =?UTF-8?q?=E4=B8=8E=E5=B1=9E=E4=B8=BB=EF=BC=88=E4=B8=8D=E5=86=8D=E8=84=B1?= =?UTF-8?q?=E6=95=8F=E6=88=90=E5=8D=A0=E4=BD=8D=E7=AC=A6=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 域名与仓库属主属于「部署必需且非隐私」的信息，此前写成 `` / `` 会让文档无法照做（照抄的 clone / 下载命令直接失败）。本次把它们补成真实值： gitea.kasugano.cn / zijunchiang。口令、访问令牌、数据库口令等**秘密项**继续用占位符。 改动： - README.md / README.txt：发布包下载地址补成真实 Release 地址 （https://gitea.kasugano.cn/zijunchiang/opendance-web/releases/download/vX.Y.Z/…）， 并写明域名与属主是部署必需信息、不是隐私项； - README.md / README.txt：说明 `<服务器地址>` 是**部署方自己的**服务端地址 （部署方决定），不是被脱敏的信息，避免与「被隐藏的域名」混淆； - deploy/proxy/README.md：第九节的附件接口复验 curl 补成真实 Gitea 域名与属主； 自检清单里 `<反代地址>` 加一行说明（你们自己的反代域名或 IP）； - deploy/systemd/opendance-api.service：`Documentation=` 补成真实仓库地址。 --- README.md | 5 +++-- README.txt | 10 ++++++---- deploy/proxy/README.md | 3 ++- deploy/systemd/opendance-api.service | 2 +- 4 files changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4db3bbe..f391ba7 100644 --- a/README.md +++ b/README.md @@ -128,7 +128,7 @@ v0.2.0 主要变更: 2. 准备一个现有的 MySQL / MariaDB 实例,并建好库与账号(见下方[前置要求](#前置要求)) 本项目**不会创建数据库本身** -3. 取得发布包并校验(地址用你们自己的制品库替换; 下面是本仓库的发布地址) +3. 取得发布包并校验(**本仓库的真实发布地址**, 域名 `gitea.kasugano.cn`、属主 `zijunchiang` 属部署必需信息, 不是隐私项) ```bash curl -LO https://gitea.kasugano.cn/zijunchiang/opendance-web/releases/download/v0.7.2/opendance-web-v0.7.2.tar.gz @@ -149,7 +149,8 @@ v0.2.0 主要变更: bash deploy/install.sh ``` -6. 验证(把 `<服务器地址>` 换成实际地址) +6. 验证(把 `<服务器地址>` 换成实际地址 —— 它是**你们自己服务器的地址**， + 不是被脱敏的信息；本项目的文档只对 Gitea 域名这类部署必需信息直接写明真实值) ```bash curl -fsS http://<服务器地址>:3000/health # 期望 {"status":"ok",...} diff --git a/README.txt b/README.txt index 8715235..15454ea 100644 --- a/README.txt +++ b/README.txt @@ -176,16 +176,18 @@ v0.2.1 修订 node -v # 期望 v22 或更高 2. 准备一个现有的 MySQL / MariaDB 实例, 并建好库与账号(见下方"前置要求") 本项目不会创建数据库本身 - 3. 取得发布包并校验(地址用你们自己的制品库替换) - curl -LO https://<制品库地址>/opendance-web-v0.7.2.tar.gz - curl -LO https://<制品库地址>/SHA256SUMS + 3. 取得发布包并校验(以下是本仓库的真实发布地址; 域名 gitea.kasugano.cn + 与属主 zijunchiang 属部署必需信息, 不是隐私项) + curl -LO https://gitea.kasugano.cn/zijunchiang/opendance-web/releases/download/v0.7.2/opendance-web-v0.7.2.tar.gz + curl -LO https://gitea.kasugano.cn/zijunchiang/opendance-web/releases/download/v0.7.2/SHA256SUMS sha256sum -c SHA256SUMS # 期望输出 "OK" 4. 解压并生成配置(交互式引导, 逐项问答, 口令不回显) tar -xzf opendance-web-v0.7.2.tar.gz && cd opendance-web-v0.7.2 bash deploy/init-env.sh 5. 安装(建用户与目录 -> 装依赖 -> 迁移 -> 注册系统服务 -> 等健康检查) bash deploy/install.sh - 6. 验证(把 <服务器地址> 换成实际地址) + 6. 验证(把 <服务器地址> 换成实际地址 -- 它是你们自己服务器的地址, + 不是被脱敏的信息) curl -fsS http://<服务器地址>:3000/health # 期望 {"status":"ok",...} curl -sI http://<服务器地址>:3001/ | head -1 # 期望 200, 管理端页面 curl -sI http://<服务器地址>:3000/ | head -1 # 期望 404, API 端口不提供管理页 diff --git a/deploy/proxy/README.md b/deploy/proxy/README.md index ca9f9a7..ab57ed5 100644 --- a/deploy/proxy/README.md +++ b/deploy/proxy/README.md @@ -179,6 +179,7 @@ curl -i http://127.0.0.1:3000/health curl -i http://127.0.0.1:3001/health # 2. 经反代可访问 +# <反代地址> 指你们自己的反代域名或 IP（由部署方决定），不是被脱敏的信息。 curl -i http://<反代地址>/health # 3. 管理端页面可打开(应返回 HTML) @@ -349,7 +350,7 @@ head -c 40000000 /dev/urandom > /tmp/probe.bin curl -i -X POST \ -H "Authorization: token " \ -F "file=@/tmp/probe.bin" \ - "https:///api/v1/repos///releases//assets?name=probe.bin" + "https://gitea.kasugano.cn/api/v1/repos/zijunchiang//releases//assets?name=probe.bin" ``` 在放开上限之前，**不要**用分卷绕过：Windows 端 `build/package-release.sh` diff --git a/deploy/systemd/opendance-api.service b/deploy/systemd/opendance-api.service index d6af34e..d3178cc 100644 --- a/deploy/systemd/opendance-api.service +++ b/deploy/systemd/opendance-api.service @@ -1,6 +1,6 @@ [Unit] Description=OpenDance Studio Web 管理服务端（NestJS） -Documentation=https:////opendance-web +Documentation=https://gitea.kasugano.cn/zijunchiang/opendance-web After=network-online.target Wants=network-online.target