mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-11-24 08:57:03 -05:00
061b68e995
Backport #25330 # The problem There were many "path tricks": * By default, Gitea uses its program directory as its work path * Gitea tries to use the "work path" to guess its "custom path" and "custom conf (app.ini)" * Users might want to use other directories as work path * The non-default work path should be passed to Gitea by GITEA_WORK_DIR or "--work-path" * But some Gitea processes are started without these values * The "serv" process started by OpenSSH server * The CLI sub-commands started by site admin * The paths are guessed by SetCustomPathAndConf again and again * The default values of "work path / custom path / custom conf" can be changed when compiling # The solution * Use `InitWorkPathAndCommonConfig` to handle these path tricks, and use test code to cover its behaviors. * When Gitea's web server runs, write the WORK_PATH to "app.ini", this value must be the most correct one, because if this value is not right, users would find that the web UI doesn't work and then they should be able to fix it. * Then all other sub-commands can use the WORK_PATH in app.ini to initialize their paths. * By the way, when Gitea starts for git protocol, it shouldn't output any log, otherwise the git protocol gets broken and client blocks forever. The "work path" priority is: WORK_PATH in app.ini > cmd arg --work-path > env var GITEA_WORK_DIR > builtin default The "app.ini" searching order is: cmd arg --config > cmd arg "work path / custom path" > env var "work path / custom path" > builtin default ## ⚠️ BREAKING If your instance's "work path / custom path / custom conf" doesn't meet the requirements (eg: work path must be absolute), Gitea will report a fatal error and exit. You need to set these values according to the error log. |
||
|---|---|---|
| .. | ||
| environment-to-ini.go | ||
| README | ||
Environment To Ini ================== Multiple docker users have requested that the Gitea docker is changed to permit arbitrary configuration via environment variables. Gitea needs to use an ini file for configuration because the running environment that starts the docker may not be the same as that used by the hooks. An ini file also gives a good default and means that users do not have to completely provide a full environment. With those caveats above, this command provides a generic way of converting suitably structured environment variables into any ini value. To use the command is very simple just run it and the default gitea app.ini will be rewritten to take account of the variables provided, however there are various options to give slightly different behavior and these can be interrogated with the `-h` option. The environment variables should be of the form: GITEA__SECTION_NAME__KEY_NAME Note, SECTION_NAME in the notation above is case-insensitive. Environment variables are usually restricted to a reduced character set "0-9A-Z_" - in order to allow the setting of sections with characters outside of that set, they should be escaped as following: "_0X2E_" for "." and "_0X2D_" for "-". The entire section and key names can be escaped as a UTF8 byte string if necessary. E.g. to configure: """ ... [log.console] COLORIZE=false STDERR=true ... """ You would set the environment variables: "GITEA__LOG_0x2E_CONSOLE__COLORIZE=false" and "GITEA__LOG_0x2E_CONSOLE__STDERR=false". Other examples can be found on the configuration cheat sheet. To build locally, run: go build contrib/environment-to-ini/environment-to-ini.go