diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..b57d81a --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,51 @@ +name: Publish docs via GitHub Pages +on: + push: + branches: + - master + tags: + - v* + +permissions: + contents: write + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + + - uses: actions/setup-python@v5 + with: + python-version: 3.14 + + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + + - uses: actions/cache@v4 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + + - name: Install dependencies + run: pip install mkdocs-material mike + + - name: Deploy (master) + if: github.ref == 'refs/heads/master' + run: | + mike deploy --push --update-aliases master + + - name: Deploy (tag) + if: startsWith(github.ref, 'refs/tags/v') + run: | + version=${GITHUB_REF#refs/tags/} + mike deploy --push --update-aliases $version latest --title "$version" + diff --git a/.gitignore b/.gitignore index 7d1dc03..68df76c 100644 --- a/.gitignore +++ b/.gitignore @@ -49,5 +49,5 @@ __pycache__ # Postgres /postgres -# Node modules -/node_modules/* +# MkDocs +site/ diff --git a/README.md b/README.md index 13ea2cd..5cb9491 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@
- Logo + Logo

MediaManager

diff --git a/docker-compose.dev.yaml b/docker-compose.dev.yaml index 5b7d60f..6b9337d 100644 --- a/docker-compose.dev.yaml +++ b/docker-compose.dev.yaml @@ -56,6 +56,15 @@ services: - ./web:/app depends_on: - mediamanager + docs: + image: squidfunk/mkdocs-material:9 + container_name: mediamanager-docs + volumes: + - .:/docs + ports: + - "9000:9000" + command: serve -w /docs -a 0.0.0.0:9000 + # ---------------------------- # Additional services can be uncommented and configured as needed @@ -130,17 +139,17 @@ services: # ports: # - 8081:8080 # restart: unless-stopped -# jackett: -# image: lscr.io/linuxserver/jackett:latest -# container_name: jackett -# environment: -# - PUID=1000 -# - PGID=1000 -# - TZ=Etc/UTC -# - AUTO_UPDATE=true -# volumes: -# - ./res/jackett/data:/config -# - ./res/jackett/torrents:/downloads -# ports: -# - 9117:9117 -# restart: unless-stopped + jackett: + image: lscr.io/linuxserver/jackett:latest + container_name: jackett + environment: + - PUID=1000 + - PGID=1000 + - TZ=Etc/UTC + - AUTO_UPDATE=true + volumes: + - ./res/jackett/data:/config + - ./res/jackett/torrents:/downloads + ports: + - 9117:9117 + restart: unless-stopped diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 3fde369..0000000 --- a/docs/README.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: - width: default - title: - visible: true - description: - visible: true - tableOfContents: - visible: true - outline: - visible: false - pagination: - visible: true - metadata: - visible: true ---- - -# MediaManager - -MediaManager is the modern, easy-to-use successor to the fragmented "Arr" stack. Manage, discover, and automate your TV and movie collection in a single, simple interface. - -_Replaces Sonarr, Radarr, Seerr, and more._ - -### Quick Links - -
Installation Guideinstallation
Configurationconfiguration
Developer Guidedeveloper-guide.md
Troubleshootingtroubleshooting.md
Advanced Featuresadvanced-features
Import Existing Mediaimporting-existing-media.md
- -## Support MediaManager & Maximilian Dorninger - -
Cover image
Sponsor me on GitHub Sponsors :)https://github.com/sponsors/maxdorninger
Buy me a coffee :)https://buymeacoffee.com/maxdorninger
- -### MediaManager Sponsors - -
SponsorCover image
Aljaž Mur Erženhttps://fosstodon.org/@aljazmerzenhttps://github.com/aljazerzen.png
Luis Rodriguezhttps://github.com/ldrrphttps://github.com/ldrrp.png
Brandon P.https://github.com/brandon-dacribhttps://github.com/brandon-dacrib.png
SeimusShttps://github.com/SeimusShttps://github.com/SeimusS.png
HadrienKerlerohttps://github.com/HadrienKerlerohttps://github.com/HadrienKerlero.png
keyxmakerxhttps://github.com/keyxmakerxhttps://github.com/keyxmakerx.png
LITUATUIhttps://github.com/LITUATUIhttps://github.com/LITUATUI.png
Nicolashttps://buymeacoffee.com/maxdorningerhttps://cdn.buymeacoffee.com/uploads/profile_pictures/default/v2/B6CDBD/NI.png
Joshhttps://buymeacoffee.com/maxdorningerhttps://cdn.buymeacoffee.com/uploads/profile_pictures/default/v2/DEBBB9/JO.png
PuppiestDoggohttps://buymeacoffee.com/maxdorningerhttps://cdn.buymeacoffee.com/uploads/profile_pictures/2025/11/2VeQ8sTGPhj4tiLy.jpg
Seferinohttps://github.com/seferino-fernandezhttps://avatars.githubusercontent.com/u/5546622
Powered by DigitalOceanhttps://m.do.co/c/4edf05429dcahttps://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_vertical_blue.svg
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md deleted file mode 100644 index 0a09182..0000000 --- a/docs/SUMMARY.md +++ /dev/null @@ -1,33 +0,0 @@ -# Table of contents - -* [MediaManager](README.md) -* [Installation Guide](installation/README.md) - * [Docker Compose](installation/docker.md) - * [Nix Flakes \[Community\]](installation/flakes.md) -* [Importing existing media](importing-existing-media.md) -* [Usage](usage.md) -* [Configuration](configuration/README.md) - * [Backend](configuration/backend.md) - * [Authentication](configuration/authentication.md) - * [Database](configuration/database.md) - * [Download Clients](configuration/download-clients.md) - * [Indexers](configuration/indexers.md) - * [Scoring Rulesets](configuration/scoring-rulesets.md) - * [Notifications](configuration/notifications.md) - * [Custom Libraries](configuration/custom-libraries.md) - * [Logging](configuration/logging.md) -* [Advanced Features](advanced-features/README.md) - * [qBittorrent Category](advanced-features/qbittorrent-category.md) - * [URL Prefix](advanced-features/url-prefix.md) - * [Metadata Provider Configuration](advanced-features/metadata-provider-configuration.md) - * [Custom port](advanced-features/custom-port.md) - * [Follow symlinks in frontend files](advanced-features/follow-symlinks-in-frontend-files.md) - * [Disable startup ascii art](advanced-features/disable-startup-ascii-art.md) -* [Troubleshooting](troubleshooting.md) -* [API Reference](api-reference.md) -* [Screenshots](screenshots.md) - -## Contributing to MediaManager - -* [Developer Guide](contributing-to-mediamanager/developer-guide.md) -* [Documentation](contributing-to-mediamanager/documentation.md) diff --git a/docs/advanced-features/README.md b/docs/advanced-features/README.md deleted file mode 100644 index b44c6f7..0000000 --- a/docs/advanced-features/README.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -description: >- - The features in this section are not required to run MediaManager and serve - their purpose in very specific environments, but they can enhance your - experience and provide additional functionality. ---- - -# Advanced Features - diff --git a/docs/advanced-features/follow-symlinks-in-frontend-files.md b/docs/advanced-features/follow-symlinks-in-frontend-files.md index 4e7faad..0852c94 100644 --- a/docs/advanced-features/follow-symlinks-in-frontend-files.md +++ b/docs/advanced-features/follow-symlinks-in-frontend-files.md @@ -7,8 +7,6 @@ MediaManager can be configured to follow symlinks when serving frontend files. T * `FRONTEND_FOLLOW_SYMLINKS`\ Set this environment variable to `true` to follow symlinks when serving frontend files. Default is `false`. -{% code title=".env" %} -```bash +```bash title=".env" FRONTEND_FOLLOW_SYMLINKS=true ``` -{% endcode %} diff --git a/docs/advanced-features/metadata-provider-configuration.md b/docs/advanced-features/metadata-provider-configuration.md index 2444f03..05ebca6 100644 --- a/docs/advanced-features/metadata-provider-configuration.md +++ b/docs/advanced-features/metadata-provider-configuration.md @@ -8,9 +8,8 @@ Metadata provider settings are configured in the `[metadata]` section of your `c TMDB (The Movie Database) is the primary metadata provider for MediaManager. It provides detailed information about movies and TV shows. -{% hint style="info" %} -Other software like Jellyfin use TMDB as well, so there won't be any metadata discrepancies. -{% endhint %} +!!! info + Other software like Jellyfin use TMDB as well, so there won't be any metadata discrepancies. * `tmdb_relay_url`\ URL of the TMDB relay (MetadataRelay). Default is `https://metadata-relay.dorninger.co/tmdb`. Example: `https://your-own-relay.example.com/tmdb`. @@ -19,24 +18,21 @@ Other software like Jellyfin use TMDB as well, so there won't be any metadata di * `default_language`\ TMDB language parameter used when searching and adding. Default is `en`. Format: ISO 639-1 (2 letters). -{% hint style="warning" %} -`default_language` sets the TMDB `language` parameter when searching and adding TV shows and movies. If TMDB does not find a matching translation, metadata in the original language will be fetched with no option for a fallback language. It is therefore highly advised to only use "broad" languages. For most use cases, the default setting is safest. -{% endhint %} +!!! warning + `default_language` sets the TMDB `language` parameter when searching and adding TV shows and movies. If TMDB does not find a matching translation, metadata in the original language will be fetched with no option for a fallback language. It is therefore highly advised to only use "broad" languages. For most use cases, the default setting is safest. ### TVDB Settings (`[metadata.tvdb]`) -{% hint style="warning" %} -The TVDB might provide false metadata and doesn't support some features of MediaManager like showing overviews. Therefore, TMDB is the preferred metadata provider. -{% endhint %} +!!! warning + The TVDB might provide false metadata and doesn't support some features of MediaManager like showing overviews. Therefore, TMDB is the preferred metadata provider. * `tvdb_relay_url`\ URL of the TVDB relay (MetadataRelay). Default is `https://metadata-relay.dorninger.co/tvdb`. Example: `https://your-own-relay.example.com/tvdb`. ### MetadataRelay -{% hint style="info" %} -To use MediaManager you don't need to set up your own MetadataRelay, as the default relay hosted by the developer should be sufficient for most purposes. -{% endhint %} +!!! info + To use MediaManager you don't need to set up your own MetadataRelay, as the default relay hosted by the developer 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 if needed, but the default relay means you don't need to create accounts for API keys yourself. @@ -47,16 +43,14 @@ You might want to use your own relay if you want to avoid rate limits, protect y * Get a TMDB API key from [The Movie Database](https://www.themoviedb.org/settings/api) * Get a TVDB API key from [The TVDB](https://thetvdb.com/auth/register) -{% hint style="info" %} -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. -{% endhint %} +!!! info + 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. ### Example Configuration Here's a complete example of the metadata section in your `config.toml`: -{% code title="config.toml" %} -```toml +```toml title="config.toml" [metadata] # TMDB configuration [metadata.tmdb] @@ -66,8 +60,6 @@ Here's a complete example of the metadata section in your `config.toml`: [metadata.tvdb] tvdb_relay_url = "https://metadata-relay.dorninger.co/tvdb" ``` -{% endcode %} -{% hint style="info" %} -In most cases, you can simply use the default values and don't need to specify these settings in your config file at all. -{% endhint %} +!!! info + In most cases, you can simply use the default values and don't need to specify these settings in your config file at all. diff --git a/docs/advanced-features/qbittorrent-category.md b/docs/advanced-features/qbittorrent-category.md index fba972f..6656f92 100644 --- a/docs/advanced-features/qbittorrent-category.md +++ b/docs/advanced-features/qbittorrent-category.md @@ -9,10 +9,8 @@ Use the following variables to customize behavior: * `torrents.qbittorrent.category_save_path`\ Save path for the category in qBittorrent. By default, no subdirectory is used. Example: `/data/torrents/MediaManager`. -{% hint style="info" %} -qBittorrent saves torrents to the path specified by `torrents.qbittorrent.category_save_path`, so it must be a valid path that qBittorrent can write to. -{% endhint %} +!!! info + qBittorrent saves torrents to the path specified by `torrents.qbittorrent.category_save_path`, so it must be a valid path that qBittorrent can write to. -{% hint style="warning" %} -For MediaManager to successfully import torrents, you must add the subdirectory to the `misc.torrent_directory` variable. -{% endhint %} +!!! warning + For MediaManager to successfully import torrents, you must add the subdirectory to the `misc.torrent_directory` variable. diff --git a/docs/advanced-features/url-prefix.md b/docs/advanced-features/url-prefix.md index 576d249..4021bf5 100644 --- a/docs/advanced-features/url-prefix.md +++ b/docs/advanced-features/url-prefix.md @@ -6,23 +6,20 @@ In order to run it on a prefixed path, like `maxdorninger.github.io/media`, the In short, clone the repository, then run: -{% code title="Build Docker image" %} -```none +```none title="Build Docker image" docker build \ --build-arg BASE_PATH=/media \ --build-arg VERSION=my-custom-version \ -t MediaManager:my-custom-version \ -f Dockerfile . ``` -{% endcode %} You also need to set the `BASE_PATH` environment variable at runtime in `docker-compose.yaml`: * `BASE_PATH`\ Base path prefix MediaManager is served under. Example: `/media`. This must match the `BASE_PATH` build arg. -{% code title="docker-compose.yaml (excerpt)" %} -```yaml +```yaml title="docker-compose.yaml (excerpt)" services: mediamanager: image: MediaManager:my-custom-version @@ -32,10 +29,8 @@ services: BASE_PATH: /media ... ``` -{% endcode %} -{% hint style="info" %} -Make sure to include the base path in the `frontend_url` field in the config file. See [Backend](../configuration/backend.md). -{% endhint %} +!!! info + Make sure to include the base path in the `frontend_url` field in the config file. See [Backend](../configuration/backend.md). Finally, ensure that whatever reverse proxy you're using leaves the incoming path unchanged; that is, you should not strip the `/media` from `/media/web/`. diff --git a/docs/api-reference.md b/docs/api-reference.md index 414f52d..3ee4d48 100644 --- a/docs/api-reference.md +++ b/docs/api-reference.md @@ -1,8 +1,7 @@ # API Reference -{% hint style="info" %} -Media Manager's backend is built with FastAPI, which automatically generates interactive API documentation. -{% endhint %} +!!! info + Media Manager's backend is built with FastAPI, which automatically generates interactive API documentation. * Swagger UI (typically available at `http://localhost:8000/docs`) * ReDoc (typically available at `http://localhost:8000/redoc`) diff --git a/docs/.gitbook/assets/2VeQ8sTGPhj4tiLy.jpg b/docs/assets/assets/2VeQ8sTGPhj4tiLy.jpg similarity index 100% rename from docs/.gitbook/assets/2VeQ8sTGPhj4tiLy.jpg rename to docs/assets/assets/2VeQ8sTGPhj4tiLy.jpg diff --git a/docs/.gitbook/assets/5546622 b/docs/assets/assets/5546622 similarity index 100% rename from docs/.gitbook/assets/5546622 rename to docs/assets/assets/5546622 diff --git a/docs/.gitbook/assets/HadrienKerlero.png b/docs/assets/assets/HadrienKerlero.png similarity index 100% rename from docs/.gitbook/assets/HadrienKerlero.png rename to docs/assets/assets/HadrienKerlero.png diff --git a/docs/.gitbook/assets/JO.png b/docs/assets/assets/JO.png similarity index 100% rename from docs/.gitbook/assets/JO.png rename to docs/assets/assets/JO.png diff --git a/docs/.gitbook/assets/LITUATUI.png b/docs/assets/assets/LITUATUI.png similarity index 100% rename from docs/.gitbook/assets/LITUATUI.png rename to docs/assets/assets/LITUATUI.png diff --git a/docs/.gitbook/assets/NI.png b/docs/assets/assets/NI.png similarity index 100% rename from docs/.gitbook/assets/NI.png rename to docs/assets/assets/NI.png diff --git a/docs/.gitbook/assets/SeimusS.png b/docs/assets/assets/SeimusS.png similarity index 100% rename from docs/.gitbook/assets/SeimusS.png rename to docs/assets/assets/SeimusS.png diff --git a/docs/.gitbook/assets/authentik redirect url example.png b/docs/assets/assets/authentik redirect url example.png similarity index 100% rename from docs/.gitbook/assets/authentik redirect url example.png rename to docs/assets/assets/authentik redirect url example.png diff --git a/docs/.gitbook/assets/bmc-button.png b/docs/assets/assets/bmc-button.png similarity index 100% rename from docs/.gitbook/assets/bmc-button.png rename to docs/assets/assets/bmc-button.png diff --git a/docs/.gitbook/assets/bmc-logo-yellow.png b/docs/assets/assets/bmc-logo-yellow.png similarity index 100% rename from docs/.gitbook/assets/bmc-logo-yellow.png rename to docs/assets/assets/bmc-logo-yellow.png diff --git a/docs/.gitbook/assets/brandon dacrib.png b/docs/assets/assets/brandon dacrib.png similarity index 100% rename from docs/.gitbook/assets/brandon dacrib.png rename to docs/assets/assets/brandon dacrib.png diff --git a/docs/.gitbook/assets/e93602705171fd0a.jpg b/docs/assets/assets/e93602705171fd0a.jpg similarity index 100% rename from docs/.gitbook/assets/e93602705171fd0a.jpg rename to docs/assets/assets/e93602705171fd0a.jpg diff --git a/docs/.gitbook/assets/image.png b/docs/assets/assets/image.png similarity index 100% rename from docs/.gitbook/assets/image.png rename to docs/assets/assets/image.png diff --git a/docs/.gitbook/assets/keyxmakerx.png b/docs/assets/assets/keyxmakerx.png similarity index 100% rename from docs/.gitbook/assets/keyxmakerx.png rename to docs/assets/assets/keyxmakerx.png diff --git a/docs/.gitbook/assets/ldrrp.png b/docs/assets/assets/ldrrp.png similarity index 100% rename from docs/.gitbook/assets/ldrrp.png rename to docs/assets/assets/ldrrp.png diff --git a/docs/.gitbook/assets/screenshot dashboard.png b/docs/assets/assets/screenshot dashboard.png similarity index 100% rename from docs/.gitbook/assets/screenshot dashboard.png rename to docs/assets/assets/screenshot dashboard.png diff --git a/docs/.gitbook/assets/screenshot download season.png b/docs/assets/assets/screenshot download season.png similarity index 100% rename from docs/.gitbook/assets/screenshot download season.png rename to docs/assets/assets/screenshot download season.png diff --git a/docs/.gitbook/assets/screenshot login.png b/docs/assets/assets/screenshot login.png similarity index 100% rename from docs/.gitbook/assets/screenshot login.png rename to docs/assets/assets/screenshot login.png diff --git a/docs/.gitbook/assets/screenshot request season.png b/docs/assets/assets/screenshot request season.png similarity index 100% rename from docs/.gitbook/assets/screenshot request season.png rename to docs/assets/assets/screenshot request season.png diff --git a/docs/.gitbook/assets/screenshot settings.png b/docs/assets/assets/screenshot settings.png similarity index 100% rename from docs/.gitbook/assets/screenshot settings.png rename to docs/assets/assets/screenshot settings.png diff --git a/docs/.gitbook/assets/screenshot tv dashboard.png b/docs/assets/assets/screenshot tv dashboard.png similarity index 100% rename from docs/.gitbook/assets/screenshot tv dashboard.png rename to docs/assets/assets/screenshot tv dashboard.png diff --git a/docs/.gitbook/assets/screenshot tv torrents.png b/docs/assets/assets/screenshot tv torrents.png similarity index 100% rename from docs/.gitbook/assets/screenshot tv torrents.png rename to docs/assets/assets/screenshot tv torrents.png diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg new file mode 100644 index 0000000..b551d03 --- /dev/null +++ b/docs/assets/logo.svg @@ -0,0 +1,158 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/configuration/README.md b/docs/configuration/README.md index 55f4399..fe75363 100644 --- a/docs/configuration/README.md +++ b/docs/configuration/README.md @@ -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. diff --git a/docs/configuration/authentication.md b/docs/configuration/authentication.md index d21f006..aba5656 100644 --- a/docs/configuration/authentication.md +++ b/docs/configuration/authentication.md @@ -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 %} + diff --git a/docs/configuration/backend.md b/docs/configuration/backend.md index aaa7a31..eb8bff6 100644 --- a/docs/configuration/backend.md +++ b/docs/configuration/backend.md @@ -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. diff --git a/docs/configuration/custom-libraries.md b/docs/configuration/custom-libraries.md index 791b1ad..5d3b72e 100644 --- a/docs/configuration/custom-libraries.md +++ b/docs/configuration/custom-libraries.md @@ -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 diff --git a/docs/configuration/database.md b/docs/configuration/database.md index 31f364a..a108b62 100644 --- a/docs/configuration/database.md +++ b/docs/configuration/database.md @@ -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. diff --git a/docs/configuration/download-clients.md b/docs/configuration/download-clients.md index 085c8f0..6b7e228 100644 --- a/docs/configuration/download-clients.md +++ b/docs/configuration/download-clients.md @@ -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. diff --git a/docs/configuration/indexers.md b/docs/configuration/indexers.md index e05fe15..fc85b42 100644 --- a/docs/configuration/indexers.md +++ b/docs/configuration/indexers.md @@ -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.
@@ -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 %} + diff --git a/docs/configuration/notifications.md b/docs/configuration/notifications.md index 03895d5..39e5450 100644 --- a/docs/configuration/notifications.md +++ b/docs/configuration/notifications.md @@ -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. diff --git a/docs/configuration/scoring-rulesets.md b/docs/configuration/scoring-rulesets.md index 6509869..6a8933a 100644 --- a/docs/configuration/scoring-rulesets.md +++ b/docs/configuration/scoring-rulesets.md @@ -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 diff --git a/docs/contributing-to-mediamanager/developer-guide.md b/docs/contributing-to-mediamanager/developer-guide.md index 68bf1c9..8210d51 100644 --- a/docs/contributing-to-mediamanager/developer-guide.md +++ b/docs/contributing-to-mediamanager/developer-guide.md @@ -10,7 +10,7 @@ description: >- * `media_manager/`: Backend FastAPI application * `web/`: Frontend SvelteKit application -* `docs/`: Documentation (GitBook) +* `docs/`: Documentation (MkDocs) * `metadata_relay/`: Metadata relay service, also FastAPI ## Special Dev Configuration @@ -44,9 +44,8 @@ MediaManager uses various environment variables for configuration. In the Docker * `DISABLE_FRONTEND_MOUNT`\ When `TRUE`, disables mounting built frontend files (allows separate frontend container). -{% hint style="info" %} -This is automatically set in `docker-compose.dev.yaml` to enable the separate frontend development container -{% endhint %} +!!! info + This is automatically set in `docker-compose.dev.yaml` to enable the separate frontend development container #### Configuration Files @@ -105,10 +104,9 @@ This means when your browser makes a request to `http://localhost:5173/api/v1/tv ### Setting up the full development environment with Docker (Recommended) -This is the easiest and recommended way to get started. Everything runs in Docker with hot-reloading enabled. -{% stepper %} -{% step %} + + ### Prepare config files Create config directory (only needed on first run) and copy example config files: @@ -118,9 +116,9 @@ mkdir -p res/config # Only needed on first run cp config.dev.toml res/config/config.toml cp web/.env.example web/.env ``` -{% endstep %} -{% step %} + + ### Start all services Recommended: Use make commands for easy development @@ -135,9 +133,9 @@ Alternative: Use docker compose directly (if make is not available) ```bash docker compose -f docker-compose.dev.yaml up ``` -{% endstep %} -{% step %} + + ### Access the application * Frontend (with HMR): http://localhost:5173 @@ -151,12 +149,10 @@ Now you can edit code and see changes instantly: * Edit Python files → Backend auto-reloads * Edit Svelte/TypeScript files → Frontend HMR updates in browser * Edit config.toml → Changes apply immediately -{% endstep %} -{% endstepper %} -{% hint style="info" %} -Run `make help` to see all available development commands including `make down`, `make logs`, `make app` (shell into backend), and more. -{% endhint %} + +!!! info + Run `make help` to see all available development commands including `make down`, `make logs`, `make app` (shell into backend), and more. ## Setting up the backend development environment (Local) @@ -217,18 +213,17 @@ ruff check . ## Setting up the frontend development environment (Local, Optional) -Using the Docker setup above is recommended. This section is for those who prefer to run the frontend locally outside of Docker. -{% stepper %} -{% step %} + + ### Clone & change dir 1. Clone the repository 2. cd into repo root 3. cd into `web` directory -{% endstep %} -{% step %} + + ### Install Node.js (example using nvm-windows) I used nvm-windows: @@ -243,9 +238,9 @@ If using PowerShell you may need: ```powershell Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser ``` -{% endstep %} -{% step %} + + ### Create .env for frontend ```bash @@ -253,18 +248,18 @@ cp .env.example .env ``` Update `PUBLIC_API_URL` if your backend is not at `http://localhost:8000` -{% endstep %} -{% step %} + + ### Install dependencies and run dev server ```bash npm install npm run dev ``` -{% endstep %} -{% step %} + + ### Format & lint * Format: @@ -278,12 +273,10 @@ npm run format ```bash npm run lint ``` -{% endstep %} -{% endstepper %} -{% hint style="info" %} -If running frontend locally, make sure to add `http://localhost:5173` to the `cors_urls` in your backend config file. -{% endhint %} + +!!! info + If running frontend locally, make sure to add `http://localhost:5173` to the `cors_urls` in your backend config file. ## Troubleshooting diff --git a/docs/contributing-to-mediamanager/documentation.md b/docs/contributing-to-mediamanager/documentation.md index 94dd103..b3cae86 100644 --- a/docs/contributing-to-mediamanager/documentation.md +++ b/docs/contributing-to-mediamanager/documentation.md @@ -1,11 +1,14 @@ # Documentation -MediaManager currently uses GitBook for documentation. +MediaManager uses [MkDocs](https://www.mkdocs.org/) with +the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme for documentation. -The files for the documentation are in the \`/docs\` directory. They are \_mostly\_ standard markdown. +The files for the documentation are in the `/docs` directory. -Unfortunately GitBook doesn't provide a way to locally preview the documentation. Instead you can submit a PR with your proposed changes and a GitBook workflow will run which will provide a link to the preview. +To preview the documentation locally, you need to have mkdocs or Docker installed. -To access the preview just open the \`Details\` link. +## How to preview the documentation locally with docker -
+1. Run the mkdocs container in `docker-compose.dev.yaml` + +2. Open `http://127.0.0.1:9000/` in your browser. \ No newline at end of file diff --git a/docs/importing-existing-media.md b/docs/importing-existing-media.md index 2e30e02..87fc3f2 100644 --- a/docs/importing-existing-media.md +++ b/docs/importing-existing-media.md @@ -23,9 +23,8 @@ Here is an example, using these rules: If your folder structure is in the correct format, you can start importing. To do this, log in as an administrator and go to the TV/movie dashboard. -{% hint style="info" %} -After importing, MediaManager will automatically prefix the old root TV show/movie folders with a dot to mark them as "imported". -{% endhint %} +!!! info + After importing, MediaManager will automatically prefix the old root TV show/movie folders with a dot to mark them as "imported". So after importing, the directory would look like this (using the above directory structure): diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..0e0b6b4 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,2 @@ +--8<-- "README.md" + diff --git a/docs/installation/README.md b/docs/installation/README.md index c8b896a..112b456 100644 --- a/docs/installation/README.md +++ b/docs/installation/README.md @@ -2,4 +2,5 @@ The recommended way to install and run Media Manager is using Docker and Docker Compose. Other installation methods are not officially supported, but listed here for convenience. -
Docker Compose (recommended)docker.md
Nix Flakes [Community]flakes.md
+[Docker Compose (recommended)](docker.md){ .md-button .md-button--primary } +[Nix Flakes [Community]](flakes.md){ .md-button } diff --git a/docs/installation/docker.md b/docs/installation/docker.md index ca4e5c7..f7672a6 100644 --- a/docs/installation/docker.md +++ b/docs/installation/docker.md @@ -9,8 +9,8 @@ Follow these steps to get MediaManager running with Docker Compose: -{% stepper %} -{% step %} + + #### Get the docker-compose file Download the `docker-compose.yaml` from the MediaManager repo: @@ -18,9 +18,9 @@ Download the `docker-compose.yaml` from the MediaManager repo: ```bash wget -O docker-compose.yaml https://github.com/maxdorninger/MediaManager/releases/latest/download/docker-compose.yaml ``` -{% endstep %} -{% step %} + + #### Prepare configuration directory and example config Create a config directory and download the example configuration: @@ -29,15 +29,15 @@ Create a config directory and download the example configuration: mkdir config wget -O ./config/config.toml https://github.com/maxdorninger/MediaManager/releases/latest/download/config.example.toml ``` -{% endstep %} -{% step %} + + #### Edit configuration -You probably need to edit the `config.toml` file in the `./config` directory to suit your environment and preferences. [How to configure MediaManager.](configuration/) -{% endstep %} +You probably need to edit the `config.toml` file in the `./config` directory to suit your environment and preferences. [How to configure MediaManager.](../configuration/README.md) + + -{% step %} #### Start MediaManager Bring up the stack: @@ -45,16 +45,15 @@ Bring up the stack: ```bash docker compose up -d ``` -{% endstep %} -{% endstepper %} + + * Upon first run, MediaManager will create a default `config.toml` file in the `./config` directory (if not already present). * Upon first run, MediaManager will also create a default admin user. The credentials of the default admin user will be printed in the logs of the container — it's recommended to change the password of this user after the first login. -* [For more information on the available configuration options, see the Configuration section of the documentation.](configuration/) +* [For more information on the available configuration options, see the Configuration section of the documentation.](../configuration/README.md) -{% 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. ## Docker Images @@ -70,9 +69,8 @@ MetadataRelay images are also available on both registries: From v1.12.1 onwards, both MediaManager and MetadataRelay images are available on both Quay.io and GHCR. The reason for the switch to Quay.io as the primary image registry is due to [GHCR's continued slow performance.](https://github.com/orgs/community/discussions/173607) -{% hint style="info" %} -You can use either the Quay.io or GHCR images interchangeably, as they are built from the same source and the tags are the same across both registries. -{% endhint %} +!!! info + You can use either the Quay.io or GHCR images interchangeably, as they are built from the same source and the tags are the same across both registries. ### Tags diff --git a/docs/installation/flakes.md b/docs/installation/flakes.md index 56f012d..d233210 100644 --- a/docs/installation/flakes.md +++ b/docs/installation/flakes.md @@ -1,11 +1,9 @@ # Nix Flakes -{% hint style="note" %} -This is a community contribution and not officially supported by the MediaManager team, but included here for convenience. -{% endhint %} +!!! note + This is a community contribution and not officially supported by the MediaManager team, but included here for convenience. -*Please report issues with this method at the [corresponding GitHub repository](https://github.com/strangeglyph/mediamanager-nix).* - + *Please report issues with this method at the [corresponding GitHub repository](https://github.com/strangeglyph/mediamanager-nix).* ## Prerequisites @@ -64,12 +62,11 @@ The host and port that MediaManager listens on can be set using `services.media- To configure MediaManager, use `services.media-manager.settings`, which follows the same structure as the MediaManager `config.toml`. To provision secrets, set `services.media-manager.environmentFile` to a protected file, for example one provided by [agenix](https://github.com/ryantm/agenix) or [sops-nix](https://github.com/Mic92/sops-nix). -See [Configuration](Configuration.md#configuring-secrets) for guidance on using environment variables. +See [Configuration](../configuration/README.md#configuring-secrets) for guidance on using environment variables. -{% hint style="warning" %} - Do not place secrets in the nix store, as it is world-readable. -{% endhint %} +!!! warning + Do not place secrets in the nix store, as it is world-readable. ## Automatic Postgres Setup diff --git a/docs/screenshots.md b/docs/screenshots.md index ba41865..b7f2de3 100644 --- a/docs/screenshots.md +++ b/docs/screenshots.md @@ -1,7 +1,6 @@ # Screenshots -{% hint style="info" %} -MediaManager also supports darkmode! -{% endhint %} +!!! info + MediaManager also supports darkmode! -![screenshot-dashboard.png](<.gitbook/assets/screenshot dashboard.png>) ![screenshot-tv-dashboard.png](<.gitbook/assets/screenshot tv dashboard.png>) ![screenshot-download-season.png](<.gitbook/assets/screenshot download season.png>) ![screenshot-request-season.png](<.gitbook/assets/screenshot request season.png>) ![screenshot-tv-torrents.png](<.gitbook/assets/screenshot tv torrents.png>) ![screenshot-settings.png](<.gitbook/assets/screenshot settings.png>) ![screenshot-login.png](<.gitbook/assets/screenshot login.png>) +![screenshot-dashboard.png]() ![screenshot-tv-dashboard.png]() ![screenshot-download-season.png]() ![screenshot-request-season.png]() ![screenshot-tv-torrents.png]() ![screenshot-settings.png]() ![screenshot-login.png]() diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 024b176..0dbc886 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -1,8 +1,7 @@ # Troubleshooting -{% hint style="info" %} -Always check the container and browser logs for more specific error messages -{% endhint %} +!!! info + Always check the container and browser logs for more specific error messages
@@ -60,10 +59,9 @@ Switch to advanced tabTry switching to the advanced tab when searching for torre #### Possible Fixes: * [Unable to pull image from GitHub Container Registry (Stack Overflow)](https://stackoverflow.com/questions/74656167/unable-to-pull-image-from-github-container-registry-ghcr) -* [Try pulling the image from Quay.io](/broken/pages/09241b2fcda5d337e8878e4052f4634fe2902d10#mediamanager-and-metadatarelay-docker-images) +* [Try pulling the image from Quay.io](installation/docker.md#docker-images)
-{% hint style="info" %} -If it still doesn't work, [please open an Issue.](https://github.com/maxdorninger/MediaManager/issues) It is possible that a bug is causing the issue. -{% endhint %} +!!! info + If it still doesn't work, [please open an Issue.](https://github.com/maxdorninger/MediaManager/issues) It is possible that a bug is causing the issue. diff --git a/docs/usage.md b/docs/usage.md deleted file mode 100644 index adee3a6..0000000 --- a/docs/usage.md +++ /dev/null @@ -1,133 +0,0 @@ -# Usage - -If you are coming from Radarr or Sonarr you will find that MediaManager does things a bit differently. Instead of completely automatically downloading and managing your media, MediaManager focuses on providing an easy-to-use interface to guide you through the process of finding and downloading media. Advanced features like multiple qualities of a show/movie necessitate such a paradigm shift. So here is a quick step-by-step guide to get you started: - -#### Downloading/Requesting a show - -{% stepper %} -{% step %} -### Add the show - -Add a show on the "Add Show" page. After adding the show you will be redirected to the show's page. -{% endstep %} - -{% step %} -### Request season(s) - -Click the "Request Season" button on the show's page. Select one or more seasons that you want to download. -{% endstep %} - -{% step %} -### Select qualities - -Select the "Min Quality" — the minimum resolution of the content to download.\ -Select the "Wanted Quality" — the **maximum** resolution of the content to download. -{% endstep %} - -{% step %} -### Submit request - -Click "Submit request". This is not the last step: an administrator must first approve your request for download. Only after approval will the requested content be downloaded. -{% endstep %} - -{% step %} -### Finished - -Congratulation! You've downloaded a show (after admin approval). -{% endstep %} -{% endstepper %} - -#### Requesting a show (as an admin) - -{% stepper %} -{% step %} -### Add the show - -Add a show on the "Add Show" page. After adding the show you will be redirected to the show's page. -{% endstep %} - -{% step %} -### Request season(s) - -Click the "Request Season" button on the show's page. Select one or more seasons that you want to download. -{% endstep %} - -{% step %} -### Select qualities - -Select the "Min Quality" — the minimum resolution of the content to download.\ -Select the "Wanted Quality" — the **maximum** resolution of the content to download. -{% endstep %} - -{% step %} -### Submit request (auto-approved) - -Click "Submit request". As an admin, your request will be automatically approved. -{% endstep %} - -{% step %} -### Finished - -Congratulation! You've downloaded a show. -{% endstep %} -{% endstepper %} - -#### Downloading a show (admin-only) - -You can only directly download a show if you are an admin! - -{% stepper %} -{% step %} -### Go to the show's page - -Open the show's page that contains the season you wish to download. -{% endstep %} - -{% step %} -### Start download - -Click the "Download Season" button. -{% endstep %} - -{% step %} -### Enter season number - -Enter the season number that you want to download. -{% endstep %} - -{% step %} -### Optional file path suffix - -Optionally select the "File Path Suffix". Note: **it needs to be unique per season per show!** -{% endstep %} - -{% step %} -### Choose torrent and download - -Click "Download" on the torrent that you want to download. -{% endstep %} - -{% step %} -### Finished - -Congratulation! You've downloaded a show. -{% endstep %} -{% endstepper %} - -#### Managing requests - -Users need their requests to be approved by an admin. To manage requests: - -{% stepper %} -{% step %} -### Open Requests page - -Go to the "Requests" page. -{% endstep %} - -{% step %} -### Approve, delete or modify - -From the Requests page you can approve, delete, or modify a user's request. -{% endstep %} -{% endstepper %} diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..8e6202f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,70 @@ +site_name: "MediaManager Documentation" +theme: + name: "material" + logo: "assets/logo.svg" + favicon: "assets/logo.svg" + features: + - navigation.sections + - navigation.expand + - navigation.indexes + - content.code.copy + - navigation.footer + palette: + - scheme: default + primary: indigo + accent: indigo + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - scheme: slate + primary: black + accent: black + toggle: + icon: material/brightness-4 + name: Switch to light mode + +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.superfences + - attr_list + - md_in_html + - pymdownx.snippets: + base_path: ["."] + +nav: + - Welcome: index.md + - Installation: + - installation/README.md + - Docker Compose: installation/docker.md + - Nix Flakes [Community]: installation/flakes.md + - Usage: + - Importing existing media: importing-existing-media.md + - Configuration: + - configuration/README.md + - Backend: configuration/backend.md + - Authentication: configuration/authentication.md + - Database: configuration/database.md + - Download Clients: configuration/download-clients.md + - Indexers: configuration/indexers.md + - Scoring Rulesets: configuration/scoring-rulesets.md + - Notifications: configuration/notifications.md + - Custom Libraries: configuration/custom-libraries.md + - Logging: configuration/logging.md + - Advanced Features: + - qBittorrent Category: advanced-features/qbittorrent-category.md + - URL Prefix: advanced-features/url-prefix.md + - Metadata Provider Configuration: advanced-features/metadata-provider-configuration.md + - Custom port: advanced-features/custom-port.md + - Follow symlinks in frontend files: advanced-features/follow-symlinks-in-frontend-files.md + - Disable startup ascii art: advanced-features/disable-startup-ascii-art.md + - Troubleshooting: troubleshooting.md + - API Reference: api-reference.md + - Screenshots: screenshots.md + - Contributing to MediaManager: + - Developer Guide: contributing-to-mediamanager/developer-guide.md + - Documentation: contributing-to-mediamanager/documentation.md + +extra: + version: + provider: mike