Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scottgigawatt/duplex
Docker Utilities for Plex on Synology DSM 🍿
https://github.com/scottgigawatt/duplex
kometa notifiarr plex synology tautulli watchtower
Last synced: about 7 hours ago
JSON representation
Docker Utilities for Plex on Synology DSM 🍿
- Host: GitHub
- URL: https://github.com/scottgigawatt/duplex
- Owner: scottgigawatt
- License: apache-2.0
- Created: 2024-05-07T01:29:41.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-29T02:12:45.000Z (4 months ago)
- Last Synced: 2024-07-29T21:16:29.185Z (4 months ago)
- Topics: kometa, notifiarr, plex, synology, tautulli, watchtower
- Homepage:
- Size: 89.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Duplex 📺🚀
Duplex simplifies Plex Media Server management on Synology NAS by providing a Docker Compose configuration with essential tools and utilities.
## Overview 📋
The `docker-compose.yml` file in this repository configures Docker containers for managing a Plex Media Server on a Synology NAS. It includes tools for metadata management, photo cleaning, monitoring, and automated updates.
For more details on the Docker Compose configuration, refer to the [docker-compose.yml](docker-compose.yml) file in this repository.
## Included Tools 🛠️
| Tool | Description | More Info |
|-------------------------|--------------------------------------------------------------|---------------------------------------------------------------------------|
| **Kometa** ✨ | Manages Plex Media Server metadata. | [Kometa Info](https://kometa.wiki/en/nightly/) |
| **ImageMaid** 🧼 | Cleans Plex Media Server photos. | [ImageMaid Info](https://kometa.wiki/en/nightly/kometa/scripts/imagemaid/)|
| **Overlay Reset** 🧹 | Removes all overlays placed on a Plex Library. | [Kometa Overlay Reset Info](https://github.com/kometa-team/overlay-reset) |
| **PATTRMM** 📅 | Schedule and run media processing tasks. | [PATTRMM GitHub](https://github.com/insertdisc/pattrmm) |
| **Tautulli** 📊 | Monitors and tracks Plex Media Server usage. | [Tautulli GitHub](https://github.com/Tautulli/Tautulli/) |
| **Notifiarr** 🔔 | Provides notifications for various media server activities. | [Notifiarr GitHub](https://github.com/Notifiarr/notifiarr/) |
| **Watchtower** 🛠️ | Automatically updates Docker container base images. | [Watchtower GitHub](https://github.com/containrrr/watchtower) |
## Usage 🚀
### Starting the Service Stack
Follow these steps to start the Duplex service stack:
1. Clone this repository to your Synology NAS, including the submodules.
```bash
git clone --recurse-submodules https://github.com/yourusername/duplex.git
```
2. Navigate to the directory containing the `docker-compose.yml` file.
3. Open a terminal or SSH into your Synology NAS.
4. Run `docker-compose up -d` to start the containers in detached mode.
5. Access the services through their respective endpoints.
6. Configure services to connect to Plex using the gateway IP address of the Docker bridge network. Find this IP in `Container Manager -> Network` for DSM 7.2 and above.
### Managing Docker Config Environment Variables 🧩
The configurations for the main Docker Compose file, ImageMaid, and Overlay Reset are managed using `.env` files. The `example.env` files can be copied to `.env` and updated to change the behavior.
- Main Docker Compose: [example.env](example.env)
- ImageMaid: [config/imagemaid/example.env](config/imagemaid/example.env)
- Overlay Reset: [config/overlay-reset/example.env](config/overlay-reset/example.env)
Override these variables easily on the command line when starting the Docker Compose stack:
```bash
KOMETA_TAG="latest" docker-compose up -d
```
Adjust the values of these environment variables to your requirements.
### Managing the Project with DSM Container Manager 📦
To import this project into DSM 7.2 Container Manager's Project feature:
1. SSH into your Synology system.
2. Clone this repository, e.g. to `/volume1/docker/duplex`.
3. In Container Manager, click **Project** then **Create**.
4. Provide a title, e.g., **duplex**.
5. Set the path to the cloned repository.
6. Proceed through UI prompts to finish creating the project.
Refer to the official Synology documentation [here](https://kb.synology.com/en-id/DSM/help/ContainerManager/docker_project?version=7) for more on Container Manager Projects.
### Secure Access to Synology Applications 🔒
Use DSM 7 Reverse Proxy to configure secure access to Synology applications. Follow the guide [here](https://mariushosting.com/synology-how-to-use-reverse-proxy-on-dsm-7/) for DSM 7.
> **Note**: If you encounter "Socket closed" errors when accessing the DSM UI via reverse proxy and trying to open terminals for running containers, enable WebSocket for the reverse proxy record:
>
> 1. Go to `Control Panel -> Application Portal -> Reverse Proxy`.
> 2. Select `Edit` for your reverse proxy record.
> 3. Navigate to the `Custom Header` tab.
> 4. From the `Create` dropdown, select `WebSocket`.
> 5. Save the changes to resolve the issue.
## Environment Details 🖥️
Tested on Synology DS916+ running DSM 7.2.1-69057 Update 5, with Docker Compose v2.9.0-6413-g38f6acd.
## License 📄
Licensed under the Apache 2 License - see [LICENSE](LICENSE) for details.
---
Contribute or provide feedback to improve the Duplex repository. Happy Plexing! 🌟