docs: add note on environment variable formatting in case of special characters (#425)

Added information to explain to the user what to do when sections contain special characters such as `.` and `-`

---------

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: SiriosDev <26876994+SiriosDev@users.noreply.github.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/425
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: SiriosDev <203106+siriosdev@noreply.gitea.com>
This commit is contained in:
SiriosDev
2026-07-09 23:51:10 +00:00
committed by Lunny Xiao
parent 938700805b
commit 20c924ddb6

View File

@@ -36,6 +36,11 @@ A full restart is required for Gitea configuration changes to take effect.
Gitea supports setting `app.ini` values via environment variables of the form `GITEA__<section>__<KEY>`. These require running `gitea config edit-ini --in-place --apply-env` before starting Gitea to write them into `app.ini`. The official Docker images do this automatically on container startup.
:::info
If `<section>` or `<KEY>` contains a `.`, replace that with `_0X2E_`; if it contains a `-`, replace it with `_0X2C_`
:::
For example, to configure the database connection via environment variables:
```