diff --git a/Writerside/images/screenshot-dashboard.png b/Writerside/images/screenshot-dashboard.png new file mode 100644 index 0000000..70eab00 Binary files /dev/null and b/Writerside/images/screenshot-dashboard.png differ diff --git a/Writerside/images/screenshot-download-season.png b/Writerside/images/screenshot-download-season.png new file mode 100644 index 0000000..535a55c Binary files /dev/null and b/Writerside/images/screenshot-download-season.png differ diff --git a/Writerside/images/screenshot-login.png b/Writerside/images/screenshot-login.png new file mode 100644 index 0000000..0c8956b Binary files /dev/null and b/Writerside/images/screenshot-login.png differ diff --git a/Writerside/images/screenshot-request-season.png b/Writerside/images/screenshot-request-season.png new file mode 100644 index 0000000..bfb08a2 Binary files /dev/null and b/Writerside/images/screenshot-request-season.png differ diff --git a/Writerside/images/screenshot-settings.png b/Writerside/images/screenshot-settings.png new file mode 100644 index 0000000..0991813 Binary files /dev/null and b/Writerside/images/screenshot-settings.png differ diff --git a/Writerside/images/screenshot-tv-dashboard.png b/Writerside/images/screenshot-tv-dashboard.png new file mode 100644 index 0000000..c80eb3e Binary files /dev/null and b/Writerside/images/screenshot-tv-dashboard.png differ diff --git a/Writerside/images/screenshot-tv-torrents.png b/Writerside/images/screenshot-tv-torrents.png new file mode 100644 index 0000000..2a6b944 Binary files /dev/null and b/Writerside/images/screenshot-tv-torrents.png differ diff --git a/Writerside/topics/configuration-backend.md b/Writerside/topics/configuration-backend.md index 9b1d666..624512d 100644 --- a/Writerside/topics/configuration-backend.md +++ b/Writerside/topics/configuration-backend.md @@ -66,16 +66,18 @@ These settings configure the integrations with external metadata providers like ### TMDB (The Movie Database) TMDB is the primary metadata provider for MediaManager. It provides detailed information about movies and TV shows. -Get an API key from [The Movie Database](https://www.themoviedb.org/settings/api) to use this provider. You can create -an account and generate a free API key in your account settings. + Other software like Jellyfin use TMDB as well, so there won't be any metadata discrepancies. -#### `TMDB_API_KEY` +#### `TMDB_RELAY_URL` -Your TMDB API key. +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) @@ -83,12 +85,36 @@ Your TMDB API key. 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. -Get an API key from [The TVDB](https://thetvdb.com/auth/register) to use this provider. You can create an account and +#### `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](https://www.themoviedb.org/settings/api). You can create +an account and generate a free API key in your account settings. + +Get an API key from [The TVDB](https://thetvdb.com/auth/register). You can create an account and generate a free API key in your account settings. -#### `TVDB_API_KEY` - -Your TVDB API key. + + 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 diff --git a/Writerside/topics/configuration-overview.md b/Writerside/topics/configuration-overview.md index 81cd87a..4fe8e1b 100644 --- a/Writerside/topics/configuration-overview.md +++ b/Writerside/topics/configuration-overview.md @@ -18,10 +18,3 @@ The recommended way to install and run Media Manager is using Docker and Docker * Configure the necessary environment variables in your `docker-compose.yaml` file. * For more information on the available configuration options, see the [Configuration section](Configuration.md) of the documentation. - - - It is good practice to put API keys and other sensitive information in a separate `.env` file and reference them in your - `docker-compose.yaml`. - - - diff --git a/Writerside/topics/introduction.md b/Writerside/topics/introduction.md index 7c4733c..55eb284 100644 --- a/Writerside/topics/introduction.md +++ b/Writerside/topics/introduction.md @@ -1,24 +1,27 @@ # MediaManager -## About MediaManager +MediaManager is modern software to manager your TV and movie library. It is designed to be a replacement for Sonarr, +Radarr, Overseer, and Jellyseer. +It supports TVDB and TMDB for metadata, supports OIDC and OAuth 2.0 for authentication and supports Prowlarr and +Jackett. +MediaManager is built first and foremost for deployment with Docker, making it easy to set up. -Media Manager is a comprehensive solution for organizing, discovering, and accessing your personal media library, -including TV shows and movies. It provides a modern web interface for easy management and integrates with various -services for metadata and torrents. +It also provides an API to interact with the software programmatically, allowing for automation and integration with +other services. -## Core Features +## Screenshots -* **Media Organization:** Efficiently manage your TV shows and movies. Keep track of what you have, what you've watched, - and what you want to watch. -* **Torrent Integration:** Seamlessly search for and manage torrents for your media files. -* **Metadata Fetching:** Automatically enriches your media library with detailed information, posters, and artwork from - metadata providers like TMDB and TVDB. -* **User Authentication:** Secure access to your media library with a robust authentication system, supporting: - * Username/Password (JWT and cookie-based sessions). - * OAuth 2.0 / OpenID Connect for integration with external identity providers (e.g., Authentik). -* **Web Interface:** A user-friendly frontend built with SvelteKit for browsing and managing your media. -* **API-driven:** A powerful FastAPI backend provides a comprehensive API for all functionalities. -* **Dockerized Deployment:** Easy to deploy and manage using Docker and Docker Compose. +![screenshot-dashboard.png](screenshot-dashboard.png) +![screenshot-tv-dashboard.png](screenshot-tv-dashboard.png) +![screenshot-download-season.png](screenshot-download-season.png) + +![screenshot-request-season.png](screenshot-request-season.png) + +![screenshot-tv-torrents.png](screenshot-tv-torrents.png) + +![screenshot-settings.png](screenshot-settings.png) + +![screenshot-login.png](screenshot-login.png) diff --git a/docker-compose.yaml b/docker-compose.yaml index 1757e0a..70195d2 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -14,7 +14,6 @@ services: - QBITTORRENT_USERNAME= - QBITTORRENT_PORT= - - TMDB_API_KEY= - CORS_URLS= - DB_HOST=db @@ -23,19 +22,23 @@ services: #- DB_PASSWORD= #- DB_DBNAME= + # generate a random string with "openssl rand -hex 32" - AUTH_TOKEN_SECRET= - - AUTH_ADMIN_EMAIL= - - FRONTEND_URL= - #- AUTH_SESSION_LIFETIME= - #- OPENID_ENABLED=TRUE + # this should be you email address + - AUTH_ADMIN_EMAIL= + + # this is the URL of your frontend, e.g. https://mediamanager.example.com + - FRONTEND_URL= + + #- OPENID_ENABLED=FALSE #- OPENID_CLIENT_ID= #- OPENID_CLIENT_SECRET= #- OPENID_CONFIGURATION_ENDPOINT= #- OPENID_NAME= + #- AUTH_SESSION_LIFETIME= #- API_BASE_PATH=/api/v1 - #- TVDB_API_KEY= #- DEVELOPMENT= volumes: diff --git a/web/src/routes/+page.svelte b/web/src/routes/+page.svelte index 3135bf6..0aa4414 100644 --- a/web/src/routes/+page.svelte +++ b/web/src/routes/+page.svelte @@ -1,11 +1,11 @@