From d652c4ee1ea9a9e0cfa6ae6dad3e93848ae47f78 Mon Sep 17 00:00:00 2001 From: Lars Gerber Date: Sat, 1 Mar 2025 21:28:34 +0100 Subject: [PATCH] docs(compose): prevent anonymous volume creation --- README.md | 13 ++++++++----- README_ES.md | 9 ++++++--- README_zh-CN.md | 17 ++++++++++++++--- docker-compose.dev.yaml | 7 +++++-- docker-compose.yaml | 7 ++++++- examples/nginx/docker-compose.yaml | 9 ++++++--- examples/scratch/README.md | 9 ++++++--- examples/traefik/README.md | 17 ++++++++++++++--- 8 files changed, 65 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index da4af8b..263ddb3 100644 --- a/README.md +++ b/README.md @@ -86,8 +86,8 @@ of the notes even if it tried to. | `THEME_PAGE_TITLE` | `""` | Custom text the page title | | `THEME_FAVICON` | `""` | Custom url for the favicon. Must be publicly reachable | | `THEME_NEW_NOTE_NOTICE` | `true` | Show the message about how notes are stored in the memory and may be evicted after creating a new note. Defaults to `true`. | -| `IMPRINT_URL` | `""` | Custom url for an Imprint hosted somewhere else. Must be publicly reachable. Takes precedence above `IMPRINT_HTML`. | -| `IMPRINT_HTML` | `""` | Alternative to `IMPRINT_URL`, this can be used to specify the HTML code to show on `/imprint`. Only `IMPRINT_HTML` or `IMPRINT_URL` should be specified, not both.| +| `IMPRINT_URL` | `""` | Custom url for an Imprint hosted somewhere else. Must be publicly reachable. Takes precedence above `IMPRINT_HTML`. | +| `IMPRINT_HTML` | `""` | Alternative to `IMPRINT_URL`, this can be used to specify the HTML code to show on `/imprint`. Only `IMPRINT_HTML` or `IMPRINT_URL` should be specified, not both. | ## Deployment > ℹ️ `https` is required otherwise browsers will not support the cryptographic functions. @@ -108,9 +108,12 @@ services: image: redis:7-alpine # This is required to stay in RAM only. command: redis-server --save "" --appendonly no - # Additionally, you can set a size limit. See link below on how to customise. - # https://redis.io/docs/manual/eviction/ - # --maxmemory 1gb --maxmemory-policy allkeys-lru + # Set a size limit. See link below on how to customise. + # https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/ + # --maxmemory 1gb --maxmemory-policy allkeys-lrulpine + # This prevents the creation of an anonymous volume. + tmpfs: + - /data app: image: cupcakearmy/cryptgeon:latest diff --git a/README_ES.md b/README_ES.md index f40d55f..9b2dc54 100644 --- a/README_ES.md +++ b/README_ES.md @@ -93,9 +93,12 @@ services: image: redis:7-alpine # This is required to stay in RAM only. command: redis-server --save "" --appendonly no - # Additionally, you can set a size limit. See link below on how to customise. - # https://redis.io/docs/manual/eviction/ - # --maxmemory 1gb --maxmemory-policy allkeys-lru + # Set a size limit. See link below on how to customise. + # https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/ + # --maxmemory 1gb --maxmemory-policy allkeys-lrulpine + # This prevents the creation of an anonymous volume. + tmpfs: + - /data app: image: cupcakearmy/cryptgeon:latest diff --git a/README_zh-CN.md b/README_zh-CN.md index fcbd4bf..7d88b3c 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -74,6 +74,14 @@ version: '3.8' services: redis: image: redis:7-alpine + # This is required to stay in RAM only. + command: redis-server --save "" --appendonly no + # Set a size limit. See link below on how to customise. + # https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/ + # --maxmemory 1gb --maxmemory-policy allkeys-lrulpine + # This prevents the creation of an anonymous volume. + tmpfs: + - /data app: image: cupcakearmy/cryptgeon:latest @@ -110,9 +118,12 @@ services: image: redis:7-alpine # This is required to stay in RAM only. command: redis-server --save "" --appendonly no - # Additionally, you can set a size limit. See link below on how to customise. - # https://redis.io/docs/manual/eviction/ - # --maxmemory 1gb --maxmemory-policy allkeys-lru + # Set a size limit. See link below on how to customise. + # https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/ + # --maxmemory 1gb --maxmemory-policy allkeys-lrulpine + # This prevents the creation of an anonymous volume. + tmpfs: + - /data app: image: cupcakearmy/cryptgeon:latest diff --git a/docker-compose.dev.yaml b/docker-compose.dev.yaml index dba72cb..fd4d10b 100644 --- a/docker-compose.dev.yaml +++ b/docker-compose.dev.yaml @@ -6,9 +6,12 @@ services: image: redis:7-alpine # This is required to stay in RAM only. command: redis-server --save "" --appendonly no - # Additionally, you can set a size limit. See link below on how to customise. - # https://redis.io/docs/manual/eviction/ + # Set a size limit. See link below on how to customise. + # https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/ # --maxmemory 1gb --maxmemory-policy allkeys-lrulpine + # This prevents the creation of an anonymous volume. + tmpfs: + - /data ports: - 6379:6379 diff --git a/docker-compose.yaml b/docker-compose.yaml index 8a81098..0a9d1b6 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -1,9 +1,14 @@ services: redis: image: redis:7-alpine + # This is required to stay in RAM only. + command: redis-server --save "" --appendonly no # Set a size limit. See link below on how to customise. # https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/ - # command: redis-server --maxmemory 1gb --maxmemory-policy allkeys-lru + # --maxmemory 1gb --maxmemory-policy allkeys-lrulpine + # This prevents the creation of an anonymous volume. + tmpfs: + - /data app: image: cupcakearmy/cryptgeon:latest diff --git a/examples/nginx/docker-compose.yaml b/examples/nginx/docker-compose.yaml index 43b4eb8..ddd1b0b 100644 --- a/examples/nginx/docker-compose.yaml +++ b/examples/nginx/docker-compose.yaml @@ -5,9 +5,12 @@ services: image: redis:7-alpine # This is required to stay in RAM only. command: redis-server --save "" --appendonly no - # Additionally, you can set a size limit. See link below on how to customise. - # https://redis.io/docs/manual/eviction/ - # --maxmemory 1gb --maxmemory-policy allkeys-lru + # Set a size limit. See link below on how to customise. + # https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/ + # --maxmemory 1gb --maxmemory-policy allkeys-lrulpine + # This prevents the creation of an anonymous volume. + tmpfs: + - /data app: image: cupcakearmy/cryptgeon:latest diff --git a/examples/scratch/README.md b/examples/scratch/README.md index 74e765c..db9d167 100644 --- a/examples/scratch/README.md +++ b/examples/scratch/README.md @@ -111,9 +111,12 @@ services: image: redis:7-alpine # This is required to stay in RAM only. command: redis-server --save "" --appendonly no - # Additionally, you can set a size limit. See link below on how to customise. - # https://redis.io/docs/manual/eviction/ - # --maxmemory 1gb --maxmemory-policy allkeys-lru + # Set a size limit. See link below on how to customise. + # https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/ + # --maxmemory 1gb --maxmemory-policy allkeys-lrulpine + # This prevents the creation of an anonymous volume. + tmpfs: + - /data app: image: cupcakearmy/cryptgeon:latest diff --git a/examples/traefik/README.md b/examples/traefik/README.md index 6f8bde3..7287af0 100644 --- a/examples/traefik/README.md +++ b/examples/traefik/README.md @@ -20,9 +20,12 @@ services: image: redis:7-alpine # This is required to stay in RAM only. command: redis-server --save "" --appendonly no - # Additionally, you can set a size limit. See link below on how to customise. - # https://redis.io/docs/manual/eviction/ - # --maxmemory 1gb --maxmemory-policy allkeys-lru + # Set a size limit. See link below on how to customise. + # https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/ + # --maxmemory 1gb --maxmemory-policy allkeys-lrulpine + # This prevents the creation of an anonymous volume. + tmpfs: + - /data app: image: cupcakearmy/cryptgeon:latest @@ -59,6 +62,14 @@ services: redis: image: redis:7-alpine + # This is required to stay in RAM only. + command: redis-server --save "" --appendonly no + # Set a size limit. See link below on how to customise. + # https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/ + # --maxmemory 1gb --maxmemory-policy allkeys-lrulpine + # This prevents the creation of an anonymous volume. + tmpfs: + - /data cryptgeon: image: cupcakearmy/cryptgeon