Skip to content

Commit e53db90

Browse files
committed
[readme] add tmpfs warning
1 parent d28c57a commit e53db90

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,24 @@ The required files to deploy are `src`, `node_modules`, `branches`, `config.json
3434

3535
Run the container as so:
3636
```sh
37-
docker run -v /path/to/your/config.json:/config.json -p 8080:8080 ghcr.io/uwu/sheltupdate
37+
docker run -v /path/to/your/config.json:/config.json --tmpfs /tmp -p 8080:8080 ghcr.io/uwu/sheltupdate
3838
```
3939

40+
The `--tmpfs` flag is available only on Linux hosts, and omitting it will not break sheltupdate, but will cause the
41+
sheltupdate cache to be left on your system, inflating disk use over time.
42+
43+
In a docker compose file, you specify this with:
44+
```yml
45+
services:
46+
sheltupdate:
47+
# rest of entry omitted here
48+
tmpfs:
49+
- /tmp
50+
```
51+
52+
This step prevents the sheltupdate cache hitting the disk in practice, and therefore no resource leaks will happen when
53+
the container is restarted without being torn down and restored fresh.
54+
4055
# Usage
4156
Discord fetches the update API URL from a `settings.json` file stored in various directories depending on your operating system.
4257

0 commit comments

Comments
 (0)