Skip to content

Commit 4cc9d8a

Browse files
cupcakearmycupcakearmy
authored
Merge pull request #179 from larsgerber/main
docs(compose): prevent anonymous volume creation
2 parents 096be03 + d652c4e commit 4cc9d8a

File tree

8 files changed

+65
-23
lines changed

8 files changed

+65
-23
lines changed

‎README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ of the notes even if it tried to.
8686
| `THEME_PAGE_TITLE` | `""` | Custom text the page title |
8787
| `THEME_FAVICON` | `""` | Custom url for the favicon. Must be publicly reachable |
8888
| `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`. |
89-
| `IMPRINT_URL` | `""` | Custom url for an Imprint hosted somewhere else. Must be publicly reachable. Takes precedence above `IMPRINT_HTML`. |
90-
| `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.|
89+
| `IMPRINT_URL` | `""` | Custom url for an Imprint hosted somewhere else. Must be publicly reachable. Takes precedence above `IMPRINT_HTML`. |
90+
| `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. |
9191
## Deployment
9292

9393
> ℹ️ `https` is required otherwise browsers will not support the cryptographic functions.
@@ -108,9 +108,12 @@ services:
108108
image: redis:7-alpine
109109
# This is required to stay in RAM only.
110110
command: redis-server --save "" --appendonly no
111-
# Additionally, you can set a size limit. See link below on how to customise.
112-
# https://redis.io/docs/manual/eviction/
113-
# --maxmemory 1gb --maxmemory-policy allkeys-lru
111+
# Set a size limit. See link below on how to customise.
112+
# https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
113+
# --maxmemory 1gb --maxmemory-policy allkeys-lrulpine
114+
# This prevents the creation of an anonymous volume.
115+
tmpfs:
116+
- /data
114117

115118
app:
116119
image: cupcakearmy/cryptgeon:latest

‎README_ES.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,12 @@ services:
9393
image: redis:7-alpine
9494
# This is required to stay in RAM only.
9595
command: redis-server --save "" --appendonly no
96-
# Additionally, you can set a size limit. See link below on how to customise.
97-
# https://redis.io/docs/manual/eviction/
98-
# --maxmemory 1gb --maxmemory-policy allkeys-lru
96+
# Set a size limit. See link below on how to customise.
97+
# https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
98+
# --maxmemory 1gb --maxmemory-policy allkeys-lrulpine
99+
# This prevents the creation of an anonymous volume.
100+
tmpfs:
101+
- /data
99102

100103
app:
101104
image: cupcakearmy/cryptgeon:latest

‎README_zh-CN.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,14 @@ version: '3.8'
7474
services:
7575
redis:
7676
image: redis:7-alpine
77+
# This is required to stay in RAM only.
78+
command: redis-server --save "" --appendonly no
79+
# Set a size limit. See link below on how to customise.
80+
# https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
81+
# --maxmemory 1gb --maxmemory-policy allkeys-lrulpine
82+
# This prevents the creation of an anonymous volume.
83+
tmpfs:
84+
- /data
7785

7886
app:
7987
image: cupcakearmy/cryptgeon:latest
@@ -110,9 +118,12 @@ services:
110118
image: redis:7-alpine
111119
# This is required to stay in RAM only.
112120
command: redis-server --save "" --appendonly no
113-
# Additionally, you can set a size limit. See link below on how to customise.
114-
# https://redis.io/docs/manual/eviction/
115-
# --maxmemory 1gb --maxmemory-policy allkeys-lru
121+
# Set a size limit. See link below on how to customise.
122+
# https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
123+
# --maxmemory 1gb --maxmemory-policy allkeys-lrulpine
124+
# This prevents the creation of an anonymous volume.
125+
tmpfs:
126+
- /data
116127
117128
app:
118129
image: cupcakearmy/cryptgeon:latest

‎docker-compose.dev.yaml

