mirror of
https://github.com/maxdorninger/MediaManager.git
synced 2026-04-18 01:54:00 +02:00
76 lines
2.4 KiB
Markdown
76 lines
2.4 KiB
Markdown
# Configuration
|
|
|
|
MediaManager uses a TOML configuration file (`config.toml`) for all backend settings.
|
|
This centralized configuration approach makes it easier to manage, backup, and share your MediaManager setup.
|
|
|
|
Frontend settings are configured through environment variables in your `docker-compose.yaml` file.
|
|
|
|
## Configuration File Location
|
|
|
|
<warning>Note that MediaManager may need to be restarted for changes in the config file to take effect.</warning>
|
|
|
|
Your `config.toml` file should be in the directory that's mounted to `/app/config/config.toml` inside the container:
|
|
|
|
```yaml
|
|
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,
|
|
e.g. `/etc/mediamanager/`.
|
|
|
|
## Configuration Sections
|
|
|
|
The configuration is organized into the following sections:
|
|
|
|
- `[misc]` - General settings
|
|
- `[database]` - Database settings
|
|
- `[auth]` - Authentication settings
|
|
- `[notifications]` - Notification settings (Email, Gotify, Ntfy, Pushover)
|
|
- `[torrents]` - Download client settings (qBittorrent, Transmission, SABnzbd)
|
|
- `[indexers]` - Indexer settings (Prowlarr and Jackett )
|
|
- `[metadata]` - TMDB and TVDB settings
|
|
|
|
## Configuring Secrets
|
|
|
|
For sensitive information like API keys, passwords, and secrets, you _should_ use environment variables.
|
|
You can actually set every configuration value through environment variables.
|
|
For example, to set the `token_secret` value for authentication, with a .toml file you would use:
|
|
|
|
```toml
|
|
[auth]
|
|
token_secret = "your_super_secret_key_here"
|
|
```
|
|
|
|
But you can also set it through an environment variable:
|
|
|
|
```
|
|
MEDIAMANAGER_AUTH__TOKEN_SECRET = "your_super_secret_key_here"
|
|
```
|
|
|
|
or another example with the OIDC client secret:
|
|
|
|
```toml
|
|
[auth]
|
|
...
|
|
[auth.openid_connect]
|
|
client_secret = "your_client_secret_from_provider"
|
|
```
|
|
|
|
env variable:
|
|
|
|
```
|
|
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 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>
|
|
|
|
|