convert gitbook files to mkdocs

This commit is contained in:
maxid
2026-02-08 18:43:00 +01:00
parent 2665106847
commit 9c94ef6de0
54 changed files with 391 additions and 423 deletions

View File

@@ -6,9 +6,8 @@ Frontend settings are configured through environment variables in your `docker-c
## Configuration File Location
{% hint style="warning" %}
Note that MediaManager may need to be restarted for changes in the config file to take effect.
{% endhint %}
!!! warning
Note that MediaManager may need to be restarted for changes in the config file to take effect.
Your `config.toml` file should be in the directory that's mounted to `/app/config/config.toml` inside the container:
@@ -66,6 +65,5 @@ MEDIAMANAGER_AUTH__OPENID_CONNECT__CLIENT_SECRET = "your_client_secret_from_prov
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.
{% hint style="warning" %}
Note that not every env variable starts with `MEDIAMANAGER_`; this prefix only applies to env variables which replace/overwrite values in the config file. Variables like the `CONFIG_DIR` env variable must not be prefixed.
{% endhint %}
!!! warning
Note that not every env variable starts with `MEDIAMANAGER_`; this prefix only applies to env variables which replace/overwrite values in the config file. Variables like the `CONFIG_DIR` env variable must not be prefixed.

View File

@@ -20,13 +20,11 @@ All authentication settings are configured in the `[auth]` section of your `conf
* `email_password_resets`\
Enables password resets via email. Default is `false`.
{% hint style="info" %}
To use email password resets, you must also configure SMTP settings in the `[notifications.smtp_config]` section.
{% endhint %}
!!! info
To use email password resets, you must also configure SMTP settings in the `[notifications.smtp_config]` section.
{% hint style="info" %}
When setting up MediaManager for the first time, you should add your email to `admin_emails` in the `[auth]` config section. MediaManager will then use this email instead of the default admin email. Your account will automatically be created as an admin account, allowing you to manage other users, media and settings.
{% endhint %}
!!! info
When setting up MediaManager for the first time, you should add your email to `admin_emails` in the `[auth]` config section. MediaManager will then use this email instead of the default admin email. Your account will automatically be created as an admin account, allowing you to manage other users, media and settings.
## OpenID Connect Settings (`[auth.openid_connect]`)
@@ -53,22 +51,20 @@ The OpenID server will likely require a redirect URI. This URL will usually look
{MEDIAMANAGER_URL}/api/v1/auth/oauth/callback
```
{% hint style="warning" %}
It is very important that you set the correct callback URI, otherwise it won't work!
{% endhint %}
!!! warning
It is very important that you set the correct callback URI, otherwise it won't work!
#### Authentik Example
Here is an example configuration for the OpenID Connect provider for Authentik.
![authentik-redirect-url-example](<../.gitbook/assets/authentik redirect url example.png>)
![authentik-redirect-url-example](<../assets/assets/authentik redirect url example.png>)
## Example Configuration
Here's a complete example of the authentication section in your `config.toml`:
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[auth]
token_secret = "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6"
session_lifetime = 604800 # 1 week
@@ -82,4 +78,4 @@ client_secret = "your-secret-key-here"
configuration_endpoint = "https://auth.example.com/.well-known/openid-configuration"
name = "Authentik"
```
{% endcode %}

View File

