Skip to content

Commit bdb0962

Browse files
committed
feat: added env-variables information to README.md
1 parent d229df1 commit bdb0962

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,28 @@ We decided to opensource it as an easy-to-setup software after some requests.
1616
- dect-wip-ommsync checks for newly paired handsets and creates temporary voip accounts for calling the self-registration code.
1717
- dect-wip-mitel-phonebook provides an endpoint for mitel dect handsets to lookup phonebook entries
1818

19+
## Configuration and Environment Variables
20+
The main config `dect-wip.ini` is in `/etc/dect-wip.ini` by default.
21+
22+
Config location can be overridden with env-variable `CONFIG_PATH`(WSGI/Dev-Mode) or commandline argument `--config-file` (DEV-Mode).
23+
24+
All settings in `dect-wip.ini` can be overridden via env-variable (in all caps) in the following order:
25+
- `FROM_FILE_{SECTION}_{KEY}`
26+
- `{SECTION}_{KEY}`
27+
- Config-File
28+
29+
For example:
30+
- `FROM_FILE_EVENT_TOKEN_PREFIX`
31+
- `EVENT_TOKEN_PREFIX`
32+
```
33+
[event]
34+
token_prefix = 01990
35+
```
36+
37+
The prefix `FROM_FILE_` will read the contents of that file and uses it as variable value.
38+
39+
Values specified via env-variables can be omitted in `dect-wip.ini`. A config-file need to be present, but it can be empty.
40+
1941
## how to contribute
2042
- This is a fun-project! We don't get paid for this and we might have higher response times
2143
- Fetch a unassigned issue, ask if you don't know anything or are unsure

0 commit comments

Comments
 (0)