SHA256
forked from course-team/tjhlp-gitea
feat: 新增 Gitea 定制机制(首页/中文语言/去 Gitea 化)与本地预览
不改 Go 代码、不 fork, 只用官方 CustomPath 覆盖层 + app.ini/env 配置: - custom/templates: 整文件覆盖 home.tmpl(落地页换成答疑平台介绍)与 base/head_navbar.tmpl(docs.gitea.com -> 站内提问指南、新增课程官网入口) - custom/public/assets/tjhlp/ask-guide.html: 站内提问指南静态页 - overrides/ + build.py: 由上游快照确定性生成整份 locale_zh-CN.json (工单 -> Issue 等 133 处), 带占位符校验; 缺失键会退回英文, 必须整份覆盖 - build.py 同时负责规范 custom/ 权限: 容器内 Gitea 以 git(982) 运行, 文件若为 600 只读挂载也会 permission denied 并拒绝启动(生产踩过) - upstream/<版本>/ + fetch-upstream.sh: 上游基线, 供升级时 diff 与重生成 - preview/: 独立 compose + preview.sh(up/check/reload/admin/reset), 与生产隔离(独立端口 2081/数据目录/sqlite), 用同一镜像版本验证效果 - website-linkage.md: 官网(VitePress)侧的联动改动提案
This commit is contained in:
@@ -0,0 +1,96 @@
|
||||
# =============================================================================
|
||||
# TJHLP 定制预览实例(与生产完全隔离, 只绑定回环)
|
||||
#
|
||||
# 目的: 在不动生产容器/数据的前提下, 用【与生产相同版本】的官方镜像验证
|
||||
# customization/custom 下的模板、文案、静态资源效果。
|
||||
#
|
||||
# 与生产(deploy/compose.yaml)的区别:
|
||||
# * 项目名 gitea-preview, 容器名 gitea-preview, 端口 127.0.0.1:2081
|
||||
# * 数据库用 sqlite(预览不需要 PostgreSQL)
|
||||
# * 数据目录 preview/data(gitignore), 删除即重置
|
||||
# * RUN_MODE=dev: 修改 custom/ 下的模板或语言文件后自动热加载, 无需重启
|
||||
# * 把 customization/custom 只读挂载到容器的 GITEA_CUSTOM/custom
|
||||
#
|
||||
# 用法(见 preview.sh):
|
||||
# ./preview.sh up 启动
|
||||
# ./preview.sh logs 看日志
|
||||
# ./preview.sh down 停止
|
||||
# ./preview.sh reset 停止并清空预览数据
|
||||
# =============================================================================
|
||||
|
||||
name: gitea-preview
|
||||
|
||||
services:
|
||||
gitea:
|
||||
image: docker.gitea.com/gitea:${GITEA_VERSION:-1.27.3}
|
||||
container_name: gitea-preview
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
# 与宿主当前用户对齐, 让 ./data 的属主正确(见 preview.sh)
|
||||
USER_UID: ${PREVIEW_UID:-1001}
|
||||
USER_GID: ${PREVIEW_GID:-1001}
|
||||
TZ: ${TZ:-Asia/Shanghai}
|
||||
|
||||
APP_NAME: 同济高程-答疑平台(预览)
|
||||
# dev(默认): 语言文件改动自动热加载(实测), 模板报错也不致命 —— 改文案方便;
|
||||
# prod: 与生产完全一致, 任何改动都要 ./preview.sh reload。
|
||||
# 注意: 模板是启动时编译的, dev 下改模板同样要重启(官方文档也是这么说的)。
|
||||
RUN_MODE: ${PREVIEW_RUN_MODE:-dev}
|
||||
|
||||
# --- 数据库: sqlite(预览专用) -------------------------------------
|
||||
GITEA__database__DB_TYPE: sqlite3
|
||||
GITEA__database__PATH: /data/gitea/gitea.db
|
||||
|
||||
# --- 服务地址 ------------------------------------------------------
|
||||
GITEA__server__PROTOCOL: http
|
||||
GITEA__server__DOMAIN: 127.0.0.1
|
||||
GITEA__server__ROOT_URL: http://127.0.0.1:${PREVIEW_PORT:-2081}/
|
||||
GITEA__server__HTTP_ADDR: 0.0.0.0
|
||||
GITEA__server__HTTP_PORT: "3000"
|
||||
GITEA__server__DISABLE_SSH: "true"
|
||||
GITEA__server__LFS_START_SERVER: "true"
|
||||
GITEA__server__OFFLINE_MODE: "false"
|
||||
|
||||
# --- 安全: 跳过安装向导; 密钥不在这里指定 -------------------------
|
||||
# LFS_JWT_SECRET / INTERNAL_TOKEN / JWT_SECRET 留空时 Gitea 会自己生成
|
||||
# 并写回 /data/gitea/conf/app.ini(可写), 重启后保持不变。
|
||||
GITEA__security__INSTALL_LOCK: "true"
|
||||
|
||||
# --- 注册 / 登录 ---------------------------------------------------
|
||||
GITEA__service__DISABLE_REGISTRATION: "false"
|
||||
GITEA__service__ENABLE_CAPTCHA: "false"
|
||||
GITEA__service__REQUIRE_SIGNIN_VIEW: "false"
|
||||
GITEA__mailer__ENABLED: "false"
|
||||
|
||||
# --- 站点元信息与页脚: 去掉 Gitea 自我推销 -------------------------
|
||||
# 段名里的点要写成 _0X2E_ (Gitea 的 GITEA__section__KEY 编码规则)
|
||||
GITEA__ui_0X2E_meta__AUTHOR: 同济大学高级语言程序设计课程
|
||||
GITEA__ui_0X2E_meta__DESCRIPTION: 同济大学高级语言程序设计课程答疑平台
|
||||
GITEA__ui_0X2E_meta__KEYWORDS: 同济大学,高级语言程序设计,答疑,Issue
|
||||
GITEA__other__SHOW_FOOTER_POWERED_BY: "false"
|
||||
GITEA__other__SHOW_FOOTER_VERSION: "false"
|
||||
|
||||
GITEA__log__MODE: console
|
||||
GITEA__log__LEVEL: ${GITEA_LOG_LEVEL:-info}
|
||||
|
||||
volumes:
|
||||
- ./data:/data
|
||||
# ★ 官方镜像里 GITEA_CUSTOM=/data/gitea, 所以定制文件对应
|
||||
# /data/gitea/{templates,public,options}, 而不是 /data/gitea/custom
|
||||
# (后者是源码/二进制安装时 WorkPath/custom 的习惯写法)。
|
||||
# 分开挂三个子目录: 既只读覆盖定制内容, 又不遮住同级的 conf/、log/。
|
||||
- ../custom/templates:/data/gitea/templates:ro
|
||||
- ../custom/public:/data/gitea/public:ro
|
||||
- ../custom/options:/data/gitea/options:ro
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
|
||||
ports:
|
||||
# 只绑定回环, 预览实例不对内网/外网暴露
|
||||
- "127.0.0.1:${PREVIEW_PORT:-2081}:3000"
|
||||
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "-fsS", "http://127.0.0.1:3000/api/healthz"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
start_period: 60s
|
||||
Executable
+136
@@ -0,0 +1,136 @@
|
||||
#!/usr/bin/env bash
|
||||
# 预览实例管理脚本: 见 compose.yaml 顶部说明。
|
||||
#
|
||||
# ./preview.sh up 构建定制产物并启动预览 (http://127.0.0.1:2081)
|
||||
# ./preview.sh down 停止预览(保留数据)
|
||||
# ./preview.sh reset 停止并删除预览数据(下次全新安装)
|
||||
# ./preview.sh logs 跟踪日志
|
||||
# ./preview.sh ps 查看状态
|
||||
# ./preview.sh shell 进入容器
|
||||
# ./preview.sh admin 在预览实例里建一个管理员(用于验证登录后的页面)
|
||||
# ./preview.sh check 构建校验 + 首页文案/页脚/元信息抽查
|
||||
#
|
||||
# 说明: 本机 docker 需要 docker 组权限; 当前 shell 没有时会自动改用
|
||||
# `sg docker -c ...`(sg 读 /etc/group 的成员关系, 不需要 sudo)。
|
||||
set -euo pipefail
|
||||
|
||||
HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
ROOT="$(cd "${HERE}/.." && pwd)"
|
||||
COMPOSE_FILE="${HERE}/compose.yaml"
|
||||
PORT="${PREVIEW_PORT:-2081}"
|
||||
BASE_URL="http://127.0.0.1:${PORT}"
|
||||
export PREVIEW_UID="$(id -u)"
|
||||
export PREVIEW_GID="$(id -g)"
|
||||
|
||||
# 是否需要套 sg docker
|
||||
if docker info >/dev/null 2>&1; then
|
||||
compose() { docker compose -f "${COMPOSE_FILE}" "$@"; }
|
||||
elif command -v sg >/dev/null 2>&1 && sg docker -c 'docker info' >/dev/null 2>&1; then
|
||||
compose() { sg docker -c "docker compose -f '${COMPOSE_FILE}' $*"; }
|
||||
else
|
||||
echo "✗ 当前用户没有 docker 权限(既不能直连, 也不能通过 docker 组)" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
prepare() {
|
||||
# 生成定制产物(语言文件等)
|
||||
python3 "${ROOT}/build.py" --quiet
|
||||
# 预建数据目录: 属主等于当前用户, 容器 entrypoint 就不会对只读挂载做 chown。
|
||||
# .ssh 必须由我们建: 否则容器以 root 建出 0700 目录, 降权后的 gitea 进程
|
||||
# 写不了 authorized_keys。
|
||||
mkdir -p "${HERE}/data/gitea/conf" "${HERE}/data/git/.ssh" "${HERE}/data/ssh"
|
||||
chmod 700 "${HERE}/data/git/.ssh"
|
||||
}
|
||||
|
||||
case "${1:-}" in
|
||||
up)
|
||||
prepare
|
||||
compose up -d
|
||||
echo "预览地址: ${BASE_URL} (数据目录: ${HERE}/data)"
|
||||
echo "首次启动约需 10~30 秒; 用 ./preview.sh logs 观察进度"
|
||||
;;
|
||||
down)
|
||||
compose down
|
||||
;;
|
||||
reload)
|
||||
# 模板改完必须重启才生效(prod/dev 都一样); 语言文件在 dev 下会自动热加载
|
||||
python3 "${ROOT}/build.py" --quiet
|
||||
compose restart gitea
|
||||
echo "已重启, 预览地址: ${BASE_URL}"
|
||||
;;
|
||||
reset)
|
||||
compose down
|
||||
if ! rm -rf "${HERE}/data" 2>/dev/null; then
|
||||
# 容器可能以 root 身份建过 data/git/.ssh(0700), 宿主用户删不掉;
|
||||
# 用一次性 root 容器清掉再删(正常流程不会走到这里, 见 prepare 的说明)。
|
||||
compose run --rm -T --user 0 --entrypoint /bin/sh gitea -c 'rm -rf /data/git /data/ssh' >/dev/null
|
||||
rm -rf "${HERE}/data"
|
||||
fi
|
||||
echo "已清空预览数据"
|
||||
;;
|
||||
logs)
|
||||
compose logs -f --tail=100
|
||||
;;
|
||||
ps)
|
||||
compose ps
|
||||
;;
|
||||
shell)
|
||||
compose exec gitea bash
|
||||
;;
|
||||
admin)
|
||||
USERNAME="${2:-previewadmin}"
|
||||
PASSWORD="${3:-previewadmin123}"
|
||||
# -u git: gitea 命令拒绝以 root 运行
|
||||
compose exec -T -u git gitea gitea admin user create \
|
||||
--username "${USERNAME}" --password "${PASSWORD}" \
|
||||
--email "${USERNAME}@example.com" --admin --must-change-password=false
|
||||
echo "管理员: ${USERNAME} / ${PASSWORD}"
|
||||
;;
|
||||
check)
|
||||
python3 "${ROOT}/build.py" --check --quiet
|
||||
fail=0
|
||||
ok() { echo "✓ $1"; }
|
||||
bad() {
|
||||
echo "✗ $1"
|
||||
fail=1
|
||||
}
|
||||
|
||||
html="$(mktemp)"
|
||||
trap 'rm -f "${html}"' EXIT
|
||||
curl -fsS "${BASE_URL}/" -o "${html}"
|
||||
|
||||
grep -q "先搜索,再提问" "${html}" && ok "首页用的是定制模板 home.tmpl" || bad "首页没有定制模板的内容"
|
||||
grep -q "assets/tjhlp/ask-guide.html" "${html}" && ok "导航栏/首页已指向课程提问指南" || bad "没找到提问指南链接"
|
||||
! grep -q "painless\|极易搭建\|Easy to install\|Cross-platform" "${html}" &&
|
||||
ok "首页已无 Gitea 功能介绍" || bad "首页仍有 Gitea 功能介绍文案"
|
||||
! grep -qi "powered by" "${html}" && ok "页脚已无 Powered by Gitea" || bad "页脚仍有 Powered by"
|
||||
! grep -q "docs.gitea.com" "${html}" && ok "页面已无 docs.gitea.com 外链" || bad "仍有 docs.gitea.com 外链"
|
||||
grep -q 'name="description" content="同济大学高级语言程序设计课程答疑平台"' "${html}" &&
|
||||
ok "meta description 已替换" || bad "meta description 未替换"
|
||||
|
||||
curl -fsS -o /dev/null "${BASE_URL}/assets/tjhlp/ask-guide.html" &&
|
||||
ok "custom/public 静态页可访问" || bad "提问指南静态页 404"
|
||||
|
||||
# --- 与课程官网的联动 -------------------------------------------------
|
||||
grep -q "https://cpp.tongji.sh/Website/" "${html}" &&
|
||||
ok "首页/导航栏已链接课程官网" || bad "首页没有课程官网链接"
|
||||
grep -q "https://cpp.tongji.sh/Website/ask-question/" "${html}" &&
|
||||
ok "首页已链接官网《学会提问》" || bad "首页没有《学会提问》链接"
|
||||
guide="$(mktemp)"
|
||||
curl -fsS "${BASE_URL}/assets/tjhlp/ask-guide.html" -o "${guide}"
|
||||
grep -q "Website/ask-question/" "${guide}" && ok "站内提问指南已回链官网" || bad "站内提问指南没有官网链接"
|
||||
rm -f "${guide}"
|
||||
! grep -rq "example.com" "${ROOT}/../issue-templates/" &&
|
||||
ok "Issue 模板已无 example.com 占位链接" || bad "Issue 模板里仍有 example.com"
|
||||
|
||||
! grep -q "工单" "${ROOT}/custom/options/locale/locale_zh-CN.json" &&
|
||||
ok "生成的 zh-CN 语言文件已无「工单」" || bad "语言文件里仍有「工单」"
|
||||
|
||||
[ "${fail}" = 0 ] && echo "全部检查通过" || echo "存在检查未通过项"
|
||||
exit "${fail}"
|
||||
;;
|
||||
*)
|
||||
sed -n '2,18p' "$0"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
Reference in New Issue
Block a user