mirror of
https://github.com/maxdorninger/MediaManager.git
synced 2026-02-19 23:49:11 -05:00
update documentation to include the configuration of the notification module
This commit is contained in:
@@ -27,6 +27,11 @@ A list of email addresses for administrator accounts. This is a required field.
|
||||
|
||||
The URL the frontend will be accessed from. This is a required field. Example: `https://mediamanager.example/`.
|
||||
|
||||
## `AUTH_EMAIL_PASSWORD_RESETS`
|
||||
|
||||
Toggle for enabling password resets via email. If users request a password reset in case they forgot their password,
|
||||
they will be sent an email with a link to reset it. Default is `FALSE`.
|
||||
|
||||
<note>
|
||||
On login/registration, every user whose email is in <code>AUTH_ADMIN_EMAIL</code> will be granted admin privileges.
|
||||
Users whose email is not in <code>AUTH_ADMIN_EMAIL</code> will be regular users and will need to be verified by an administrator,
|
||||
|
||||
@@ -61,7 +61,6 @@ Password for QBittorrent. Default is `admin`.
|
||||
|
||||
## Metadata Provider Settings
|
||||
|
||||
|
||||
<note>
|
||||
Note the lack of a trailing slash in some env vars like <code>TMDB_RELAY_URL</code>. This is important.
|
||||
</note>
|
||||
@@ -145,6 +144,74 @@ Location of movie files. Default is `/data/movies`.
|
||||
|
||||
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`
|
||||
|
||||
Reference in New Issue
Block a user