From ea5596c16858d183d5dba0ddd04dceeb3d75f34f Mon Sep 17 00:00:00 2001 From: alexandra catalina Date: Sat, 30 Mar 2024 14:17:45 -0700 Subject: [PATCH] docs(readme) revert more paragraph wrapping --- README.md | 31 ++++++++++++------------------- 1 file changed, 12 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index d48e10d..62e8c1e 100644 --- a/README.md +++ b/README.md @@ -142,8 +142,8 @@ See the [HA Setup](docs/ha-setup.md) document for more details. ## Configuration -Forgejo offers lots of configuration options. This is fully described in the -[Cheat Sheet](https://forgejo.org/docs/latest/admin/config-cheat-sheet/). +Forgejo offers lots of configuration options. +This is fully described in the [Cheat Sheet](https://forgejo.org/docs/latest/admin/config-cheat-sheet/). ```yaml gitea: @@ -310,8 +310,7 @@ If HA is not needed/desired, the following configurations can be used to deploy ### Additional _app.ini_ settings -> **The -> [generic](https://forgejo.org/docs/latest/admin/config-cheat-sheet/#overall-default) +> **The [generic](https://forgejo.org/docs/latest/admin/config-cheat-sheet/#overall-default) > section cannot be defined that way.** Some settings inside _app.ini_ (like passwords or whole authentication configurations) must be considered sensitive and therefore should not be passed via plain text inside the _values.yaml_ file. @@ -398,11 +397,8 @@ Priority (highest to lowest) for defining app.ini variables: ### External Database -A [supported external -database](https://forgejo.org/docs/latest/admin/config-cheat-sheet/#database-database/) -can be used instead of the built-in PostgreSQL. In fact, it is **highly -recommended** to use an external database to ensure a stable Forgejo -installation longterm. +A [supported external database](https://forgejo.org/docs/latest/admin/config-cheat-sheet/#database-database/)can be used instead of the built-in PostgreSQL. +In fact, it is **highly recommended** to use an external database to ensure a stable Forgejo installation longterm. If an external database is used, no matter which type, make sure to set `postgresql.enabled` to `false` to disable the use of the built-in PostgreSQL. @@ -570,8 +566,8 @@ gitea: ### LDAP Settings -Like the admin user the LDAP settings can be updated. All LDAP values from - are available. +Like the admin user the LDAP settings can be updated. +All LDAP values from are available. Multiple LDAP sources can be configured with additional LDAP list items. @@ -623,11 +619,9 @@ Affected options: ### OAuth2 Settings -Like the admin user, OAuth2 settings can be updated and disabled but not -deleted. Deleting OAuth2 settings has to be done in the ui. All OAuth2 values, -which are documented -[here](https://forgejo.org/docs/latest/admin/command-line/#admin), are -available. +Like the admin user, OAuth2 settings can be updated and disabled but not deleted. +Deleting OAuth2 settings has to be done in the UI. +All OAuth2 values, which are documented [here](https://forgejo.org/docs/latest/admin/command-line/#admin), are available. Multiple OAuth2 sources can be configured with additional OAuth list items. @@ -702,9 +696,8 @@ signing: existingSecret: custom-gitea-gpg-key ``` -To use the gpg key, Forgejo needs to be configured accordingly. A detailed -description can be found in the -[documentation](https://forgejo.org/docs/latest/admin/signing/#general-configuration). +To use the gpg key, Forgejo needs to be configured accordingly. +A detailed description can be found in the [documentation](https://forgejo.org/docs/latest/admin/signing/#general-configuration). ## Metrics and profiling