https://github.com/scottgigawatt/wiki
MkDocs Material on Synology NAS 📋
https://github.com/scottgigawatt/wiki
docker-compose mkdocs mkdocs-material synology
Last synced: 3 months ago
JSON representation
MkDocs Material on Synology NAS 📋
- Host: GitHub
- URL: https://github.com/scottgigawatt/wiki
- Owner: scottgigawatt
- License: apache-2.0
- Created: 2024-05-25T01:12:01.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-08-10T23:00:11.000Z (11 months ago)
- Last Synced: 2025-08-11T01:03:09.165Z (11 months ago)
- Topics: docker-compose, mkdocs, mkdocs-material, synology
- Language: Makefile
- Homepage: https://scottgigawatt.github.io/wiki/
- Size: 6.26 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🌌 Star this repo — unlock the cosmic codex and map the constellations of forbidden knowledge.
─── ⛧ ───
⚡ Lost in the labyrinth or seeking the Oracle? Cross the River Styx and Enter 🔥HADES🔥.
# 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](https://www.mkdocs.org) and the [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) theme. It covers Synology setup, Plex configuration, and additional development projects available in my GitHub repository at [github.com/scottgigawatt](https://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](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)**: Checks for formatting issues.
- **[Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.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:
```bash
# Clone the repository
git clone git@github.com:scottgigawatt/wiki.git
cd wiki
# Start the local webserver
make start
```
The local server will be running at . 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.
1. Clone this repository.
1. In Container Manager, click **Project** then **Create**.
1. Provide a title, e.g., **mkdocs-material**.
1. Set the path to the cloned repository.
1. 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`.
> 1. Select `Edit` for your reverse proxy record.
> 1. Navigate to the `Custom Header` tab.
> 1. From the `Create` dropdown, select `WebSocket`.
> 1. Save the changes to resolve the issue.
## Environment Details
Tested on Synology DS916+ running DSM 7.2, with Docker Compose version v2.20.
## License
This project is licensed under the Apache 2 License - see the [LICENSE](LICENSE) file for details.
---
Contributions to improve the Synology Wiki are welcome. Please feel free to submit pull requests or provide feedback. Happy documenting!