diff options
| author | Josh Richards <josh.t.richards@gmail.com> | 2023-12-28 10:08:35 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-12-28 10:08:35 -0500 |
| commit | fd6f811978c597d8fc0eb1925fc1d296641ad28e (patch) | |
| tree | b14ce7c439e96cd17f399c4e9af672c0da9e0e52 | |
| parent | 8afd97014cc3445e888a165f8c2d16af7ed036aa (diff) | |
enh(README) Persistent volume upgrade.exclude clarification
- Make the warning more prominent
- Clarify the language
- Clarity trade-offs
Fixes: #2132
Signed-off-by: Josh Richards <josh.t.richards@gmail.com>
| -rw-r--r-- | README.md | 10 |
1 files changed, 9 insertions, 1 deletions
@@ -71,6 +71,8 @@ $ docker run -d \ mariadb:10.6 ``` +### Additional volumes + If you want to get fine grained access to your individual files, you can mount additional volumes for data, config, your theme and custom apps. The `data`, `config` files are stored in respective subfolders inside `/var/www/html/`. The apps are split into core `apps` (which are shipped with Nextcloud and you don't need to take care of) and a `custom_apps` folder. If you use a custom theme it would go into the `themes` subfolder. Overview of the folders that can be mounted as volumes: @@ -91,10 +93,16 @@ $ docker run -d \ -v theme:/var/www/html/themes/<YOUR_CUSTOM_THEME> \ nextcloud ``` -If mounting additional volumes, you should note that data inside the main folder (`/var/www/html`) may be removed during installation and upgrades, unless listed in [upgrade.exclude](https://github.com/nextcloud/docker/blob/master/upgrade.exclude). You should consider: + +### Custom volumes + +If mounting additional volumes under `/var/www/html`, you should consider: - Confirming that [upgrade.exclude](https://github.com/nextcloud/docker/blob/master/upgrade.exclude) contains the files and folders that should persist during installation and upgrades; or - Mounting storage volumes to locations outside of `/var/www/html`. +> [!WARNING] +> You should note that data inside the main folder (`/var/www/html`) will be removed during installation and upgrades, unless listed in [upgrade.exclude](https://github.com/nextcloud/docker/blob/master/upgrade.exclude). The additional volumes officially supported are already in that list, but custom volumes will need to be added by you. We suggest mounting custom storage volumes outside of `/var/www/html` so that making this adjustment is unnecessary. If you must do so, however, you may build a custom image with a modified `/upgrade.exclude` file that incorporates your custom volume(s). + ## Using the Nextcloud command-line interface To use the [Nextcloud command-line interface](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/occ_command.html) (aka. `occ` command): |