Skip to content

Commit 70d15e7

Browse files
h3xxtechknowlogick
andauthored
Fix misc whitespace issues in install docs (#22189)
I ran into issues when copy-pasting the docker-compose.yml contents from https://docs.gitea.io/en-us/install-with-docker/ - specifically the part about adding PostgreSQL to the YAML file; I tried manually adding the diffs by removing the `+` at the beginning of lines, and the resulting YAML was unparsable. This forces the indentation to be consistent across all places where YAML is used. Co-authored-by: techknowlogick <[email protected]>
1 parent e767b33 commit 70d15e7

File tree

3 files changed

+48
-48
lines changed

3 files changed

+48
-48
lines changed

docs/content/doc/installation/with-docker-rootless.en-us.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ services:
8282
restart: always
8383
volumes:
8484
- ./data:/var/lib/gitea
85-
- ./config:/etc/gitea
85+
- ./config:/etc/gitea
8686
- /etc/timezone:/etc/timezone:ro
8787
- /etc/localtime:/etc/localtime:ro
8888
ports:
@@ -112,7 +112,7 @@ services:
112112
restart: always
113113
volumes:
114114
- ./data:/var/lib/gitea
115-
- ./config:/etc/gitea
115+
- ./config:/etc/gitea
116116
- /etc/timezone:/etc/timezone:ro
117117
- /etc/localtime:/etc/localtime:ro
118118
ports:
@@ -153,7 +153,7 @@ services:
153153
restart: always
154154
volumes:
155155
- ./data:/var/lib/gitea
156-
- ./config:/etc/gitea
156+
- ./config:/etc/gitea
157157
- /etc/timezone:/etc/timezone:ro
158158
- /etc/localtime:/etc/localtime:ro
159159
ports:
@@ -293,13 +293,13 @@ These environment variables can be passed to the docker container in `docker-com
293293
services:
294294
server:
295295
environment:
296-
- GITEA__mailer__ENABLED=true
297-
- GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
298-
- GITEA__mailer__MAILER_TYPE=smtp
299-
- GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
300-
- GITEA__mailer__IS_TLS_ENABLED=true
301-
- GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
302-
- GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}"""
296+
- GITEA__mailer__ENABLED=true
297+
- GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
298+
- GITEA__mailer__MAILER_TYPE=smtp
299+
- GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
300+
- GITEA__mailer__IS_TLS_ENABLED=true
301+
- GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
302+
- GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}"""
303303
```
304304

305305
To set required TOKEN and SECRET values, consider using Gitea's built-in [generate utility functions](https://docs.gitea.io/en-us/command-line/#generate).

docs/content/doc/installation/with-docker.en-us.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,11 @@ services:
117117
environment:
118118
- USER_UID=1000
119119
- USER_GID=1000
120-
+ - GITEA__database__DB_TYPE=mysql
121-
+ - GITEA__database__HOST=db:3306
122-
+ - GITEA__database__NAME=gitea
123-
+ - GITEA__database__USER=gitea
124-
+ - GITEA__database__PASSWD=gitea
120+
+ - GITEA__database__DB_TYPE=mysql
121+
+ - GITEA__database__HOST=db:3306
122+
+ - GITEA__database__NAME=gitea
123+
+ - GITEA__database__USER=gitea
124+
+ - GITEA__database__PASSWD=gitea
125125
restart: always
126126
networks:
127127
- gitea
@@ -168,11 +168,11 @@ services:
168168
environment:
169169
- USER_UID=1000
170170
- USER_GID=1000
171-
+ - GITEA__database__DB_TYPE=postgres
172-
+ - GITEA__database__HOST=db:5432
173-
+ - GITEA__database__NAME=gitea
174-
+ - GITEA__database__USER=gitea
175-
+ - GITEA__database__PASSWD=gitea
171+
+ - GITEA__database__DB_TYPE=postgres
172+
+ - GITEA__database__HOST=db:5432
173+
+ - GITEA__database__NAME=gitea
174+
+ - GITEA__database__USER=gitea
175+
+ - GITEA__database__PASSWD=gitea
176176
restart: always
177177
networks:
178178
- gitea
@@ -225,8 +225,8 @@ services:
225225
networks:
226226
- gitea
227227
volumes:
228-
- - ./gitea:/data
229-
+ - gitea:/data
228+
- - ./gitea:/data
229+
+ - gitea:/data
230230
- /etc/timezone:/etc/timezone:ro
231231
- /etc/localtime:/etc/localtime:ro
232232
ports:
@@ -294,13 +294,13 @@ These environment variables can be passed to the docker container in `docker-com
294294
services:
295295
server:
296296
environment:
297-
- GITEA__mailer__ENABLED=true
298-
- GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
299-
- GITEA__mailer__MAILER_TYPE=smtp
300-
- GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
301-
- GITEA__mailer__IS_TLS_ENABLED=true
302-
- GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
303-
- GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}"""
297+
- GITEA__mailer__ENABLED=true
298+
- GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
299+
- GITEA__mailer__MAILER_TYPE=smtp
300+
- GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
301+
- GITEA__mailer__IS_TLS_ENABLED=true
302+
- GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
303+
- GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}"""
304304
```
305305

306306
Gitea will generate new secrets/tokens for every new installation automatically and write them into the app.ini. If you want to set the secrets/tokens manually, you can use the following docker commands to use of Gitea's built-in [generate utility functions](https://docs.gitea.io/en-us/command-line/#generate). Do not lose/change your SECRET_KEY after the installation, otherwise the encrypted data can not be decrypted anymore.

docs/content/doc/installation/with-docker.zh-cn.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,11 @@ services:
103103
environment:
104104
- USER_UID=1000
105105
- USER_GID=1000
106-
+ - GITEA__database__DB_TYPE=mysql
107-
+ - GITEA__database__HOST=db:3306
108-
+ - GITEA__database__NAME=gitea
109-
+ - GITEA__database__USER=gitea
110-
+ - GITEA__database__PASSWD=gitea
106+
+ - GITEA__database__DB_TYPE=mysql
107+
+ - GITEA__database__HOST=db:3306
108+
+ - GITEA__database__NAME=gitea
109+
+ - GITEA__database__USER=gitea
110+
+ - GITEA__database__PASSWD=gitea
111111
restart: always
112112
networks:
113113
- gitea
@@ -153,11 +153,11 @@ services:
153153
environment:
154154
- USER_UID=1000
155155
- USER_GID=1000
156-
+ - GITEA__database__DB_TYPE=postgres
157-
+ - GITEA__database__HOST=db:5432
158-
+ - GITEA__database__NAME=gitea
159-
+ - GITEA__database__USER=gitea
160-
+ - GITEA__database__PASSWD=gitea
156+
+ - GITEA__database__DB_TYPE=postgres
157+
+ - GITEA__database__HOST=db:5432
158+
+ - GITEA__database__NAME=gitea
159+
+ - GITEA__database__USER=gitea
160+
+ - GITEA__database__PASSWD=gitea
161161
restart: always
162162
networks:
163163
- gitea
@@ -207,8 +207,8 @@ services:
207207
networks:
208208
- gitea
209209
volumes:
210-
- - ./gitea:/data
211-
+ - gitea:/data
210+
- - ./gitea:/data
211+
+ - gitea:/data
212212
- /etc/timezone:/etc/timezone:ro
213213
- /etc/localtime:/etc/localtime:ro
214214
ports:
@@ -285,13 +285,13 @@ docker-compose up -d
285285
services:
286286
server:
287287
environment:
288-
- GITEA__mailer__ENABLED=true
289-
- GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
290-
- GITEA__mailer__MAILER_TYPE=smtp
291-
- GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
292-
- GITEA__mailer__IS_TLS_ENABLED=true
293-
- GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
294-
- GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}"""
288+
- GITEA__mailer__ENABLED=true
289+
- GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
290+
- GITEA__mailer__MAILER_TYPE=smtp
291+
- GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
292+
- GITEA__mailer__IS_TLS_ENABLED=true
293+
- GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
294+
- GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}"""
295295
```
296296

297297
Gitea 将为每次新安装自动生成新的 `SECRET_KEY` 并将它们写入 `app.ini`。 如果您想手动设置 `SECRET_KEY`,您可以使用以下 docker 命令来使用 Gitea 内置的[方法](https://docs.gitea.io/en-us/command-line/#generate)生成 `SECRET_KEY`。 安装后请妥善保管您的 `SECRET_KEY`,如若丢失则无法解密已加密的数据。

0 commit comments

Comments
 (0)