luckyimnotanigger/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2025-06-17 11:59:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update environment-to-ini README (#8183)

Browse source 
The README is linked to by the docs, but has become outdated.
This brings the file back in line with the tool's description, fixes the
left over Gitea branding and improves the wording in some places.

## Checklist

The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org).

### Tests

- I added test coverage for Go changes...
  - [ ] in their respective `*_test.go` for unit tests.
  - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server.
- I added test coverage for JavaScript changes...
  - [ ] in `web_src/js/*.test.js` if it can be unit tested.
  - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)).

### Documentation

- [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change.
- [x] I did not document these changes and I do not expect someone else to do it.

### Release notes

- [x] I do not want this change to show in the release notes.
- [ ] I want the title to show in the release notes with a link to this pull request.
- [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8183
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Lucas Schwiderski <lucas@lschwiderski.de>
Co-committed-by: Lucas Schwiderski <lucas@lschwiderski.de>
This commit is contained in:
Lucas Schwiderski 2025-06-13 21:59:26 +02:00 • committed by Earl Warren
parent 07cc5802bf
commit 44de50fcac
1 changed files with 26 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

51
contrib/environment-to-ini/README
View file

@ -1,45 +1,46 @@
Environment To Ini Environment To Ini
================== ==================
Multiple docker users have requested that the Gitea docker is changed This tool allows defining Forgejo's entire configuration via environment
to permit arbitrary configuration via environment variables. variables, mostly geared towards usage in Docker.
Gitea needs to use an ini file for configuration because the running Forgejo needs to use an INI file for configuration because the running
environment that starts the docker may not be the same as that used environment that starts the container may not be the same as the one used
by the hooks. An ini file also gives a good default and means that by the hooks. An INI file also gives a good default and means that
users do not have to completely provide a full environment. users do not have to provide the entire set of environment variables.
With those caveats above, this command provides a generic way of With those caveats above, this command provides a generic way of
converting suitably structured environment variables into any ini converting suitably structured environment variables into any ini
value. value.
To use the command is very simple just run it and the default gitea When run, `environment-to-ini` will write the config files based on the
app.ini will be rewritten to take account of the variables provided, environment variables provided.
however there are various options to give slightly different Check with the `-h` flag for several options to alter this behaviour.
behavior and these can be interrogated with the `-h` option.
The environment variables should be of the form: Environment variables of the form "FORGEJO__SECTION_NAME__KEY_NAME"
will be mapped to the ini section "[section_name]" and the key
"KEY_NAME" with the value as provided.
GITEA__SECTION_NAME__KEY_NAME Environment variables of the form "FORGEJO__SECTION_NAME__KEY_NAME__FILE"
will be mapped to the ini section "[section_name]" and the key
Note, SECTION_NAME in the notation above is case-insensitive. "KEY_NAME" with the value loaded from the specified file.
Environment variables are usually restricted to a reduced character Environment variables are usually restricted to a reduced character
set "0-9A-Z_" - in order to allow the setting of sections with set "0-9A-Z_" - in order to allow the setting of sections with
characters outside of that set, they should be escaped as following: characters outside of that set, they should be escaped as following:
"_0X2E_" for "." and "_0X2D_" for "-". The entire section and key names "_0X2E_" for ".". The entire section and key names can be escaped as
can be escaped as a UTF8 byte string if necessary. E.g. to configure: a UTF8 byte string if necessary. E.g. to configure:
""" """
... ...
[log.console] [log.console]
COLORIZE=false COLORIZE=false
STDERR=true STDERR=true
... ...
""" """
You would set the environment variables: "GITEA__LOG_0x2E_CONSOLE__COLORIZE=false" You would set the environment variables: "FORGEJO__LOG_0x2E_CONSOLE__COLORIZE=false"
and "GITEA__LOG_0x2E_CONSOLE__STDERR=false". Other examples can be found and "FORGEJO__LOG_0x2E_CONSOLE__STDERR=false". Other examples can be found
on the configuration cheat sheet. on the configuration cheat sheet.
To build locally, run: To build locally, run: