diff --git a/deploy/.env.example b/deploy/.env.example index eebe499..7d3e553 100644 --- a/deploy/.env.example +++ b/deploy/.env.example @@ -19,6 +19,15 @@ GITEA_DATA_DIR=/srv/gitea # 所以这里给父目录即可(不要再按老写法挂 /var/lib/postgresql/data) POSTGRES_DATA_DIR=/srv/pgdata +# ----------------------------------------------------------------------------- +# 定制覆盖层(Gitea 客制化: 首页 / 中文术语 / 去 Gitea 化) +# 官方镜像里 GITEA_CUSTOM=/data/gitea, 因此定制内容是挂到 +# /data/gitea/{templates,public,options} —— 不是 /data/gitea/custom! +# 这是仓库里的 customization/custom 目录, 相对路径按 deploy/ 解析。 +# 生效前先确保产物已生成: python3 customization/build.py +# ----------------------------------------------------------------------------- +GITEA_CUSTOM_DIR=../customization/custom + # ----------------------------------------------------------------------------- # 版本(锁定, 便于回滚) # ----------------------------------------------------------------------------- diff --git a/deploy/README.md b/deploy/README.md index 2da29a2..8765e5b 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -34,6 +34,7 @@ | **备份** | §5 | `sudo ./scripts/backup.sh --quiesce` | | **恢复**(含演练) | §6 | `sudo ./scripts/restore.sh <时间戳> --apply` | | **升级** Gitea / PostgreSQL | §7 | 备份 → 改 `.env` → `up -d` | +| 改首页 / 中文术语 / 去 Gitea 化 | [`../customization/README.md`](../customization/README.md) | `python3 customization/build.py` → `docker compose restart gitea` | | 出问题了 | §12 | — | | 退回二进制部署 | §9 | `docker compose down && sudo systemctl start gitea` | @@ -99,7 +100,26 @@ > sudo docker compose restart gitea > ``` -> **⚠️ 3. 站点名 `APP_NAME` 只能用裸变量, `GITEA__DEFAULT__APP_NAME` **无效**。** +> **⚠️ 3. 定制覆盖层的文件权限 —— 又一次让 Gitea 以 `[F]` 崩溃。** +> `customization/custom/*` 是**只读**挂载进容器的, 容器里 Gitea 以 `git`(982) 运行。 +> 如果这些文件是 `600`(只读挂载不影响权限检查!), 启动时就报: +> ```text +> [F] processStartupTemplateError() Gitea can't run with template errors: +> open home.tmpl: permission denied +> ``` +> 容器 `Restarting` 死循环。**预览环境不会暴露这个问题** —— 预览容器用 `PREVIEW_UID` +> (默认宿主 uid 1001), 恰好就是文件属主, 所以 600 也读得到。 +> ```bash +> # 体检: 容器用户能否读到 +> docker compose exec -T -u git gitea head -c1 /data/gitea/templates/home.tmpl +> # 修复(会遍历 custom/ 补齐 g+r / o+r, 目录补 o+x) +> python3 ../customization/build.py +> python3 ../customization/build.py --check # 部署前也会校验, 不可读直接报错退出 +> ``` +> 编辑器/工具写文件常带 `600`; `git` 只记录可执行位, 所以**新克隆下来一般是 644**, +> 偏偏本地改过的文件会中招。 + +> **⚠️ 4. 站点名 `APP_NAME` 只能用裸变量, `GITEA__DEFAULT__APP_NAME` **无效**。** > 镜像的 `/etc/s6/gitea/setup` 用 `envsubst` 渲染 `/etc/templates/app.ini`, 而模板第一行是 > `APP_NAME = $APP_NAME` —— 来源是**裸环境变量** `APP_NAME`。为什么 `GITEA__*` 那条路走不通: > `modules/setting/config_env.go` 会把段名小写化(`section = strings.ToLower(section)`), @@ -114,7 +134,7 @@ > sudo docker compose up -d --force-recreate gitea > ``` -> **⚠️ 4. 用 `curl` 验证本机服务时会被 HTTP 代理接管。** +> **⚠️ 5. 用 `curl` 验证本机服务时会被 HTTP 代理接管。** > 本机 shell 里设了 `http_proxy=127.0.0.1:7890`, 而 `no_proxy` 不覆盖 `127.0.0.1` 时, > 连 `curl http://127.0.0.1:2080/...` 都会走 mihomo, 而 **mihomo 对回环代理请求返回 > `502 Bad Gateway`**(响应头带 `Proxy-Connection: keep-alive`, 是代理在答而不是 Gitea)。 @@ -504,13 +524,21 @@ sudo ./scripts/backup.sh --quiesce # 3) 改版本 sed -i 's/^GITEA_VERSION=.*/GITEA_VERSION=1.28.0/' .env # 或 $EDITOR .env -# 4) 拉取并重建 +# 4) 同步定制基线: 拉上游快照 → 合并模板改动 → 重新生成语言文件 +# (详见 ../customization/README.md; build.py 会因「覆盖的键不存在」而报错, +# 把上游改键名/删键的风险挡在部署之前) +../customization/fetch-upstream.sh 1.28.0 +# 手动 diff upstream/ 并更新 customization/custom/templates/*.tmpl +python3 ../customization/build.py --check + +# 5) 拉取并重建 docker compose pull gitea docker compose up -d gitea -# 5) 看迁移日志 + 验证 +# 6) 看迁移日志 + 验证 docker compose logs --since 5m gitea | grep -iE 'migrat|error|\[F\]' sudo ./scripts/verify.sh +curl -s http://10.80.42.185/QA/ | grep -c 课程答疑平台 # 抽查定制仍在生效 ``` **回滚**: 把 `GITEA_VERSION` 改回旧值 → `docker compose up -d gitea`。 diff --git a/deploy/compose.yaml b/deploy/compose.yaml index de9bddd..8138e89 100644 --- a/deploy/compose.yaml +++ b/deploy/compose.yaml @@ -81,6 +81,17 @@ services: # 需要删掉 app.ini 让容器重新生成(见 README 5.3)。 APP_NAME: ${GITEA_APP_NAME:?GITEA_APP_NAME is required} + # --- 去 Gitea 化: 站点元信息与页脚 ---------------------------------- + # 不填这些时, meta description 会保留 Gitea 自带的 + # "a painless self-hosted Git service", 页脚会显示 Powered by Gitea。 + # ★ 段名里的点必须编码成 _0X2E_ (config_env.go 的 GITEA__<段>__<键> 规则), + # 即 app.ini 的 [ui.meta] 段要写成 GITEA__ui_0X2E_meta__XXX。 + GITEA__ui_0X2E_meta__AUTHOR: ${GITEA_META_AUTHOR:-同济大学高级语言程序设计课程} + GITEA__ui_0X2E_meta__DESCRIPTION: ${GITEA_META_DESCRIPTION:-同济大学高级语言程序设计课程答疑平台} + GITEA__ui_0X2E_meta__KEYWORDS: ${GITEA_META_KEYWORDS:-同济大学,高级语言程序设计,答疑,Issue} + GITEA__other__SHOW_FOOTER_POWERED_BY: "false" + GITEA__other__SHOW_FOOTER_VERSION: "false" + # --- 数据库 --------------------------------------------------------- GITEA__database__DB_TYPE: postgres GITEA__database__HOST: db:5432 @@ -170,6 +181,18 @@ services: volumes: - ${GITEA_DATA_DIR:?GITEA_DATA_DIR is required}:/data + # --- 定制覆盖层(Gitea 客制化, 见 customization/README.md) ------------ + # ★ 官方镜像里 GITEA_CUSTOM=/data/gitea, 所以定制文件对应 + # /data/gitea/{templates,public,options}, + # 不是 /data/gitea/custom(那是源码/二进制安装 WorkPath/custom 的写法, + # 在容器里挂了不会生效)。 + # 分开挂三个子目录而不是整目录: 只读覆盖定制内容, 又不遮住同级的 + # conf/、log/、indexers/ 等容器自己管理的目录。 + # entrypoint 只在 /data/gitea 属主不是 git 时才 chown -R, 现有 + # ${GITEA_DATA_DIR}/gitea 属主已是 git, 不会去碰只读挂载。 + - ${GITEA_CUSTOM_DIR:?GITEA_CUSTOM_DIR is required}/templates:/data/gitea/templates:ro + - ${GITEA_CUSTOM_DIR:?GITEA_CUSTOM_DIR is required}/public:/data/gitea/public:ro + - ${GITEA_CUSTOM_DIR:?GITEA_CUSTOM_DIR is required}/options:/data/gitea/options:ro - /etc/localtime:/etc/localtime:ro ports: # 只绑定回环: Apache 反代 /QA -> 127.0.0.1:2080, 不对外暴露