Skip to content

Commit c295a27

Browse files
authored
docs: update installation with-docker zh-cn (#14554)
1 parent bd28f1d commit c295a27

File tree

1 file changed

+313
-14
lines changed

1 file changed

+313
-14
lines changed
Lines changed: 313 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,345 @@
11
---
22
date: "2016-12-01T16:00:00+02:00"
3-
title: "从Docker安装"
3+
title: "使用 Docker 安装"
44
slug: "install-with-docker"
55
weight: 10
66
toc: false
77
draft: false
88
menu:
99
sidebar:
1010
parent: "installation"
11-
name: "从Docker安装"
11+
name: "使用 Docker 安装"
1212
weight: 10
1313
identifier: "install-with-docker"
1414
---
1515

16-
# 从Docker安装
16+
# 使用 Docker 安装
1717

18-
阅读本章之前我们已经假设您对docker已经有了解并能够正常使用docker。
18+
Gitea 在其 Docker Hub 组织内提供自动更新的 Docker 镜像。可以始终使用最新的稳定标签或使用其他服务来更新 Docker 镜像。
19+
20+
该参考设置指导用户完成基于 `docker-compose` 的设置,但是 `docker-compose` 的安装不在本文档的范围之内。要安装 `docker-compose` 本身,请遵循官方[安装说明](https://docs.docker.com/compose/install/)
1921

2022
{{< toc >}}
2123

22-
我们在 Docker Hub 的 Gitea 组织中提供了自动更新的 Docker 镜像,它会保持最新的稳定版。你也可以用其它 Docker 服务来更新。首先你需要pull镜像:
24+
## 基本
25+
26+
最简单的设置只是创建一个卷和一个网络,然后将 `gitea/gitea:latest` 镜像作为服务启动。由于没有可用的数据库,因此可以使用 SQLite3 初始化数据库。创建一个类似 `gitea` 的目录,并将以下内容粘贴到名为 `docker-compose.yml` 的文件中。请注意,该卷应由配置文件中指定的 UID/GID 的用户/组拥有。如果您不授予卷正确的权限,则容器可能无法启动。另请注意,标签 `:latest` 将安装当前的开发版本。对于稳定的发行版,您可以使用 `:1` 或指定某个发行版,例如 `:1.13.0`
27+
28+
```yaml
29+
version: "3"
30+
31+
networks:
32+
gitea:
33+
external: false
34+
35+
services:
36+
server:
37+
image: gitea/gitea:{{< version >}}
38+
container_name: gitea
39+
environment:
40+
- USER_UID=1000
41+
- USER_GID=1000
42+
restart: always
43+
networks:
44+
- gitea
45+
volumes:
46+
- ./gitea:/data
47+
- /etc/timezone:/etc/timezone:ro
48+
- /etc/localtime:/etc/localtime:ro
49+
ports:
50+
- "3000:3000"
51+
- "222:22"
52+
```
53+
54+
## 端口
55+
56+
要将集成的 openSSH 守护进程和 Web 服务器绑定到其他端口,请调整端口部分。通常,只需更改主机端口,容器内的端口保持原样即可。
57+
58+
```diff
59+
version: "3"
60+
61+
networks:
62+
gitea:
63+
external: false
64+
65+
services:
66+
server:
67+
image: gitea/gitea:{{< version >}}
68+
container_name: gitea
69+
environment:
70+
- USER_UID=1000
71+
- USER_GID=1000
72+
restart: always
73+
networks:
74+
- gitea
75+
volumes:
76+
- ./gitea:/data
77+
- /etc/timezone:/etc/timezone:ro
78+
- /etc/localtime:/etc/localtime:ro
79+
ports:
80+
- - "3000:3000"
81+
- - "222:22"
82+
+ - "8080:3000"
83+
+ - "2221:22"
84+
```
85+
86+
## 数据库
87+
88+
### MySQL 数据库
89+
90+
要将 Gitea 与 MySQL 数据库结合使用,请将这些更改应用于上面创建的 `docker-compose.yml` 文件。
91+
92+
```diff
93+
version: "3"
94+
95+
networks:
96+
gitea:
97+
external: false
98+
99+
services:
100+
server:
101+
image: gitea/gitea:{{< version >}}
102+
container_name: gitea
103+
environment:
104+
- USER_UID=1000
105+
- USER_GID=1000
106+
+ - DB_TYPE=mysql
107+
+ - DB_HOST=db:3306
108+
+ - DB_NAME=gitea
109+
+ - DB_USER=gitea
110+
+ - DB_PASSWD=gitea
111+
restart: always
112+
networks:
113+
- gitea
114+
volumes:
115+
- ./gitea:/data
116+
- /etc/timezone:/etc/timezone:ro
117+
- /etc/localtime:/etc/localtime:ro
118+
ports:
119+
- "3000:3000"
120+
- "222:22"
121+
+ depends_on:
122+
+ - db
123+
+
124+
+ db:
125+
+ image: mysql:5.7
126+
+ restart: always
127+
+ environment:
128+
+ - MYSQL_ROOT_PASSWORD=gitea
129+
+ - MYSQL_USER=gitea
130+
+ - MYSQL_PASSWORD=gitea
131+
+ - MYSQL_DATABASE=gitea
132+
+ networks:
133+
+ - gitea
134+
+ volumes:
135+
+ - ./mysql:/var/lib/mysql
136+
```
137+
138+
### PostgreSQL 数据库
139+
140+
要将 Gitea 与 PostgreSQL 数据库结合使用,请将这些更改应用于上面创建的 `docker-compose.yml` 文件。
141+
142+
```diff
143+
version: "3"
144+
145+
networks:
146+
gitea:
147+
external: false
148+
149+
services:
150+
server:
151+
image: gitea/gitea:{{< version >}}
152+
container_name: gitea
153+
environment:
154+
- USER_UID=1000
155+
- USER_GID=1000
156+
+ - DB_TYPE=postgres
157+
+ - DB_HOST=db:5432
158+
+ - DB_NAME=gitea
159+
+ - DB_USER=gitea
160+
+ - DB_PASSWD=gitea
161+
restart: always
162+
networks:
163+
- gitea
164+
volumes:
165+
- ./gitea:/data
166+
- /etc/timezone:/etc/timezone:ro
167+
- /etc/localtime:/etc/localtime:ro
168+
ports:
169+
- "3000:3000"
170+
- "222:22"
171+
+ depends_on:
172+
+ - db
173+
+
174+
+ db:
175+
+ image: postgres:9.6
176+
+ restart: always
177+
+ environment:
178+
+ - POSTGRES_USER=gitea
179+
+ - POSTGRES_PASSWORD=gitea
180+
+ - POSTGRES_DB=gitea
181+
+ networks:
182+
+ - gitea
183+
+ volumes:
184+
+ - ./postgres:/var/lib/postgresql/data
185+
```
186+
187+
## 命名卷
188+
189+
要使用命名卷而不是主机卷,请在 `docker-compose.yml` 配置中定义并使用命名卷。此更改将自动创建所需的卷。您无需担心命名卷的权限;Docker 将自动处理该问题。
190+
191+
```diff
192+
version: "3"
193+
194+
networks:
195+
gitea:
196+
external: false
197+
198+
+volumes:
199+
+ gitea:
200+
+ driver: local
201+
+
202+
services:
203+
server:
204+
image: gitea/gitea:{{< version >}}
205+
container_name: gitea
206+
restart: always
207+
networks:
208+
- gitea
209+
volumes:
210+
- - ./gitea:/data
211+
+ - gitea:/data
212+
- /etc/timezone:/etc/timezone:ro
213+
- /etc/localtime:/etc/localtime:ro
214+
ports:
215+
- "3000:3000"
216+
- "222:22"
217+
```
218+
219+
MySQL 或 PostgreSQL 容器将需要分别创建。
220+
221+
## 启动
222+
223+
要基于 `docker-compose` 启动此设置,请执行 `docker-compose up -d`,以在后台启动 Gitea。使用 `docker-compose ps` 将显示 Gitea 是否正确启动。可以使用 `docker-compose logs` 查看日志。
224+
225+
要关闭设置,请执行 `docker-compose down`。这将停止并杀死容器。这些卷将仍然存在。
226+
227+
注意:如果在 http 上使用非 3000 端口,请更改 app.ini 以匹配 `LOCAL_ROOT_URL = http://localhost:3000/`
228+
229+
## 安装
230+
231+
通过 `docker-compose` 启动 Docker 安装后,应该可以使用喜欢的浏览器访问 Gitea,以完成安装。访问 http://server-ip:3000 并遵循安装向导。如果数据库是通过上述 `docker-compose` 设置启动的,请注意,必须将 `db` 用作数据库主机名。
232+
233+
## 环境变量
234+
235+
您可以通过环境变量配置 Gitea 的一些设置:
236+
237+
(默认值以**粗体**显示)
238+
239+
- `APP_NAME`**“Gitea: Git with a cup of tea”**:应用程序名称,在页面标题中使用。
240+
- `RUN_MODE`**prod**:应用程序运行模式,会影响性能和调试。"dev","prod"或"test"。
241+
- `DOMAIN`**localhost**:此服务器的域名,用于 Gitea UI 中显示的 http 克隆 URL。
242+
- `SSH_DOMAIN`**localhost**:该服务器的域名,用于 Gitea UI 中显示的 ssh 克隆 URL。如果启用了安装页面,则 SSH 域服务器将采用以下形式的 DOMAIN 值(保存时将覆盖此设置)。
243+
- `SSH_PORT`**22**:克隆 URL 中显示的 SSH 端口。
244+
- `SSH_LISTEN_PORT`**%(SSH_PORT)s**:内置 SSH 服务器的端口。
245+
- `DISABLE_SSH`**false**:如果不可用,请禁用 SSH 功能。如果要禁用 SSH 功能,则在安装 Gitea 时应将 SSH 端口设置为 `0`
246+
- `HTTP_PORT`**3000**:HTTP 监听端口。
247+
- `ROOT_URL`**""**:覆盖自动生成的公共 URL。如果内部 URL 和外部 URL 不匹配(例如在 Docker 中),这很有用。
248+
- `LFS_START_SERVER`**false**:启用 git-lfs 支持。
249+
- `DB_TYPE`**sqlite3**:正在使用的数据库类型[mysql,postgres,mssql,sqlite3]
250+
- `DB_HOST`**localhost:3306**:数据库主机地址和端口。
251+
- `DB_NAME`**gitea**:数据库名称。
252+
- `DB_USER`**root**:数据库用户名。
253+
- `DB_PASSWD`**"\<empty>"** :数据库用户密码。如果您在密码中使用特殊字符,请使用“您的密码”进行引用。
254+
- `INSTALL_LOCK`**false**:禁止访问安装页面。
255+
- `SECRET_KEY`**""** :全局密钥。这应该更改。如果它具有一个值并且 `INSTALL_LOCK` 为空,则 `INSTALL_LOCK` 将自动设置为 `true`
256+
- `DISABLE_REGISTRATION`**false**:禁用注册,之后只有管理员才能为用户创建帐户。
257+
- `REQUIRE_SIGNIN_VIEW`**false**:启用此选项可强制用户登录以查看任何页面。
258+
- `USER_UID`**1000**:在容器内运行 Gitea 的用户的 UID(Unix 用户 ID)。如果使用主机卷,则将其与 `/data` 卷的所有者的 UID 匹配(对于命名卷,则不需要这样做)。
259+
- `USER_GID`**1000**:在容器内运行 Gitea 的用户的 GID(Unix 组 ID)。如果使用主机卷,则将其与 `/data` 卷的所有者的 GID 匹配(对于命名卷,则不需要这样做)。
260+
261+
## 自定义
262+
263+
[此处](https://docs.gitea.io/zh-cn/customizing-gitea/)描述的定制文件应放在 `/data/gitea` 目录中。如果使用主机卷,则访问这些文件非常容易;对于命名卷,可以通过另一个容器或通过直接访问 `/var/lib/docker/volumes/gitea_gitea/_data` 来完成。安装后,配置文件将保存在 `/data/gitea/conf/app.ini` 中。
264+
265+
## 升级
266+
267+
:exclamation::exclamation: **确保已将数据卷到 Docker 容器外部的某个位置** :exclamation::exclamation:
268+
269+
要将安装升级到最新版本:
23270

271+
```bash
272+
# Edit `docker-compose.yml` to update the version, if you have one specified
273+
# Pull new images
274+
docker-compose pull
275+
# Start a new container, automatically removes old one
276+
docker-compose up -d
24277
```
25-
docker pull gitea/gitea:latest
278+
279+
## SSH 容器直通
280+
281+
由于 SSH 在容器内运行,因此,如果需要 SSH 支持,则需要将 SSH 从主机传递到容器。一种选择是在非标准端口上运行容器 SSH(或将主机端口移至非标准端口)。另一个可能更直接的选择是将 SSH 连接从主机转发到容器。下面将说明此设置。
282+
283+
本指南假定您已经在名为 `git` 的主机上创建了一个用户,该用户与容器值 `USER_UID`/`USER_GID` 共享相同的 `UID`/`GID`。这些值可以在 `docker-compose.yml` 中设置为环境变量:
284+
285+
```bash
286+
environment:
287+
- USER_UID=1000
288+
- USER_GID=1000
26289
```
27290

28-
如果要将git和其它数据持久化,你需要创建一个目录来作为数据存储的地方:
291+
接下来将主机的 `/home/git/.ssh` 装入容器。否则,SSH 身份验证将无法在容器内运行。
29292

293+
```bash
294+
volumes:
295+
- /home/git/.ssh/:/data/git/.ssh
30296
```
31-
sudo mkdir -p /var/lib/gitea
297+
298+
现在,需要在主机上创建 SSH 密钥对。该密钥对将用于向主机验证主机上的 `git` 用户。
299+
300+
```bash
301+
sudo -u git ssh-keygen -t rsa -b 4096 -C "Gitea Host Key"
32302
```
33303

34-
然后就可以运行 docker 容器了,这很简单。 当然你需要定义端口数数据目录
304+
在下一步中,需要在主机上创建一个名为 `/app/gitea/gitea` 的文件(具有可执行权限)。该文件将发出从主机到容器的 SSH 转发。将以下内容添加到 `/app/gitea/gitea`
35305

306+
```bash
307+
ssh -p 2222 -o StrictHostKeyChecking=no [email protected] "SSH_ORIGINAL_COMMAND=\"$SSH_ORIGINAL_COMMAND\" $0 $@"
36308
```
37-
docker run -d --name=gitea -p 10022:22 -p 10080:3000 -v /var/lib/gitea:/data gitea/gitea:latest
309+
310+
为了使转发正常工作,需要将容器(22)的 SSH 端口映射到 `docker-compose.yml` 中的主机端口 2222。由于此端口不需要暴露给外界,因此可以将其映射到主机的 `localhost`
311+
312+
```bash
313+
ports:
314+
# [...]
315+
- "127.0.0.1:2222:22"
38316
```
39317

40-
然后 容器已经运行成功,在浏览器中访问 http://hostname:10080 就可以看到界面了。你可以尝试在上面创建项目,clone操作 `git clone ssh://git@hostname:10022/username/repo.git`.
318+
另外,主机上的 `/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 [...]` 作为前缀。
319+
320+
该文件应该看起来像:
321+
322+
```bash
323+
# SSH pubkey from git user
324+
ssh-rsa <Gitea Host Key>
325+
326+
# other keys from users
327+
command="/app/gitea/gitea --config=/data/gitea/conf/app.ini serv key-1",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty <user pubkey>
328+
```
329+
330+
这是详细的说明,当发出 SSH 请求时会发生什么:
331+
332+
1. 使用 `git` 用户向主机发出 SSH 请求,例如 `git clone git@domain:user/repo.git`
333+
2.`/home/git/.ssh/authorized_keys` 中,该命令执行 `/app/gitea/gitea` 脚本。
334+
3. `/app/gitea/gitea` 将 SSH 请求转发到端口 2222,该端口已映射到容器的 SSH 端口(22)。
335+
4. 由于 `/home/git/.ssh/authorized_keys` 中存在 `git` 用户的公钥,因此身份验证主机 → 容器成功,并且 SSH 请求转发到在 docker 容器中运行的 Gitea。
336+
337+
如果在 Gitea Web 界面中添加了新的 SSH 密钥,它将以与现有密钥相同的方式附加到 `.ssh/authorized_keys` 中。
41338

42-
注意:目前端口改为非3000时,需要修改配置文件 `LOCAL_ROOT_URL = http://localhost:3000/`
339+
**注意**
43340

44-
## 需要帮助?
341+
SSH 容器直通仅在以下情况下有效
45342

46-
如果从本页中没有找到你需要的内容,请访问 [帮助页面]({{< relref "seek-help.zh-cn.md" >}})
343+
- 在容器中使用 `opensshd`
344+
- 如果未将 `AuthorizedKeysCommand``SSH_CREATE_AUTHORIZED_KEYS_FILE = false` 结合使用以禁用授权文件密钥生成
345+
- `LOCAL_ROOT_URL` 不变

0 commit comments

Comments
 (0)