Synology Wiki

Welcome to the Synology Wiki! This repository serves as a centralized reference for my Synology setup and configuration, with a focus on Plex Media Server and various Plex maintenance utilities.

Overview

The documentation is built using MkDocs and the MkDocs Material theme. It covers Synology setup, Plex configuration, and additional development projects available in my GitHub repository at github.com/scottgigawatt.

Authoring and Editing

Editing Content

Documents are stored in the docs directory of this repository. You can edit them via the GitHub web UI or locally.

• To edit documents using the GitHub web UI, click the pencil icon at the top right of the page, make your changes in Markdown, add a commit message, and click "Commit changes".
• For a better authoring experience, use Visual Studio Code with recommended plugins:
  • markdownlint: Checks for formatting issues.
  • Markdown All in One: Offers shortcuts, table of contents generation, and enhanced preview features.

Managing Navigation

The left-hand navigation is defined in the mkdocs.yml file. To add a new menu item, edit the nav element in mkdocs.yml, ensuring proper indentation. Paths are relative to the docs/ directory.

Local Development

Using the Makefile

To build and start the webserver locally, follow these steps:

# Clone the repository
git clone [email protected]:scottgigawatt/wiki.git
cd wiki

# Start the local webserver
make start

The local server will be running at http://localhost:8800/scottgigawatt/wiki/. You can access it in your browser. The server will live reload your changes as you edit files. If you're on macOS, you can use make open to open the site in your default browser automatically.

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.
3. In Container Manager, click Project then Create.
4. Provide a title, e.g., mkdocs-material.
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 version v2.9.0-6413-g38f6acd.

License

This project is licensed under the Apache 2 License - see the LICENSE file for details.

---

Contributions to improve the Synology Wiki are welcome. Please feel free to submit pull requests or provide feedback. Happy documenting!