Skip to content

scottgigawatt/duplex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

98 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

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 file in this repository.

Included Tools ๐Ÿ› ๏ธ

Tool Description More Info
Kometa โœจ Manages Plex Media Server metadata. Kometa Info
ImageMaid ๐Ÿงผ Cleans Plex Media Server photos. ImageMaid Info
Overlay Reset ๐Ÿงน Removes all overlays placed on a Plex Library. Kometa Overlay Reset Info
PATTRMM ๐Ÿ“… Schedule and run media processing tasks. PATTRMM GitHub
Tautulli ๐Ÿ“Š Monitors and tracks Plex Media Server usage. Tautulli GitHub
Notifiarr ๐Ÿ”” Provides notifications for various media server activities. Notifiarr GitHub
Watchtower ๐Ÿ› ๏ธ Automatically updates Docker container base images. Watchtower GitHub

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.

    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.

Override these variables easily on the command line when starting the Docker Compose stack:

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 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 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 for details.


Contribute or provide feedback to improve the Duplex repository. Happy Plexing! ๐ŸŒŸ

Releases

No releases published

Packages

No packages published