diff --git a/README.md b/README.md index 9bfc57c..6723103 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ tjhlp-gitea/ 本项目当前提供两种并行的单机部署方式: - **Ansible**: 现有正式方案, 面向 Rocky Linux 8.10 主机, 直接安装 Gitea 二进制 + PostgreSQL + systemd -- **Docker Compose**: 测试方案, 面向单机容器部署, 默认只包含 Gitea + PostgreSQL, 反向代理/TLS 由外部处理 +- **Docker Compose**: 测试方案, 面向单机容器部署, 默认只包含 Gitea + PostgreSQL, 提供管理员初始化脚本, 反向代理/TLS 由外部处理 如果你使用 Docker Compose, 先参考 [deploy/compose/README.md](deploy/compose/README.md) 完成服务启动, 然后再回到下面的“初始化平台”步骤。 diff --git a/deploy/compose/.env.example b/deploy/compose/.env.example index d6207fa..792a4e6 100644 --- a/deploy/compose/.env.example +++ b/deploy/compose/.env.example @@ -22,7 +22,7 @@ POSTGRES_USER=gitea POSTGRES_PASSWORD=change_this_db_password POSTGRES_SSL_MODE=disable -# First admin account to create manually after startup +# First admin account used by init-admin.sh GITEA_ADMIN_USERNAME=admin GITEA_ADMIN_PASSWORD=ChangeMe!2026 GITEA_ADMIN_EMAIL=admin@example.com diff --git a/deploy/compose/README.md b/deploy/compose/README.md index 39588c2..9e32f91 100644 --- a/deploy/compose/README.md +++ b/deploy/compose/README.md @@ -9,6 +9,7 @@ - `docker-compose.yml`: 启动 Gitea 与 PostgreSQL - `.env.example`: 本地变量模板, 复制为 `.env` 后修改 +- `init-admin.sh`: 读取 `.env` 中的管理员参数并初始化首个管理员账号 ## 前置要求 @@ -42,31 +43,22 @@ sudo docker compose up -d sudo docker compose logs -f gitea ``` -首次启动后, 手动创建管理员账号: +首次启动后, 运行管理员初始化脚本: ```bash -sudo docker compose exec gitea \ - gitea admin user create \ - --admin \ - --username admin \ - --password 'ChangeMe!2026' \ - --email admin@example.com +sh ./init-admin.sh ``` -将上面的 `admin` / `ChangeMe!2026` / `admin@example.com` 替换为你在 `.env` 中准备好的值。 +脚本会: -如果你在 Windows PowerShell 中执行, 使用: +- 从 `.env` 读取 `GITEA_ADMIN_USERNAME`、`GITEA_ADMIN_PASSWORD`、`GITEA_ADMIN_EMAIL` +- 等待 Gitea API 就绪 +- 首次运行时创建管理员 +- 再次运行时若管理员已存在则直接跳过 -```powershell -sudo docker compose exec gitea ` - gitea admin user create ` - --admin ` - --username admin ` - --password 'ChangeMe!2026' ` - --email admin@example.com -``` +创建完成后, 访问 `GITEA_ROOT_URL`, 用 `.env` 中配置的管理员账号登录。 -创建完成后, 访问 `GITEA_ROOT_URL`, 用管理员账号登录。 +(不推荐Windows)如果你在 Windows 上使用 Docker Desktop, 建议通过 Git Bash 或 WSL 执行 `init-admin.sh`。 ## 课程平台初始化 diff --git a/deploy/compose/init-admin.sh b/deploy/compose/init-admin.sh new file mode 100644 index 0000000..78e85e1 --- /dev/null +++ b/deploy/compose/init-admin.sh @@ -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; 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 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."