starred/MediaManager-maxdorninger
1
0
Fork 0
mirror of https://github.com/maxdorninger/MediaManager.git synced 2026-04-17 15:13:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #133 from almarzn/patch-1

Browse Source 
add a prefix for environment variables
This commit is contained in:
Maximilian Dorninger
2025-08-11 22:24:31 +02:00
committed by GitHub
parent 41531b3807 35a4b4a14c
commit 6c4b6a52cf
2 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Writerside/topics/Configuration.md
View File

@@ -14,7 +14,8 @@ volumes:
- ./config:/app/config
```
Though you can change the location of the configuration file's directory by setting the `CONFIG_DIR` env variable to another path,
Though you can change the location of the configuration file's directory by setting the `CONFIG_DIR` env variable to
another path,
e.g. `/etc/mediamanager/`.
## Configuration Sections
@@ -43,7 +44,7 @@ token_secret = "your_super_secret_key_here"
But you can also set it through an environment variable:
```
AUTH__TOKEN_SECRET = "your_super_secret_key_here"
MEDIAMANAGER_AUTH__TOKEN_SECRET = "your_super_secret_key_here"
```
or another example with the OIDC client secret:
@@ -58,10 +59,15 @@ client_secret = "your_client_secret_from_provider"
env variable:
```
AUTH__OPENID_CONNECT__CLIENT_SECRET = "your_client_secret_from_provider"
MEDIAMANAGER_AUTH__OPENID_CONNECT__CLIENT_SECRET = "your_client_secret_from_provider"
```
So for every config "level", you basically have to take the name of the value and prepend it with the section names in
uppercase with 2 underscores as delimiters.
uppercase with 2 underscores as delimiters and `MEDIAMANAGER_` as the prefix.
<warning>Note that not every env variable starts with <code>MEDIAMANAGER_</code>,
this prefix only applies to env variables which replace/overwrite values in the config file.
Variables like the <code>CONFIG_DIR</code> env variable must not be prefixed.
</warning>

2
media_manager/config.py
View File

@@ -48,7 +48,7 @@ class BasicConfig(BaseSettings):
class AllEncompassingConfig(BaseSettings):
model_config = SettingsConfigDict(
toml_file=config_path, case_sensitive=False, env_nested_delimiter="__"
toml_file=config_path, case_sensitive=False, env_nested_delimiter="__", env_prefix="MEDIAMANAGER_"
)
"""
This class is used to load all configurations from the environment variables.