Skip to content

Commit ea64bed

Browse files
Merge pull request #2133 from nextcloud/enh/readme/persist-volumes-custom-upgrade-exclude
enh(README) Persistent volume upgrade.exclude clarification
2 parents bbc81a9 + accf5bf commit ea64bed

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ $ docker run -d \
7171
mariadb:10.6
7272
```
7373

74+
### Additional volumes
75+
7476
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.
7577

7678
Overview of the folders that can be mounted as volumes:
@@ -91,10 +93,16 @@ $ docker run -d \
9193
-v theme:/var/www/html/themes/<YOUR_CUSTOM_THEME> \
9294
nextcloud
9395
```
94-
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:
96+
97+
### Custom volumes
98+
99+
If mounting additional volumes under `/var/www/html`, you should consider:
95100
- 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
96101
- Mounting storage volumes to locations outside of `/var/www/html`.
97102

103+
> [!WARNING]
104+
> You should note that data inside the main folder (`/var/www/html`) will be overridden/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` and if possible read-only 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).
105+
98106

99107
## Using the Nextcloud command-line interface
100108
To use the [Nextcloud command-line interface](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/occ_command.html) (aka. `occ` command):

0 commit comments

Comments
 (0)