docs(readme): rewrite "Persistent data" section for clarity/accuracy#2566
Open
joshtrichards wants to merge 1 commit intomasterfrom
Open
docs(readme): rewrite "Persistent data" section for clarity/accuracy#2566joshtrichards wants to merge 1 commit intomasterfrom
joshtrichards wants to merge 1 commit intomasterfrom
Conversation
Restructure and rewrite the persistent data documentation to better explain how the image manages /var/www/html, how upgrades interact with volume contents, and what administrators need to know to keep their data safe. Key changes: - Explain the upgrade replacement behavior and upgrade.exclude up front - Clarify warning about anonymous volume pitfalls during container recreation - Account for SQLite (no separate database container/volume needed) - Clarify that /var/www/html/apps should not be separately mounted - Clarify how to add custom volumes safely (mount outside /var/www/html, or build a custom image with a modified /upgrade.exclude) - Add a brief backups subsection Signed-off-by: Josh <josh.t.richards@gmail.com>
joshtrichards
added a commit
that referenced
this pull request
Apr 5, 2026
…starts Add collapsible Docker Compose examples alongside existing `docker run` commands in the "Using the apache image" and "Using the fpm image" sections, using <details> blocks to avoid bloating the page. The FPM example includes the required nginx service and links to the Nextcloud nginx documentation and the existing FPM examples in this repository for a working nginx.conf. Docker Compose equivalents for the "Persistent data" and "Additional volumes" sections are deferred pending the merge of #2566. Signed-off-by: Josh <josh.t.richards@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 current "Persistent data" section jumps into volume mount examples without explaining how the image manages
/var/www/htmlor why certain volumes are safe and others aren't.This rewrite restructures the section to lead with the concepts an administrator needs -- how upgrades replace contents, what
upgrade.excludeprotects, and the risks of anonymous volumes -- before showing the mount examples. It also accounts for SQLite users (who don't need a separate database volume), updates theappsvscustom_appswarning, iterates on the coverage of how to safely add custom volumes under/var/www/html, and adds a brief note on backups.