admin 8d5c8c6bae docs(deploy): 把「SSH 默认关闭」的说明对齐实测, 并补上启用步骤
起因是加公钥时页面提示"SSH 目前已禁用, 这些密钥仅用于提交签名验证"。查证后修正两处
过时/失效的说明:

- compose 里那行注释让读者去看 deploy/README.md「启用 SSH 克隆」—— 该小节并不存在
- README 兼容性表里 server.DISABLE_SSH 的理由写的是"实测 /home/git/.ssh 不存在"。
  实测(2026-09-23): 容器里 git 用户家目录是 /data/git, /data/git/.ssh/authorized_keys
  存在且由 Gitea 维护(形如 command="… gitea serv key-N"), 加过公钥的账号启用后即可用

新增「如需启用 SSH 克隆(可选, 默认关闭)」小节, 记下查证到的事实: 镜像自带 sshd(s6 服务
openssh, 容器内已在 0.0.0.0:22 监听, 只是没发布端口)、host key 在持久卷 /data/ssh、
sshd_config 只允许 git 用户公钥认证(PasswordAuthentication no / AllowUsers git /
PermitRootLogin no / 不转发)、宿主 22 被宿主自己的 sshd 占用; 以及要同时改的三处
(DISABLE_SSH / SSH_DOMAIN / SSH_PORT + 发布 2222:22)、验证命令和利弊。
2026-09-23 02:08:49 +08:00

TJHLP-Gitea

同济大学高级语言程序设计课程(Tongji High-level Language Programming)基于 Gitea 的答疑平台。

项目背景

为课程搭建自托管的 Git 答疑平台, 提供以下能力:

  • 学生通过 Issue 提问, 结构化的 Issue Template 引导提问前思考、规范问题描述
  • 助教通过 Label 标记重复 / 低质问题, 管理答疑流程
  • Webhook 将 Issue 动态推送到 IM(如 QQ 机器人), 助教无需轮询平台即可收到通知
  • Python CLI 工具批量管理用户、仓库、标签等, 降低运维负担

选择 Gitea 自托管而非 GitHub Classroom / Piazza 等方案, 是因为国内网络环境限制, 且需要定制化功能。

项目结构

tjhlp-gitea/
├── deploy/             Docker 部署与运维(Gitea + PostgreSQL)
├── customization/      Gitea 客制化(首页、中文术语、去 Gitea 化)与本地预览
├── issue-templates/    Issue 模板(按仓库类型区分)
└── scripts/            Python CLI 管理工具

快速开始

1. 部署服务器

需要一台 Rocky Linux 8.10 服务器, 以及 Docker(含 compose 插件)。

cd deploy
cp .env.example .env                 # 填写地址、密钥、密码
docker compose config --quiet        # 校验 compose 与 .env 插值
docker compose up -d --build
sudo ./scripts/verify.sh             # 体检

完整的部署步骤(Docker 安装、外网代理、RPM 冲突处理), 以及 备份 / 恢复 / 升级 流程, 见 deploy/README.md。

2. 初始化平台

登录管理员账号, 在 设置 -> 应用 中创建 API Token, 然后:

cd scripts
cp .secrets.toml.example .secrets.toml
# 编辑 .secrets.toml, 填入 gitea_token 和 SMTP 配置

uv sync
uv run tjhlp setup init --org tjhlp-2025f

这会创建课程组织、ta/students 团队、general 答疑仓库, 并推送 Issue Template 和预定义 Label。

3. 导入用户

准备 CSV 文件(格式见 scripts/example/members.csv):

id,name,role
2659999,赵一伤,student
10001,李四催,ta
uv run tjhlp users create --file members.csv --org tjhlp-2025f
uv run tjhlp notify send-credentials --file credentials_*.csv

4. 创建作业仓库

uv run tjhlp repos create-homework --org tjhlp-2025f --number 1

仓库设计

仓库 用途 Issue Template
{org}/general 一般性问题: 课程内容答疑、环境配置 课程答疑 / 作业问题 / 环境配置
{org}/hw01 ... 各次作业的特定问题 仅作业问题模板

开发与测试

Python CLI 测试

cd scripts
uv sync --extra dev
uv run pytest tests/ -v                          # 运行全部测试
uv run pytest tests/ --cov=tjhlp --cov-report=term-missing   # 带覆盖率

当前测试套件包含 99 个测试用例, 覆盖:

  • 数据模型(models.py)— 100% 覆盖率
  • 配置校验(config.py)— Pydantic 模型、Label 颜色验证、必填字段
  • 纯函数— 密码生成、CSV 解析、邮件模板构建、HTML 转义防护
  • API 客户端(client.py)— 使用 respx mock HTTP 层, 测试分页、错误处理、404 返回 None
  • 命令集成— 使用 Typer CliRunner + mock 测试 setup/users/repos 命令的完整流程

部署配置检查

cd deploy
docker compose config --quiet        # 校验 compose 与 .env 插值
sudo ./scripts/verify.sh             # 部署后验证(容器健康 + API + 反代)
./scripts/restore.sh --list          # 查看可用备份及校验状态

Issue Templates 验证

yamllint issue-templates/                         # YAML 语法

定制(Gitea 客制化)

python3 customization/build.py                    # 生成定制语言文件
python3 customization/build.py --check            # 校验生成物是否最新
customization/preview/preview.sh up               # 起本地预览(127.0.0.1:2081)
customization/preview/preview.sh semester         # 造一个学期组织, 看首页答疑入口卡片
customization/preview/preview.sh check            # 自动校验首页/登录页/卡片/页脚/meta/术语

机制调查、日常改法与部署/升级流程见 customization/README.md; 与课程官网(https://cpp.tongji.sh/Website/)的互相导流见 customization/website-linkage.md。

详见各子目录的 README。

技术栈

组件 技术选型
Git 平台 Gitea(Docker 容器)
数据库 PostgreSQL 18(Docker 容器)
服务器 Rocky Linux 8.10 (aarch64)
部署工具 Docker Compose(见 deploy/)
管理工具 Python 3.14 + Typer + httpx + Pydantic + Dynaconf
包管理 uv
测试框架 pytest + respx + pytest-cov
代码检查 ruff, yamllint
S
Description
No description provided
Readme
180 KiB
Languages
Python 93.9%
Jinja 3.1%
Shell 3%