@@ -26,8 +26,7 @@ description: >-
Here's a complete example of the general settings section in your `config.toml`:
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[misc]
# REQUIRED: Change this to match your actual frontend domain.
@@ -38,8 +37,6 @@ cors_urls = ["http://localhost:8000"]
# Optional: Development mode (set to true for debugging)
development = false
```
{% endcode %}
{% hint style="info" %}
The `frontend_url` is the most important setting to configure correctly. Make sure it matches your actual deployment URLs.
{% endhint %}
!!! info
The `frontend_url` is the most important setting to configure correctly. Make sure it matches your actual deployment URLs.

View File

@@ -6,9 +6,8 @@ MediaManager supports custom libraries, allowing you to add multiple folders for
Custom libraries are configured in the `misc` section in the `config.toml` file. You can add as many libraries as you need.
{% hint style="info" %}
You are not limited to `/data/tv` or `/data/movies`, you can choose the entire path freely!
{% endhint %}
!!! info
You are not limited to `/data/tv` or `/data/movies`, you can choose the entire path freely!
### Movie Libraries

View File

@@ -19,8 +19,7 @@ Database settings are configured in the `[database]` section of your `config.tom
Here's a complete example of the database section in your `config.toml`:
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[database]
host = "db"
port = 5432
@@ -28,8 +27,6 @@ user = "MediaManager"
password = "your_secure_password"
dbname = "MediaManager"
```
{% endcode %}
{% hint style="info" %}
In docker-compose deployments the container name is simultaneously its hostname, so you can use "db" or "postgres" as host.
{% endhint %}
!!! info
In docker-compose deployments the container name is simultaneously its hostname, so you can use "db" or "postgres" as host.

View File

@@ -19,9 +19,8 @@ qBittorrent is a popular BitTorrent client that MediaManager can integrate with
## Transmission Settings (`[torrents.transmission]`)
{% hint style="info" %}
The downloads path in Transmission and MediaManager must be the same, i.e. the path `/data/torrents` must link to the same volume for both containers.
{% endhint %}
!!! info
The downloads path in Transmission and MediaManager must be the same, i.e. the path `/data/torrents` must link to the same volume for both containers.
Transmission is a BitTorrent client that MediaManager can integrate with for downloading torrents.
@@ -59,8 +58,7 @@ SABnzbd is a Usenet newsreader that MediaManager can integrate with for download
Here's a complete example of the download clients section in your `config.toml`:
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[torrents]
# qBittorrent configuration
[torrents.qbittorrent]
@@ -87,14 +85,12 @@ Here's a complete example of the download clients section in your `config.toml`:
port = 8080
api_key = "your_sabnzbd_api_key"
```
{% endcode %}
## Docker Compose Integration
When using Docker Compose, make sure your download clients are accessible from the MediaManager backend:
{% code title="docker-compose.yml" %}
```yaml
```yaml title="docker-compose.yml"
services:
# MediaManager backend
backend:
@@ -121,12 +117,9 @@ services:
- ./data/usenet:/downloads
# ... other configuration ...
```
{% endcode %}
{% hint style="warning" %}
You should enable only one BitTorrent and only one Usenet Download Client at any time.
{% endhint %}
!!! warning
You should enable only one BitTorrent and only one Usenet Download Client at any time.
{% hint style="info" %}
Make sure the download directories in your download clients are accessible to MediaManager for proper file management and organization.
{% endhint %}
!!! info
Make sure the download directories in your download clients are accessible to MediaManager for proper file management and organization.

View File

@@ -13,9 +13,8 @@ Indexer settings are configured in the `[indexers]` section of your `config.toml
* `timeout_seconds`\
Timeout in seconds for requests to Prowlarr. Default is `60`.
{% hint style="warning" %}
Symptoms of timeouts are typically no search results ("No torrents found!") in conjunction with logs showing read timeouts.
{% endhint %}
!!! warning
Symptoms of timeouts are typically no search results ("No torrents found!") in conjunction with logs showing read timeouts.
<details>
@@ -50,8 +49,7 @@ DEBUG - media_manager.indexer.utils -
## Example Configuration
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[indexers]
[indexers.prowlarr]
enabled = true
@@ -66,4 +64,4 @@ api_key = "your_jackett_api_key"
indexers = ["1337x", "rarbg"]
timeout_seconds = 60
```
{% endcode %}

View File

@@ -57,8 +57,7 @@ Controls which emails receive notifications.
Here's a complete example of the notifications section in your `config.toml`:
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[notifications]
# SMTP settings for email notifications and password resets
[notifications.smtp_config]
@@ -91,8 +90,7 @@ Here's a complete example of the notifications section in your `config.toml`:
api_key = "your_pushover_api_key"
user = "your_pushover_user_key"
```
{% endcode %}
{% hint style="info" %}
You can enable multiple notification methods simultaneously. For example, you could have both email and Gotify notifications enabled at the same time.
{% endhint %}
!!! info
You can enable multiple notification methods simultaneously. For example, you could have both email and Gotify notifications enabled at the same time.

View File

@@ -17,9 +17,8 @@ Rules define how MediaManager scores releases based on their titles or indexer f
* Reject releases that do not meet certain criteria (e.g., non-freeleech releases).
* and more.
{% hint style="info" %}
The keywords and flags are compared case-insensitively.
{% endhint %}
!!! info
The keywords and flags are compared case-insensitively.
### Title Rules
@@ -38,8 +37,7 @@ Each title rule consists of:
Examples for Title Rules
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[[indexers.title_scoring_rules]]
name = "prefer_h265"
keywords = ["h265", "hevc", "x265"]
@@ -52,7 +50,6 @@ keywords = ["cam", "ts"]
score_modifier = -10000
negate = false
```
{% endcode %}
* The first rule increases the score for releases containing "h265", "hevc", or "x265".
* The second rule heavily penalizes releases containing "cam" or "ts".
@@ -76,8 +73,7 @@ Each indexer flag rule consists of:
Examples for Indexer Flag Rules
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[[indexers.indexer_flag_scoring_rules]]
name = "reject_non_freeleech"
flags = ["freeleech", "freeleech75"]
@@ -90,7 +86,6 @@ flags = ["nuked"]
score_modifier = -10000
negate = false
```
{% endcode %}
* The first rule penalizes releases that do not have the "freeleech" or "freeleech75" flag.
* The second rule penalizes releases that are marked as "nuked".
@@ -99,8 +94,7 @@ If `negate` is set to `true`, the `score_modifier` is applied only if none of th
## Example
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[[indexers.scoring_rule_sets]]
name = "default"
libraries = ["ALL_TV", "ALL_MOVIES"]
@@ -111,7 +105,6 @@ name = "strict_quality"
libraries = ["ALL_MOVIES"]
rule_names = ["prefer_h265", "avoid_cam", "reject_non_freeleech"]
```
{% endcode %}
## Libraries
@@ -127,9 +120,8 @@ You can use special library names in your rulesets:
This allows you to set global rules for all TV or movie content, or provide fallback rules for uncategorized media.
{% hint style="info" %}
You don't need to create lots of libraries with different directories, multiple libraries can share the same directory. You can set multiple (unlimited) libraries to the default directory `/data/movies` or `/data/tv` and use different rulesets with them.
{% endhint %}
!!! info
You don't need to create lots of libraries with different directories, multiple libraries can share the same directory. You can set multiple (unlimited) libraries to the default directory `/data/movies` or `/data/tv` and use different rulesets with them.
## Relation to Sonarr/Radarr Profiles