+5-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,12 @@ services:
66
image: redis:7-alpine
77
# This is required to stay in RAM only.
88
command: redis-server --save "" --appendonly no
9-
# Additionally, you can set a size limit. See link below on how to customise.
10-
# https://redis.io/docs/manual/eviction/
9+
# Set a size limit. See link below on how to customise.
10+
# https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
1111
# --maxmemory 1gb --maxmemory-policy allkeys-lrulpine
12+
# This prevents the creation of an anonymous volume.
13+
tmpfs:
14+
- /data
1215
ports:
1316
- 6379:6379
1417

‎docker-compose.yaml

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
services:
22
redis:
33
image: redis:7-alpine
4+
# This is required to stay in RAM only.
5+
command: redis-server --save "" --appendonly no
46
# Set a size limit. See link below on how to customise.
57
# https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
6-
# command: redis-server --maxmemory 1gb --maxmemory-policy allkeys-lru
8+
# --maxmemory 1gb --maxmemory-policy allkeys-lrulpine
9+
# This prevents the creation of an anonymous volume.
10+
tmpfs:
11+
- /data
712

813
app:
914
image: cupcakearmy/cryptgeon:latest

‎examples/nginx/docker-compose.yaml

+6-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@ services:
55
image: redis:7-alpine
66
# This is required to stay in RAM only.
77
command: redis-server --save "" --appendonly no
8-
# Additionally, you can set a size limit. See link below on how to customise.
9-
# https://redis.io/docs/manual/eviction/
10-
# --maxmemory 1gb --maxmemory-policy allkeys-lru
8+
# Set a size limit. See link below on how to customise.
9+
# https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
10+
# --maxmemory 1gb --maxmemory-policy allkeys-lrulpine
11+
# This prevents the creation of an anonymous volume.
12+
tmpfs:
13+
- /data
1114

1215
app:
1316
image: cupcakearmy/cryptgeon:latest

‎examples/scratch/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,12 @@ services:
111111
image: redis:7-alpine
112112
# This is required to stay in RAM only.
113113
command: redis-server --save "" --appendonly no
114-
# Additionally, you can set a size limit. See link below on how to customise.
115-
# https://redis.io/docs/manual/eviction/
116-
# --maxmemory 1gb --maxmemory-policy allkeys-lru
114+
# Set a size limit. See link below on how to customise.
115+
# https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
116+
# --maxmemory 1gb --maxmemory-policy allkeys-lrulpine
117+
# This prevents the creation of an anonymous volume.
118+
tmpfs:
119+
- /data
117120

118121
app:
119122
image: cupcakearmy/cryptgeon:latest

‎examples/traefik/README.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,12 @@ services:
2020
image: redis:7-alpine
2121
# This is required to stay in RAM only.
2222
command: redis-server --save "" --appendonly no
23-
# Additionally, you can set a size limit. See link below on how to customise.
24-
# https://redis.io/docs/manual/eviction/
25-
# --maxmemory 1gb --maxmemory-policy allkeys-lru
23+
# Set a size limit. See link below on how to customise.
24+
# https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
25+
# --maxmemory 1gb --maxmemory-policy allkeys-lrulpine
26+
# This prevents the creation of an anonymous volume.
27+
tmpfs:
28+
- /data
2629

2730
app:
2831
image: cupcakearmy/cryptgeon:latest
@@ -59,6 +62,14 @@ services:
5962

6063
redis:
6164
image: redis:7-alpine
65+
# This is required to stay in RAM only.
66+
command: redis-server --save "" --appendonly no
67+
# Set a size limit. See link below on how to customise.
68+
# https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
69+
# --maxmemory 1gb --maxmemory-policy allkeys-lrulpine
70+
# This prevents the creation of an anonymous volume.
71+
tmpfs:
72+
- /data
6273

6374
cryptgeon:
6475
image: cupcakearmy/cryptgeon

0 commit comments

Comments
 (0)