{"id":15017450,"url":"https://github.com/scottgigawatt/wiki","last_synced_at":"2026-03-14T04:07:58.784Z","repository":{"id":241349182,"uuid":"805610337","full_name":"scottgigawatt/wiki","owner":"scottgigawatt","description":"MkDocs Material on Synology NAS 📋","archived":false,"fork":false,"pushed_at":"2025-08-10T23:00:11.000Z","size":6559,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-11T01:03:09.165Z","etag":null,"topics":["docker-compose","mkdocs","mkdocs-material","synology"],"latest_commit_sha":null,"homepage":"https://scottgigawatt.github.io/wiki/","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scottgigawatt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-05-25T01:12:01.000Z","updated_at":"2025-08-10T22:59:55.000Z","dependencies_parsed_at":"2024-06-29T02:23:51.302Z","dependency_job_id":"8ba3756f-179c-423a-9802-896738c06e63","html_url":"https://github.com/scottgigawatt/wiki","commit_stats":{"total_commits":43,"total_committers":2,"mean_commits":21.5,"dds":"0.023255813953488413","last_synced_commit":"7bd9ab07561d388daba2a156bf4ba4eec10233de"},"previous_names":["scottgigawatt/wiki"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/scottgigawatt/wiki","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgigawatt%2Fwiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgigawatt%2Fwiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgigawatt%2Fwiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgigawatt%2Fwiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scottgigawatt","download_url":"https://codeload.github.com/scottgigawatt/wiki/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgigawatt%2Fwiki/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27759452,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-16T02:00:10.477Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker-compose","mkdocs","mkdocs-material","synology"],"created_at":"2024-09-24T19:50:28.886Z","updated_at":"2025-12-16T04:04:27.584Z","avatar_url":"https://github.com/scottgigawatt.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003chr /\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cem\u003e🌌 Star this repo — unlock the cosmic codex and map the constellations of forbidden knowledge.\u003c/em\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/license/scottgigawatt/wiki?label=Celestial%20Charter\u0026color=blue\" alt=\"License\" /\u003e\n  \u003cimg src=\"https://img.shields.io/github/last-commit/scottgigawatt/wiki?label=Last%20Star%20Chart\u0026logo=git\u0026color=green\" alt=\"Last Commit\" /\u003e\n  \u003cimg src=\"https://img.shields.io/github/repo-size/scottgigawatt/wiki?label=Archive%20Mass\u0026color=orange\" alt=\"Repo Size\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e─── ⛧ ───\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cem\u003e⚡ Lost in the labyrinth or seeking the Oracle? Cross the River Styx and \u003cstrong\u003eEnter 🔥HADES🔥\u003c/strong\u003e.\u003c/em\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://discord.gg/BpEGzWwGYf\"\u003e\n    \u003cimg src=\"https://img.shields.io/discord/1403601106315116626?label=%F0%9F%94%A5HADES%F0%9F%94%A5\u0026logo=discord\u0026logoColor=white\u0026color=5865F2\" alt=\"🔥HADES🔥 Discord\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003chr /\u003e\n\n# Synology Wiki\n\nWelcome 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.\n\n## Overview\n\nThe 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).\n\n## Authoring and Editing\n\n### Editing Content\n\nDocuments are stored in the `docs` directory of this repository. You can edit them via the GitHub web UI or locally.\n\n- 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\".\n- For a better authoring experience, use Visual Studio Code with recommended plugins:\n    - **[markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)**: Checks for formatting issues.\n    - **[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.\n\n### Managing Navigation\n\nThe 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.\n\n## Local Development\n\n### Using the Makefile\n\nTo build and start the webserver locally, follow these steps:\n\n```bash\n# Clone the repository\ngit clone git@github.com:scottgigawatt/wiki.git\ncd wiki\n\n# Start the local webserver\nmake start\n```\n\nThe local server will be running at \u003chttp://localhost:8800/scottgigawatt/wiki/\u003e. 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.\n\n## Managing the Project with DSM Container Manager\n\nTo import this project into DSM 7.2 Container Manager's Project feature:\n\n1. SSH into your Synology system.\n1. Clone this repository.\n1. In Container Manager, click **Project** then **Create**.\n1. Provide a title, e.g., **mkdocs-material**.\n1. Set the path to the cloned repository.\n1. Proceed through UI prompts to finish creating the project.\n\nRefer 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.\n\n### Secure Access to Synology Applications\n\nUse 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.\n\n\u003e **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:\n\u003e\n\u003e 1. Go to `Control Panel -\u003e Application Portal -\u003e Reverse Proxy`.\n\u003e 1. Select `Edit` for your reverse proxy record.\n\u003e 1. Navigate to the `Custom Header` tab.\n\u003e 1. From the `Create` dropdown, select `WebSocket`.\n\u003e 1. Save the changes to resolve the issue.\n\n## Environment Details\n\nTested on Synology DS916+ running DSM 7.2, with Docker Compose version v2.20.\n\n## License\n\nThis project is licensed under the Apache 2 License - see the [LICENSE](LICENSE) file for details.\n\n---\nContributions to improve the Synology Wiki are welcome. Please feel free to submit pull requests or provide feedback. Happy documenting!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscottgigawatt%2Fwiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscottgigawatt%2Fwiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscottgigawatt%2Fwiki/lists"}