使用 Docker 安裝
Gitea 在其 Docker Hub 組織内提供自动更新的 Docker 镜像。可以始终使用最新的稳定標籤或使用其他服务来更新 Docker 镜像。
該参考设置指导使用者完成基于 docker-compose
的设置,但是 docker-compose
的安裝不在本文檔的范围之内。要安裝 docker-compose
本身,請遵循官方安裝说明。
基本
最简單的设置只是建立一个卷和一个网络,然后将 docker.gitea.com/gitea:latest
镜像作為服务启动。由于没有可用的数据库,因此可以使用 SQLite3 初始化数据库。建立一个类似 gitea
的目錄,並将以下内容粘贴到名為 docker-compose.yml
的文件中。請注意,該卷應由配置文件中指定的 UID/GID 的使用者/组拥有。如果您不授予卷正确的权限,则容器可能無法启动。另請注意,標籤 :latest
将安裝当前的开发版本。對於稳定的发行版,您可以使用 :1
或指定某个发行版,例如 1.24.6
。
version: "3"
networks:
gitea:
external: false
services:
server:
image: docker.gitea.com/gitea:1.24.6
container_name: gitea
environment:
- USER_UID=1000
- USER_GID=1000
restart: always
networks:
- gitea
volumes:
- ./gitea:/data
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
ports:
- "3000:3000"
- "222:22"
端口
要将集成的 openSSH 守护進程和 Web 服务器绑定到其他端口,請调整端口部分。通常,只需更改主机端口,容器内的端口保持原样即可。
version: "3"
networks:
gitea:
external: false
services:
server:
image: docker.gitea.com/gitea:1.24.6
container_name: gitea
environment:
- USER_UID=1000
- USER_GID=1000
restart: always
networks:
- gitea
volumes:
- ./gitea:/data
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
ports:
- - "3000:3000"
- - "222:22"
+ - "8080:3000"
+ - "2221:22"
数据库
MySQL 数据库
要将 Gitea 与 MySQL 数据库结合使用,請将这些更改應用于上面建立的 docker-compose.yml
文件。
version: "3"
networks:
gitea:
external: false
services:
server:
image: docker.gitea.com/gitea:1.24.6
container_name: gitea
environment:
- USER_UID=1000
- USER_GID=1000
+ - GITEA__database__DB_TYPE=mysql
+ - GITEA__database__HOST=db:3306
+ - GITEA__database__NAME=gitea
+ - GITEA__database__USER=gitea
+ - GITEA__database__PASSWD=gitea
restart: always
networks:
- gitea
volumes:
- ./gitea:/data
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
ports:
- "3000:3000"
- "222:22"
+ depends_on:
+ - db
+
+ db:
+ image: docker.io/library/mysql:8
+ restart: always
+ environment:
+ - MYSQL_ROOT_PASSWORD=gitea
+ - MYSQL_USER=gitea
+ - MYSQL_PASSWORD=gitea
+ - MYSQL_DATABASE=gitea
+ networks:
+ - gitea
+ volumes:
+ - ./mysql:/var/lib/mysql
PostgreSQL 数据库
要将 Gitea 与 PostgreSQL 数据库结合使用,請将这些更改應用于上面建立的 docker-compose.yml
文件。
version: "3"
networks:
gitea:
external: false
services:
server:
image: docker.gitea.com/gitea:1.24.6
container_name: gitea
environment:
- USER_UID=1000
- USER_GID=1000
+ - GITEA__database__DB_TYPE=postgres
+ - GITEA__database__HOST=db:5432
+ - GITEA__database__NAME=gitea
+ - GITEA__database__USER=gitea
+ - GITEA__database__PASSWD=gitea
restart: always
networks:
- gitea
volumes:
- ./gitea:/data
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
ports:
- "3000:3000"
- "222:22"
+ depends_on:
+ - db
+
+ db:
+ image: docker.io/library/postgres:14
+ restart: always
+ environment:
+ - POSTGRES_USER=gitea
+ - POSTGRES_PASSWORD=gitea
+ - POSTGRES_DB=gitea
+ networks:
+ - gitea
+ volumes:
+ - ./postgres:/var/lib/postgresql/data
命名卷
要使用命名卷而不是主机卷,請在 docker-compose.yml
配置中定义並使用命名卷。此更改将自动建立所需的卷。您無需担心命名卷的权限;Docker 将自动处理該问题。
version: "3"
networks:
gitea:
external: false
+volumes:
+ gitea:
+ driver: local
+
services:
server:
image: docker.gitea.com/gitea:1.24.6
container_name: gitea
restart: always
networks:
- gitea
volumes:
- - ./gitea:/data
+ - gitea:/data
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
ports:
- "3000:3000"
- "222:22"
MySQL 或 PostgreSQL 容器将需要分别建立。
启动
要基于 docker-compose
启动此设置,請執行 docker-compose up -d
,以在后台启动 Gitea。使用 docker-compose ps
将显示 Gitea 是否正确启动。可以使用 docker-compose logs
查看日志。
要关闭设置,請執行 docker-compose down
。这将停止並杀死容器。这些卷将仍然存在。
注意:如果在 http 上使用非 3000 端口,請更改 app.ini 以匹配 LOCAL_ROOT_URL = http://localhost:3000/
。
安裝
通過 docker-compose
启动 Docker 安裝后,應該可以使用喜欢的浏览器访问 Gitea,以完成安裝。访问 http://server-ip:3000 並遵循安裝向导。如果数据库是通過上述 docker-compose
设置启动的,請注意,必須将 db
用作数据库主机名。
环境变量
您可以通過环境变量配置 Gitea 的一些设置:
(默认值以粗體显示)
APP_NAME
:“Gitea: Git with a cup of tea”:應用程序名稱,在页面标题中使用。RUN_MODE
:prod:應用程序运行模式,会影響性能和调试。"dev","prod"或"test"。DOMAIN
:localhost:此服务器的域名,用于 Gitea UI 中显示的 http 克隆 URL。SSH_DOMAIN
:localhost:該服务器的域名,用于 Gitea UI 中显示的 ssh 克隆 URL。如果启用了安裝页面,则 SSH 域服务器将采用以下形式的 DOMAIN 值(保存时将覆盖此设置)。SSH_PORT
:22:克隆 URL 中显示的 SSH 端口。SSH_LISTEN_PORT
:%(SSH_PORT)s:内置 SSH 服务器的端口。DISABLE_SSH
:false:如果不可用,請禁用 SSH 功能。如果要禁用 SSH 功能,则在安裝 Gitea 时應将 SSH 端口设置為0
。HTTP_PORT
:3000:HTTP 监听端口。ROOT_URL
:"":覆盖自动生成的公共 URL。如果内部 URL 和外部 URL 不匹配(例如在 Docker 中),这很有用。LFS_START_SERVER
:false:启用 git-lfs 支持。DB_TYPE
:sqlite3:正在使用的数据库類型[mysql,postgres,mssql,sqlite3]。DB_HOST
:localhost:3306:数据库主机地址和端口。DB_NAME
:gitea:数据库名稱。DB_USER
:root:数据库使用者名。DB_PASSWD
:"empty" :数据库使用者密碼。如果您在密碼中使用特殊字符,請使用“您的密碼”進行引用。INSTALL_LOCK
:false:禁止访问安裝页面。SECRET_KEY
:"" :全局密钥。这應該更改。如果它具有一个值並且INSTALL_LOCK
為空,则INSTALL_LOCK
将自动设置為true
。DISABLE_REGISTRATION
:false:禁用注册,之后只有管理员才能為使用者建立帳戶。REQUIRE_SIGNIN_VIEW
:false:启用此選项可强制使用者登入以查看任何页面。USER_UID
:1000:在容器内运行 Gitea 的使用者的 UID(Unix 使用者 ID)。如果使用主机卷,则将其与/data
卷的所有者的 UID 匹配(對於命名卷,则不需要这样做)。USER_GID
:1000:在容器内运行 Gitea 的使用者的 GID(Unix 组 ID)。如果使用主机卷,则将其与/data
卷的所有者的 GID 匹配(對於命名卷,则不需要这样做)。
自定义
此处描述的定制文件應放在 /data/gitea
目錄中。如果使用主机卷,则访问这些文件非常容易;對於命名卷,可以通過另一个容器或通過直接访问 /var/lib/docker/volumes/gitea_gitea/_data
来完成。安裝后,配置文件将保存在 /data/gitea/conf/app.ini
中。
升级
❗❗ 确保已将数据卷到 Docker 容器外部的某个位置 ❗❗
要将安裝升级到最新版本:
# Edit `docker-compose.yml` to update the version, if you have one specified
# Pull new images
docker-compose pull
# Start a new container, automatically removes old one
docker-compose up -d
使用环境变量管理部署
除了上面的环境变量之外,app.ini
中的任何设置都可以使用以下形式的环境变量進行设置或覆盖:GITEA__SECTION_NAME__KEY_NAME
。 每次 docker 容器启动时都会應用这些设置。 完整信息在这里。
...
services:
server:
environment:
- GITEA__mailer__ENABLED=true
- GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
- GITEA__mailer__PROTOCOL=smtps
- GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
- GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
- GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}"""
Gitea 将為每次新安裝自动生成新的 SECRET_KEY
並将它们写入 app.ini
。 如果您想手动设置 SECRET_KEY
,您可以使用以下 docker 命令来使用 Gitea 内置的方法生成 SECRET_KEY
。 安裝后請妥善保管您的 SECRET_KEY
,如若丢失则無法解密已加密的数据。
以下命令将向 stdout
输出一个新的 SECRET_KEY
和 INTERNAL_TOKEN
,然后您可以将其放入环境变量中。
docker run -it --rm docker.gitea.com/gitea:1 gitea generate secret SECRET_KEY
docker run -it --rm docker.gitea.com/gitea:1 gitea generate secret INTERNAL_TOKEN
---
services:
server:
environment:
- GITEA__security__SECRET_KEY=[value returned by generate secret SECRET_KEY]
- GITEA__security__INTERNAL_TOKEN=[value returned by generate secret INTERNAL_TOKEN]
SSH 容器直通
由于 SSH 在容器内运行,因此,如果需要 SSH 支持,则需要将 SSH 从主机传递到容器。一种選择是在非标准端口上运行容器 SSH(或将主机端口移至非标准端口)。另一个可能更直接的選择是将 SSH 连接从主机转发到容器。下面将说明此设置。
本指南假定您已经在名為 git
的主机上建立了一个使用者,該使用者与容器值 USER_UID
/USER_GID
共享相同的 UID
/GID
。这些值可以在 docker-compose.yml
中设置為环境变量:
environment:
- USER_UID=1000
- USER_GID=1000
接下来将主机的 /home/git/.ssh
装入容器。否则,SSH 身份驗證将無法在容器内运行。
volumes:
- /home/git/.ssh/:/data/git/.ssh
現在,需要在主机上建立 SSH 密钥对。該密钥对将用于向主机驗證主机上的 git
使用者。
sudo -u git ssh-keygen -t rsa -b 4096 -C "Gitea Host Key"
在下一步中,需要在主机上建立一个名為 /usr/local/bin/gitea
的文件(具有可執行权限)。該文件将发出从主机到容器的 SSH 转发。将以下内容添加到 /usr/local/bin/gitea
:
ssh -p 2222 -o StrictHostKeyChecking=no git@127.0.0.1 "SSH_ORIGINAL_COMMAND=\"$SSH_ORIGINAL_COMMAND\" $0 $@"
為了使转发正常工作,需要将容器(22)的 SSH 端口映射到 docker-compose.yml
中的主机端口 2222。由于此端口不需要暴露给外界,因此可以将其映射到主机的 localhost
:
ports:
# [...]
- "127.0.0.1:2222:22"
另外,主机上的 /home/git/.ssh/authorized_keys
需要修改。它需要以与 Gitea 容器内的 authorized_keys
相同的方式進行操作。因此,将您在上面建立的密钥(“Gitea 主机密钥”)的公共密钥添加到 ~/git/.ssh/authorized_keys
。这可以通過 echo "$(cat /home/git/.ssh/id_rsa.pub)" >> /home/git/.ssh/authorized_keys
完成。重要提示:来自 git
使用者的公钥需要“按原样”添加,而通過 Gitea 网络界面添加的所有其他公钥将以 command="/app [...]
作為前缀。
該文件應該看起来像:
# SSH pubkey from git user
ssh-rsa <Gitea Host Key>
# other keys from users
command="/usr/local/bin/gitea --config=/data/gitea/conf/app.ini serv key-1",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty <user pubkey>
这是详细的说明,当发出 SSH 請求时会发生什么:
- 使用
git
使用者向主机发出 SSH 請求,例如git clone git@domain:user/repo.git
。 - 在
/home/git/.ssh/authorized_keys
中,該命令執行/usr/local/bin/gitea
脚本。 /usr/local/bin/gitea
将 SSH 請求转发到端口 2222,該端口已映射到容器的 SSH 端口(22)。- 由于
/home/git/.ssh/authorized_keys
中存在git
使用者的公钥,因此身份驗證主机 → 容器成功,並且 SSH 請求转发到在 docker 容器中运行的 Gitea。
如果在 Gitea Web 界面中添加了新的 SSH 密钥,它将以与現有密钥相同的方式附加到 .ssh/authorized_keys
中。
注意
SSH 容器直通僅在以下情况下有效
- 在容器中使用
opensshd
- 如果未将
AuthorizedKeysCommand
与SSH_CREATE_AUTHORIZED_KEYS_FILE = false
结合使用以禁用授权文件密钥生成 LOCAL_ROOT_URL
不变