realaravinth/bench-forgejo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix misc whitespace issues in install docs (#22189)

Browse source 
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>
This commit is contained in:
Dan Church 2022-12-20 16:26:03 -06:00 committed by GitHub
parent e767b3372a
commit 70d15e7785
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 48 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -293,13 +293,13 @@ These environment variables can be passed to the docker container in `docker-com
services: services:
server: server:
environment: environment:
- GITEA__mailer__ENABLED=true - GITEA__mailer__ENABLED=true
- GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set} - GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
- GITEA__mailer__MAILER_TYPE=smtp - GITEA__mailer__MAILER_TYPE=smtp
- GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set} - GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
- GITEA__mailer__IS_TLS_ENABLED=true - GITEA__mailer__IS_TLS_ENABLED=true
- GITEA__mailer__USER=${GITEA__mailer__USER:-apikey} - GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
- GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}""" - 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). 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).

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

@ -117,11 +117,11 @@ services:
environment: environment:
- USER_UID=1000 - USER_UID=1000
- USER_GID=1000 - USER_GID=1000
+ - GITEA__database__DB_TYPE=mysql + - GITEA__database__DB_TYPE=mysql
+ - GITEA__database__HOST=db:3306 + - GITEA__database__HOST=db:3306
+ - GITEA__database__NAME=gitea + - GITEA__database__NAME=gitea
+ - GITEA__database__USER=gitea + - GITEA__database__USER=gitea
+ - GITEA__database__PASSWD=gitea + - GITEA__database__PASSWD=gitea
restart: always restart: always
networks: networks:
- gitea - gitea
@ -168,11 +168,11 @@ services:
environment: environment:
- USER_UID=1000 - USER_UID=1000
- USER_GID=1000 - USER_GID=1000
+ - GITEA__database__DB_TYPE=postgres + - GITEA__database__DB_TYPE=postgres
+ - GITEA__database__HOST=db:5432 + - GITEA__database__HOST=db:5432
+ - GITEA__database__NAME=gitea + - GITEA__database__NAME=gitea
+ - GITEA__database__USER=gitea + - GITEA__database__USER=gitea
+ - GITEA__database__PASSWD=gitea + - GITEA__database__PASSWD=gitea
restart: always restart: always
networks: networks:
- gitea - gitea
@ -225,8 +225,8 @@ services:
networks: networks:
- gitea - gitea
volumes: volumes:
- - ./gitea:/data - - ./gitea:/data
+ - gitea:/data + - gitea:/data
- /etc/timezone:/etc/timezone:ro - /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro - /etc/localtime:/etc/localtime:ro
ports: ports:
@ -294,13 +294,13 @@ These environment variables can be passed to the docker container in `docker-com
services: services:
server: server:
environment: environment:
- GITEA__mailer__ENABLED=true - GITEA__mailer__ENABLED=true
- GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set} - GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
- GITEA__mailer__MAILER_TYPE=smtp - GITEA__mailer__MAILER_TYPE=smtp
- GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set} - GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
- GITEA__mailer__IS_TLS_ENABLED=true - GITEA__mailer__IS_TLS_ENABLED=true
- GITEA__mailer__USER=${GITEA__mailer__USER:-apikey} - GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
- GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}""" - 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. 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.

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

@ -103,11 +103,11 @@ services:
environment: environment:
- USER_UID=1000 - USER_UID=1000
- USER_GID=1000 - USER_GID=1000
+ - GITEA__database__DB_TYPE=mysql + - GITEA__database__DB_TYPE=mysql
+ - GITEA__database__HOST=db:3306 + - GITEA__database__HOST=db:3306
+ - GITEA__database__NAME=gitea + - GITEA__database__NAME=gitea
+ - GITEA__database__USER=gitea + - GITEA__database__USER=gitea
+ - GITEA__database__PASSWD=gitea + - GITEA__database__PASSWD=gitea
restart: always restart: always
networks: networks:
- gitea - gitea
@ -153,11 +153,11 @@ services:
environment: environment:
- USER_UID=1000 - USER_UID=1000
- USER_GID=1000 - USER_GID=1000
+ - GITEA__database__DB_TYPE=postgres + - GITEA__database__DB_TYPE=postgres
+ - GITEA__database__HOST=db:5432 + - GITEA__database__HOST=db:5432
+ - GITEA__database__NAME=gitea + - GITEA__database__NAME=gitea
+ - GITEA__database__USER=gitea + - GITEA__database__USER=gitea
+ - GITEA__database__PASSWD=gitea + - GITEA__database__PASSWD=gitea
restart: always restart: always
networks: networks:
- gitea - gitea
@ -207,8 +207,8 @@ services:
networks: networks:
- gitea - gitea
volumes: volumes:
- - ./gitea:/data - - ./gitea:/data
+ - gitea:/data + - gitea:/data
- /etc/timezone:/etc/timezone:ro - /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro - /etc/localtime:/etc/localtime:ro
ports: ports:
@ -285,13 +285,13 @@ docker-compose up -d
services: services:
server: server:
environment: environment:
- GITEA__mailer__ENABLED=true - GITEA__mailer__ENABLED=true
- GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set} - GITEA__mailer__FROM=${GITEA__mailer__FROM:?GITEA__mailer__FROM not set}
- GITEA__mailer__MAILER_TYPE=smtp - GITEA__mailer__MAILER_TYPE=smtp
- GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set} - GITEA__mailer__HOST=${GITEA__mailer__HOST:?GITEA__mailer__HOST not set}
- GITEA__mailer__IS_TLS_ENABLED=true - GITEA__mailer__IS_TLS_ENABLED=true
- GITEA__mailer__USER=${GITEA__mailer__USER:-apikey} - GITEA__mailer__USER=${GITEA__mailer__USER:-apikey}
- GITEA__mailer__PASSWD="""${GITEA__mailer__PASSWD:?GITEA__mailer__PASSWD not set}""" - 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`，如若丢失则无法解密已加密的数据。 Gitea 将为每次新安装自动生成新的 `SECRET_KEY` 并将它们写入 `app.ini`。 如果您想手动设置 `SECRET_KEY`，您可以使用以下 docker 命令来使用 Gitea 内置的[方法](https://docs.gitea.io/en-us/command-line/#generate)生成 `SECRET_KEY`。 安装后请妥善保管您的 `SECRET_KEY`，如若丢失则无法解密已加密的数据。