astelm/telemt
1
0
Fork 0
mirror of https://github.com/telemt/telemt.git synced 2026-05-23 04:01:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document Docker config layout for API mutations

Browse Source
This commit is contained in:
astronaut808
2026-05-13 16:42:01 +05:00
parent 8895947414
commit 25ca64de1b
2 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Architecture/API/API.md
View File

@@ -1251,7 +1251,7 @@ All mutating endpoints:
Docker deployment note: Docker deployment note:
- Mutating endpoints require `config.toml` to live inside a writable mounted directory. - Mutating endpoints require `config.toml` to live inside a writable mounted directory.
- Do not mount `config.toml` as a single bind-mounted file when API mutations are enabled; atomic `tmp + rename` writes can fail with `Device or resource busy`. - Do not mount `config.toml` as a single bind-mounted file when API mutations are enabled; atomic `tmp + rename` writes can fail with `Device or resource busy`.
- Mount the config directory instead, for example `./telemt-config:/run/telemt:rw`, and start Telemt with `/run/telemt/config.toml`. - Mount the config directory instead, for example `./config:/etc/telemt:rw`, and start Telemt with `/etc/telemt/config.toml`.
- A read-only single-file mount remains valid only for read-only deployments or when `[server.api].read_only=true`. - A read-only single-file mount remains valid only for read-only deployments or when `[server.api].read_only=true`.
Delete path cleanup guarantees: Delete path cleanup guarantees:

7
docs/Quick_start/QUICK_START_GUIDE.en.md
View File

@@ -260,9 +260,12 @@ Example writable config mount for Control API mutations:
```yaml ```yaml
services: services:
telemt: telemt:
working_dir: /run/telemt
volumes: volumes:
- ./telemt-config:/run/telemt:rw - ./config:/etc/telemt:rw
command: /usr/local/bin/telemt /run/telemt/config.toml tmpfs:
- /run/telemt:rw,mode=1777,size=4m
command: /usr/local/bin/telemt /etc/telemt/config.toml
``` ```
**Run without Compose** **Run without Compose**