From 2e75be80f9b439afbbcb38dfff0a5268f6df5dac Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Thu, 2 Dec 2021 16:24:52 +0100 Subject: [PATCH] Docker: Improve docs ub docker-compose.yml config examples #1172 #1784 --- docker/examples/arm64/docker-compose.yml | 6 +++--- docker/examples/armv7/docker-compose.yml | 6 +++--- docker/examples/docker-compose.yml | 4 ++-- docker/examples/macos/docker-compose.yml | 4 ++-- docker/examples/scheduler/docker-compose.yml | 4 ++-- docker/examples/sqlite/docker-compose.yml | 4 ++-- docker/examples/windows/docker-compose.yml | 4 ++-- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docker/examples/arm64/docker-compose.yml b/docker/examples/arm64/docker-compose.yml index 55dc35bbe..dee4d12bd 100644 --- a/docker/examples/arm64/docker-compose.yml +++ b/docker/examples/arm64/docker-compose.yml @@ -5,9 +5,9 @@ version: '3.5' # Note: # - Use https://dl.photoprism.org/docker/armv7/docker-compose.yml for running PhotoPrism on ARMv7-based devices. # - You have to boot your Raspberry Pi 3 / 4 with the parameter "arm_64bit=1" in config.txt to use our ARM64 image. -# - Running PhotoPrism on a server with less than 4 GB of swap (or setting a Docker memory / swap limit) can cause -# unexpected restarts ("crashes"), especially when the indexer temporarily needs more memory to process large files. -# - If you see errors related to "cgroups", it may help to add the following line to /boot/firmware/cmdline.txt: +# - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected +# restarts ("crashes"), especially when the indexer temporarily needs more memory to process large files. +# - If you see Docker errors related to "cgroups", it may help to add the following to /boot/firmware/cmdline.txt: # cgroup_enable=cpuset cgroup_enable=memory cgroup_memory=1 # - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure # HTTPS reverse proxy such as Traefik, Caddy, or NGINX. Your files and passwords will otherwise be transmitted diff --git a/docker/examples/armv7/docker-compose.yml b/docker/examples/armv7/docker-compose.yml index a2f1d98c2..54879b533 100644 --- a/docker/examples/armv7/docker-compose.yml +++ b/docker/examples/armv7/docker-compose.yml @@ -4,9 +4,9 @@ version: '3.5' # # Note: # - Use https://dl.photoprism.org/docker/arm64/docker-compose.yml for running PhotoPrism on ARM64-based devices. -# - Running PhotoPrism on a server with less than 4 GB of swap (or setting a Docker memory / swap limit) can cause -# unexpected restarts ("crashes"), especially when the indexer temporarily needs more memory to process large files. -# - If you see errors related to "cgroups", it may help to add the following line to /boot/firmware/cmdline.txt: +# - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected +# restarts ("crashes"), especially when the indexer temporarily needs more memory to process large files. +# - If you see Docker errors related to "cgroups", it may help to add the following to /boot/firmware/cmdline.txt: # cgroup_enable=cpuset cgroup_enable=memory cgroup_memory=1 # - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure # HTTPS reverse proxy such as Traefik, Caddy, or NGINX. Your files and passwords will otherwise be transmitted diff --git a/docker/examples/docker-compose.yml b/docker/examples/docker-compose.yml index 96a2704bb..f1d9627dc 100644 --- a/docker/examples/docker-compose.yml +++ b/docker/examples/docker-compose.yml @@ -3,8 +3,8 @@ version: '3.5' # Example Docker Compose config file for PhotoPrism (Linux / AMD64) # # Note: -# - Running PhotoPrism on a server with less than 4 GB of swap (or setting a Docker memory / swap limit) can cause -# unexpected restarts ("crashes"), especially when it temporarily needs more memory to index large files. +# - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected +# restarts ("crashes"), especially when the indexer temporarily needs more memory to process large files. # - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure # HTTPS reverse proxy such as Traefik, Caddy, or NGINX. Your files and passwords will otherwise be transmitted # in clear text and can be intercepted by anyone, including your provider, hackers, and governments. diff --git a/docker/examples/macos/docker-compose.yml b/docker/examples/macos/docker-compose.yml index 28b85cc3f..3667102d6 100644 --- a/docker/examples/macos/docker-compose.yml +++ b/docker/examples/macos/docker-compose.yml @@ -3,8 +3,8 @@ version: '3.5' # Example Docker Compose config file for PhotoPrism (macOS) # # Note: -# - Running PhotoPrism on a server with less than 4 GB of swap (or setting a Docker memory / swap limit) can cause -# unexpected restarts ("crashes"), especially when it temporarily needs more memory to index large files. +# - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected +# restarts ("crashes"), especially when the indexer temporarily needs more memory to process large files. # - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure # HTTPS reverse proxy such as Traefik, Caddy, or NGINX. Your files and passwords will otherwise be transmitted # in clear text and can be intercepted by anyone, including your provider, hackers, and governments. diff --git a/docker/examples/scheduler/docker-compose.yml b/docker/examples/scheduler/docker-compose.yml index 2cebfe41d..ed6e62fd4 100644 --- a/docker/examples/scheduler/docker-compose.yml +++ b/docker/examples/scheduler/docker-compose.yml @@ -4,8 +4,8 @@ version: '3.5' # Includes Ophelia, a docker job scheduler: https://github.com/mcuadros/ofelia # # Note: -# - Running PhotoPrism on a server with less than 4 GB of swap (or setting a Docker memory / swap limit) can cause -# unexpected restarts ("crashes"), especially when it temporarily needs more memory to index large files. +# - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected +# restarts ("crashes"), especially when the indexer temporarily needs more memory to process large files. # - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure # HTTPS reverse proxy such as Traefik, Caddy, or NGINX. Your files and passwords will otherwise be transmitted # in clear text and can be intercepted by anyone, including your provider, hackers, and governments. diff --git a/docker/examples/sqlite/docker-compose.yml b/docker/examples/sqlite/docker-compose.yml index 77aa75c4a..4f2c8bc25 100644 --- a/docker/examples/sqlite/docker-compose.yml +++ b/docker/examples/sqlite/docker-compose.yml @@ -5,8 +5,8 @@ version: '3.5' # Note: # - Use SQLite only for small libraries and testing. SQLite locks the index on updates, so other operations have to # wait. In the worst case, this can lead to timeout errors. MariaDB is optimized for high concurrency. -# - Running PhotoPrism on a server with less than 4 GB of swap (or setting a Docker memory / swap limit) can cause -# unexpected restarts ("crashes"), especially when it temporarily needs more memory to index large files. +# - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected +# restarts ("crashes"), especially when the indexer temporarily needs more memory to process large files. # - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure # HTTPS reverse proxy such as Traefik, Caddy, or NGINX. Your files and passwords will otherwise be transmitted # in clear text and can be intercepted by anyone, including your provider, hackers, and governments. diff --git a/docker/examples/windows/docker-compose.yml b/docker/examples/windows/docker-compose.yml index 838d72052..afbfab34f 100644 --- a/docker/examples/windows/docker-compose.yml +++ b/docker/examples/windows/docker-compose.yml @@ -3,8 +3,8 @@ version: '3.5' # Example Docker Compose config file for PhotoPrism (Windows / AMD64) # # Note: -# - Running PhotoPrism on a server with less than 4 GB of swap (or setting a Docker memory / swap limit) can cause -# unexpected restarts ("crashes"), especially when it temporarily needs more memory to index large files. +# - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected +# restarts ("crashes"), especially when the indexer temporarily needs more memory to process large files. # - Windows Pro users should disable the WSL 2 based engine in Docker Settings > General so that # they can mount drives other than C:. This will enable Hyper-V, which Microsoft doesn't offer # to its Windows Home customers. Docker Desktop uses dynamic memory allocation with WSL 2.