Fix Synology DSM 6 documentation with proper DSM 6/7 distinction and DSM_HOSTNAME guidance #661
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The README.md was providing confusing guidance for Synology NAS users by linking to a generic Synology guide that pointed to DSM 7 native package instructions, which doesn't help DSM 6 users who must use Docker. Additionally, the documentation was missing important environment variable information for DSM 6 setups.
Changes Made
Clear DSM Version Distinction: Updated the Step-By-Step Guides section to clearly separate installation methods:
DSM_HOSTNAME Environment Variable: Added documentation for the
DSM_HOSTNAME
environment variable, which is required for proper mDNS configuration on Synology DSM 6 systems. This variable is supported in the container's setup script but was not documented.Synology-Specific Docker Compose Example: Added a complete docker-compose configuration specifically for DSM 6 users that includes the
DSM_HOSTNAME
environment variable:Clear Usage Guidance: Added a prominent note explaining that DSM 6 users must use this Docker image while DSM 7 users should prefer the native package for better integration.
These changes address the confusion around Synology installation methods and provide current, accurate information about required environment variables (confirming that S6_OVERLAY_VERSION is still in use at version 3.2.0.2, and documenting DSM_HOSTNAME support).
Fixes #660.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.