Files
MediaManager/Writerside/topics/configuration-backend.md

5.7 KiB

Backend

These variables configure the core backend application, database connections, authentication, and integrations.

General Settings

API_BASE_PATH

The url base of the backend. Default is /api/v1.

CORS_URLS

Enter a list of origins you are going to access the api from. Example: ["https://mm.example"].

Database Settings

DB_HOST

Hostname or IP of the PostgreSQL server. Default is localhost.

DB_PORT

Port number of the PostgreSQL server. Default is 5432.

DB_USER

Username for PostgreSQL connection. Default is MediaManager.

DB_PASSWORD

Password for the PostgreSQL user. Default is MediaManager.

DB_DBNAME

Name of the PostgreSQL database. Default is MediaManager.

Download Client Settings

Currently, only qBittorrent is supported as a download client. But support for other clients isn't unlikely in the future.

QBITTORRENT_HOST

Host of the QBittorrent API. Default is localhost. Example: qbit.example.com.

QBITTORRENT_PORT

Port of the QBittorrent API. Default is 8080. Example: 443.

QBITTORRENT_USER

Username for QBittorrent. Default is admin.

QBITTORRENT_PASSWORD

Password for QBittorrent. Default is admin.

Metadata Provider Settings

Note the lack of a trailing slash in some env vars like TMDB_RELAY_URL. This is important.

These settings configure the integrations with external metadata providers like The Movie Database (TMDB) and The TVDB.

TMDB (The Movie Database)

TMDB is the primary metadata provider for MediaManager. It provides detailed information about movies and TV shows.

Other software like Jellyfin use TMDB as well, so there won't be any metadata discrepancies.

TMDB_RELAY_URL

If you want use your own TMDB relay service, set this to the URL of your own MetadataRelay. Otherwise, don't set it to use the default relay.

Default: https://metadata-relay.maxid.me/tmdb.

TVDB (The TVDB)

The TVDB might provide false metadata, also it doesn't support some features of MediaManager like to show overviews, therfore TMDB is the preferred metadata provider.

TVDB_RELAY_URL

If you want use your own TVDB relay service, set this to the URL of your own MetadataRelay. Otherwise, don't set it to use the default relay.

Default: https://metadata-relay.maxid.me/tvdb.

MetadataRelay

To use MediaManager you don't need to set up your own MetadataRelay, as the default relay which is hosted by me, the dev of MediaManager, should be sufficient for most purposes.

The MetadataRelay is a service that provides metadata for MediaManager. It acts as a proxy for TMDB and TVDB, allowing you to use your own API keys, but not strictly needing your own because only me, the developer, needs to create accounts for API keys. You might want to use it if you want to avoid rate limits, to protect your privacy, or other reasons. If you know Sonarr's Skyhook, this is similar to that.

Where to get API keys

Get an API key from The Movie Database. You can create an account and generate a free API key in your account settings.

Get an API key from The TVDB. You can create an account and generate a free API key in your account settings.

If you want to use your own MetadataRelay, you can set the TMDB_RELAY_URL and/or TVDB_RELAY_URL to your own relay service.

Directory Settings

Normally you don't need to change these, as the default mountpoints are usually sufficient. In your docker-compose.yaml, you can just mount /any/directory to /data/torrents.

IMAGE_DIRECTORY

Media images (posters, backdrops) will be stored here. Default is /data/images.

TV_DIRECTORY

Location of TV show files. Default is /data/tv.

MOVIE_DIRECTORY

Location of movie files. Default is /data/movies.

TORRENT_DIRECTORY

Location of torrent files and downloads. Default is /data/torrents.

Email Settings

For sending emails, MediaManager uses the SMTP protocol. You can use any SMTP server, like Gmail or SMTP2GO.

EMAIL_SMTP_HOST

Hostname of the SMTP server.

EMAIL_SMTP_PORT

Port of the SMTP server.

EMAIL_SMTP_USER

Username for the SMTP server.

EMAIL_SMTP_PASSWORD

Password for the SMTP server.

EMAIL_FROM_EMAIL

Email address from which emails will be sent.

EMAIL_USE_TLS

Set to True to use TLS for the SMTP connection. Default is False. For secure connections, use TLS.

Notification Settings

MediaManager can send Notifications via email, ntfy.sh, Pushover and Gotify. You can enable any of these. To enable a notification method, set the corresponding environment variables.

Email

NOTIFICATION_EMAIL

If set notifications will be sent via email to this email address. Example: notifications@example.com.

Gotify

NOTIFICATION_GOTIFY_API_KEY

API key for Gotify.

NOTIFICATION_GOTIFY_URL

Base URL of your Gotify instance. Example: https://gotify.example.com. Note the lack of a trailing slash.

Ntfy

NOTIFICATION_NTFY_URL

URL of your ntfy instance + the topic. Example https://ntfy.sh/your-topic.

Pushover

NOTIFICATION_PUSHOVER_API_KEY

API key for Pushover.

NOTIFICATION_PUSHOVER_USER

Username for Pushover.

Build Arguments (Dockerfile)

VERSION

Labels the Docker image with a version. Passed during build (e.g., by GitHub Actions). Frontend uses this as PUBLIC_VERSION. Example (in build command): docker build --build-arg VERSION=1.2.3 .