aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDan Church <h3xx@users.noreply.github.com>2022-12-20 16:26:03 -0600
committerGitHub <noreply@github.com>2022-12-20 17:26:03 -0500
commit70d15e77851a437384de018ffebcf4fb3c5af789 (patch)
tree34977a955377f5d2fe5833811eccb503e203d5a3 /docs
parente767b3372a2171860f07ff57ce165d6cd68448c8 (diff)
downloadgitea-70d15e77851a437384de018ffebcf4fb3c5af789.tar.gz
gitea-70d15e77851a437384de018ffebcf4fb3c5af789.zip
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 <techknowlogick@gitea.io>
Diffstat (limited to 'docs')
-rw-r--r--docs/content/doc/installation/with-docker-rootless.en-us.md20
-rw-r--r--docs/content/doc/installation/with-docker.en-us.md38
-rw-r--r--docs/content/doc/installation/with-docker.zh-cn.md38
3 files changed, 48 insertions, 48 deletions
diff --git a/docs/content/doc/installation/with-docker-rootless.en-us.md b/docs/content/doc/installation/with-docker-rootless.en-us.md
index 8af3e5b8b6..028d81ab91 100644
--- a/docs/content/doc/installation/with-docker-rootless.en-us.md
+++ b/docs/content/doc/installation/with-docker-rootless.en-us.md
@@ -82,7 +82,7 @@ services:
restart: always
volumes:
- ./data:/var/lib/gitea
- - ./config:/etc/gitea
+ - ./config:/etc/gitea
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
ports:
@@ -112,7 +112,7 @@ services:
restart: always
volumes:
- ./data:/var/lib/gitea
- - ./config:/etc/gitea
+ - ./config:/etc/gitea
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
ports:
@@ -153,7 +153,7 @@ services:
restart: always
volumes:
- ./data:/var/lib/gitea
- - ./config:/etc/gitea
+ - ./config:/etc/gitea
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
ports:
@@ -293,13 +293,13 @@ These environment variables can be passed to the docker container in `docker-com
services:
server:
environment:
- - GITEA__mailer__ENABLED=true
- - GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
- - GITEA__mailer__MAILER_TYPE=smtp
- - GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
- - GITEA__mailer__IS_TLS_ENABLED=true
- - GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
- - GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}"""
+ - GITEA__mailer__ENABLED=true
+ - GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
+ - GITEA__mailer__MAILER_TYPE=smtp
+ - GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
+ - GITEA__mailer__IS_TLS_ENABLED=true
+ - GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
+ - GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}"""
```
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).
diff --git a/docs/content/doc/installation/with-docker.en-us.md b/docs/content/doc/installation/with-docker.en-us.md
index 895f04804e..90c6e7b5f3 100644
--- a/docs/content/doc/installation/with-docker.en-us.md
+++ b/docs/content/doc/installation/with-docker.en-us.md
@@ -117,11 +117,11 @@ services:
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
++ - 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
@@ -168,11 +168,11 @@ services:
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
++ - 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
@@ -225,8 +225,8 @@ services:
networks:
- gitea
volumes:
-- - ./gitea:/data
-+ - gitea:/data
+- - ./gitea:/data
++ - gitea:/data
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
ports:
@@ -294,13 +294,13 @@ These environment variables can be passed to the docker container in `docker-com
services:
server:
environment:
- - GITEA__mailer__ENABLED=true
- - GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
- - GITEA__mailer__MAILER_TYPE=smtp
- - GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
- - GITEA__mailer__IS_TLS_ENABLED=true
- - GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
- - GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}"""
+ - GITEA__mailer__ENABLED=true
+ - GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
+ - GITEA__mailer__MAILER_TYPE=smtp
+ - GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
+ - GITEA__mailer__IS_TLS_ENABLED=true
+ - GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
+ - GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}"""
```
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.
diff --git a/docs/content/doc/installation/with-docker.zh-cn.md b/docs/content/doc/installation/with-docker.zh-cn.md
index 2c63c9d4e1..cae28c70b8 100644
--- a/docs/content/doc/installation/with-docker.zh-cn.md
+++ b/docs/content/doc/installation/with-docker.zh-cn.md
@@ -103,11 +103,11 @@ services:
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
++ - 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
@@ -153,11 +153,11 @@ services:
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
++ - 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
@@ -207,8 +207,8 @@ services:
networks:
- gitea
volumes:
-- - ./gitea:/data
-+ - gitea:/data
+- - ./gitea:/data
++ - gitea:/data
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
ports:
@@ -285,13 +285,13 @@ docker-compose up -d
services:
server:
environment:
- - GITEA__mailer__ENABLED=true
- - GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
- - GITEA__mailer__MAILER_TYPE=smtp
- - GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
- - GITEA__mailer__IS_TLS_ENABLED=true
- - GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
- - GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}"""
+ - GITEA__mailer__ENABLED=true
+ - GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
+ - GITEA__mailer__MAILER_TYPE=smtp
+ - GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
+ - GITEA__mailer__IS_TLS_ENABLED=true
+ - 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 内置的[方法](https://docs.gitea.io/en-us/command-line/#generate)生成 `SECRET_KEY`。 安装后请妥善保管您的 `SECRET_KEY`,如若丢失则无法解密已加密的数据。