diff --git a/README.md b/README.md index 6605453a..e3f170d4 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,14 @@ This image provides various versions that are available via tags. Please read th Access the webui at `:3579`. Follow the setup wizard on initial install. Then configure the required services. +## Read-Only Operation + +This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/). + +### Caveats +* `BASE_URL` cannot be changed from `/` + + ## Usage To help you get started creating a container from this image you can either use docker-compose or the docker cli. @@ -125,6 +133,7 @@ Containers are configured using parameters passed at runtime (such as those abov | `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | | `-e BASE_URL=/` | Subfolder can optionally be defined as an env variable for reverse proxies. Keep in mind that once this value is defined, the gui setting for base url no longer works. To use the gui setting, remove this env variable. | | `-v /config` | Contains all relevant configuration files. | +| `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). | ## Environment variables from files (Docker secrets)