docker: 添加使用docker部署的方法用于快速测试 (#2)

添加使用docker部署的方法**用于快速测试**
路径于`deploy\compose`,目录下有相应部署指导文档

本次改动还将一些配置置为 example,在 git 中取消追踪**以免误操作将敏感信息提交**

Reviewed-on: https://cpp.tongji.sh:2080/jkljkluiouio/tjhlp-gitea/pulls/2
Co-authored-by: oierxjn <[email protected]>
Co-committed-by: oierxjn <[email protected]>
This commit was merged in pull request #2.
This commit is contained in:
2026-04-23 22:20:52 +08:00
committed by jkljkluiouio
parent c338d39ed4
commit 45dc819fda
6 changed files with 336 additions and 5 deletions
+28
View File
@@ -0,0 +1,28 @@
# Copy this file to .env before running docker compose.
# Image versions
GITEA_IMAGE=gitea/gitea:1.24.7
POSTGRES_IMAGE=postgres:18
# Container runtime user
PUID=1000
PGID=1000
# Published ports on the Docker host
GITEA_HTTP_PORT=3000
# Public URL used by Gitea
# For local access you can keep localhost.
GITEA_DOMAIN=localhost
GITEA_ROOT_URL=http://localhost:3000/
# PostgreSQL settings
POSTGRES_DB=gitea
POSTGRES_USER=gitea
POSTGRES_PASSWORD=change_this_db_password
POSTGRES_SSL_MODE=disable
# First admin account used by init-admin.sh
GITEA_ADMIN_USERNAME=admin
GITEA_ADMIN_PASSWORD=ChangeMe!2026
GITEA_ADMIN_EMAIL=[email protected]
+140
View File
@@ -0,0 +1,140 @@
# Docker Compose 部署
- 目标: 单机容器部署 `Gitea + PostgreSQL`
- 不包含: Nginx、TLS 证书、外部对象存储、多节点编排
- 上层使用方式不变: 服务启动后仍然使用 `scripts/` 里的 `tjhlp` CLI 初始化课程组织、仓库、标签和 Webhook
## 文件说明
- `docker-compose.yml`: 启动 Gitea 与 PostgreSQL
- `.env.example`: 本地变量模板, 复制为 `.env` 后修改
- `init-admin.sh`: 读取 `.env` 中的管理员参数并初始化首个管理员账号
## 前置要求
- 已安装 Docker Engine
- 已安装 Docker Compose Plugin, 能执行 `docker compose`
- 目标机器开放 Gitea HTTP 访问端口
## 快速开始
```bash
cd deploy/compose
sudo cp .env.example .env
```
编辑 `.env`, 至少确认这些变量:
- `GITEA_IMAGE` / `POSTGRES_IMAGE`: 要使用的镜像版本
- `GITEA_ROOT_URL`: Gitea 对外访问地址, 必须与实际访问 URL 一致
- `GITEA_DOMAIN`: 对外访问域名或主机名
- `GITEA_HTTP_PORT`: 宿主机暴露的 Gitea 端口
- `POSTGRES_PASSWORD`: PostgreSQL 密码
- `PUID` / `PGID`: 容器内 Gitea 运行用户的 UID/GID, 默认 1000
- `GITEA_ADMIN_USERNAME`
- `GITEA_ADMIN_PASSWORD`
- `GITEA_ADMIN_EMAIL`
启动服务:
```bash
sudo docker compose up -d
sudo docker compose logs -f gitea
```
首次启动后, 运行管理员初始化脚本:
```bash
sudo sh ./init-admin.sh
```
脚本会:
- 从 `.env` 读取 `GITEA_ADMIN_USERNAME`、`GITEA_ADMIN_PASSWORD`、`GITEA_ADMIN_EMAIL`
- 等待 Gitea API 就绪
- 首次运行时创建管理员
- 再次运行时若管理员已存在则直接跳过
创建完成后, 访问 `GITEA_ROOT_URL`, 用 `.env` 中配置的管理员账号登录。
(不推荐Windows)如果你在 Windows 上使用 Docker Desktop, 建议通过 Git Bash 或 WSL 执行 `init-admin.sh`。
## 课程平台初始化
1. 登录 Gitea
2. 在“设置 -> 应用”中创建 API Token
3. 进入仓库 `scripts/` 目录
4. 配置 `.secrets.toml`
5. 执行:
```bash
uv sync
uv run tjhlp setup status
uv run tjhlp setup init --org tjhlp-2025f
```
如果是 Docker Compose 部署, 记得把 `scripts/settings.toml` 或环境变量中的 Gitea URL 指向 `GITEA_ROOT_URL`。
例如:
```bash
export TJHLP_GITEA_URL=http://localhost:3000
```
PowerShell:
```powershell
$env:TJHLP_GITEA_URL = "http://localhost:3000"
```
## 常用命令
启动:
```bash
sudo docker compose up -d
```
停止:
```bash
sudo docker compose down
```
查看日志:
```bash
sudo docker compose logs -f gitea
sudo docker compose logs -f postgres
```
升级镜像:
```bash
sudo docker compose pull
sudo docker compose up -d
```
## 数据持久化
本方案使用 Docker 命名卷:
- `gitea_data`: Gitea 仓库、附件、LFS、配置等数据
- `postgres_data`: PostgreSQL 数据目录
删除容器不会删除卷, 但执行带 `--volumes` 的 `docker compose down` 会清空数据。
## 与 Ansible 方案的关系
- `ansible/` 仍然是现有的主机直装方案
- `deploy/compose/` 是新增的单机容器方案
- 两者部署完成后, 上层 `scripts/` 的初始化和日常管理方式一致
## 注意事项
- `.env` 放环境差异和敏感参数, `docker-compose.yml` 保留项目默认策略配置
- 该方案默认只暴露 HTTP, 若要对外提供 HTTPS, 请在外部使用 Nginx/Caddy 等反向代理
- `GITEA_ROOT_URL` 配错时, Web 界面跳转、Webhook 和仓库链接通常会异常
- 如果宿主机已经占用 `3000`, 请调整 `.env` 中的端口映射
- PostgreSQL 默认不对宿主机暴露端口, 以减少额外暴露面
+49
View File
@@ -0,0 +1,49 @@
services:
postgres:
image: ${POSTGRES_IMAGE}
container_name: tjhlp-postgres
restart: unless-stopped
environment:
POSTGRES_DB: ${POSTGRES_DB}
POSTGRES_USER: ${POSTGRES_USER}
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
volumes:
- postgres_data:/var/lib/postgresql
gitea:
image: ${GITEA_IMAGE}
container_name: tjhlp-gitea
restart: unless-stopped
depends_on:
- postgres
environment:
USER_UID: ${PUID}
USER_GID: ${PGID}
GITEA__database__DB_TYPE: postgres
GITEA__database__HOST: postgres:5432
GITEA__database__NAME: ${POSTGRES_DB}
GITEA__database__USER: ${POSTGRES_USER}
GITEA__database__PASSWD: ${POSTGRES_PASSWORD}
GITEA__database__SSL_MODE: ${POSTGRES_SSL_MODE}
GITEA__server__DOMAIN: ${GITEA_DOMAIN}
GITEA__server__HTTP_PORT: ${GITEA_HTTP_PORT}
GITEA__server__ROOT_URL: ${GITEA_ROOT_URL}
GITEA__server__LFS_START_SERVER: "true"
GITEA__repository__DEFAULT_BRANCH: main
GITEA__repository__DEFAULT_REPO_UNITS: repo.code,repo.issues
GITEA__security__INSTALL_LOCK: "true"
GITEA__service__DISABLE_REGISTRATION: "true"
GITEA__service__REQUIRE_SIGNIN_VIEW: "false"
GITEA__mailer__ENABLED: "false"
GITEA__webhook__ALLOWED_HOST_LIST: "*"
GITEA__webhook__SKIP_TLS_VERIFY: "false"
GITEA__api__ENABLE_SWAGGER: "true"
GITEA__api__MAX_RESPONSE_ITEMS: "100"
ports:
- "${GITEA_HTTP_PORT}:${GITEA_HTTP_PORT}"
volumes:
- gitea_data:/data
volumes:
postgres_data:
gitea_data:
+101
View File
@@ -0,0 +1,101 @@
#!/usr/bin/env sh
set -eu
SCRIPT_DIR=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)
ENV_FILE="$SCRIPT_DIR/.env"
COMPOSE_FILE="$SCRIPT_DIR/docker-compose.yml"
log() {
printf '%s\n' "$*"
}
fail() {
printf 'Error: %s\n' "$*" >&2
exit 1
}
require_command() {
command -v "$1" >/dev/null 2>&1 || fail "missing required command: $1"
}
require_command docker
[ -f "$COMPOSE_FILE" ] || fail "docker-compose.yml not found in $SCRIPT_DIR"
[ -f "$ENV_FILE" ] || fail ".env not found in $SCRIPT_DIR; copy .env.example to .env first"
set -a
# shellcheck disable=SC1090
. "$ENV_FILE"
set +a
for var_name in GITEA_ADMIN_USERNAME GITEA_ADMIN_PASSWORD GITEA_ADMIN_EMAIL GITEA_ROOT_URL GITEA_HTTP_PORT PUID PGID; do
# 固定列表,非用户输入,无注入风险
eval "var_value=\${$var_name:-}"
[ -n "$var_value" ] || fail "required variable $var_name is missing or empty in .env"
done
dc() {
docker compose --file "$COMPOSE_FILE" --env-file "$ENV_FILE" "$@"
}
check_gitea_ready() {
dc exec -T gitea sh -c "
if command -v wget >/dev/null 2>&1; then
wget -q -O - 'http://127.0.0.1:${GITEA_HTTP_PORT}/api/v1/version' >/dev/null 2>&1
elif command -v curl >/dev/null 2>&1; then
curl -fsS 'http://127.0.0.1:${GITEA_HTTP_PORT}/api/v1/version' >/dev/null 2>&1
else
exit 1
fi
"
}
dc version >/dev/null 2>&1 || fail "docker compose is not available"
gitea_state=$(dc ps -q gitea 2>/dev/null || true)
[ -n "$gitea_state" ] || fail "gitea service is not created; run 'docker compose up -d' first"
db_state=$(dc ps -q postgres 2>/dev/null || true)
[ -n "$db_state" ] || fail "postgres service is not created; run 'docker compose up -d' first"
log "Waiting for Gitea to become ready at ${GITEA_ROOT_URL%/}/api/v1/version ..."
attempt=0
max_attempts=30
ready=0
# 最长约 60 秒,每 2 秒检查一次
while [ "$attempt" -lt "$max_attempts" ]; do
attempt=$((attempt + 1))
if check_gitea_ready; then
ready=1
break
fi
sleep 2
done
[ "$ready" -eq 1 ] || fail "Gitea did not become ready after $((max_attempts * 2)) seconds"
log "Creating admin user '${GITEA_ADMIN_USERNAME}' if needed ..."
create_output=$(
dc exec -T --user "${PUID}:${PGID}" gitea gitea admin user create \
--admin \
--username "$GITEA_ADMIN_USERNAME" \
--password "$GITEA_ADMIN_PASSWORD" \
--email "$GITEA_ADMIN_EMAIL" 2>&1
) || {
case "$create_output" in
*"already exists"*)
log "Admin user '${GITEA_ADMIN_USERNAME}' already exists; skipping."
exit 0
;;
*)
printf '%s\n' "$create_output" >&2
fail "failed to create admin user"
;;
esac
}
log "Admin user '${GITEA_ADMIN_USERNAME}' created successfully."