From 622b7490e03519f69b0fce4004163caca73eb3bc Mon Sep 17 00:00:00 2001 From: err0rgod Date: Sat, 14 Nov 2026 16:58:39 +0530 Subject: [PATCH] docs: finish the post-SQLite data-directory wording Update the Dockerfile, Compose file and upgrade note to describe what ./data and ./keys actually hold now that the graph stores are PostgreSQL. --- Dockerfile | 2 +- README.md | 2 +- docker-compose.yml | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Dockerfile b/Dockerfile index d32ce8f..a13227c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -178,7 +178,7 @@ COPY --from=build /out/artex /app/artex COPY start.sh /app/start.sh RUN chmod +x /app/artex /app/start.sh && mkdir -p /app/keys COPY skills/ /app/skills/ -# persistence points: data/ (SQLite, task files) and keys/ (jwt.key, via ARTEX_JWT_KEY_DIR) +# persistence points: data/ (traffic index, task files, transcripts) and keys/ (jwt.key, secret.key, via ARTEX_JWT_KEY_DIR) VOLUME ["/app/data", "/app/keys"] EXPOSE 8787 8788 ENTRYPOINT ["/app/start.sh"] diff --git a/README.md b/README.md index 8d04e70..4aa5538 100644 --- a/README.md +++ b/README.md @@ -207,7 +207,7 @@ Daily cron example (03:20, operator crontab): ## Updating and upgrading -> Upgrading only swaps the program and never touches data: the Postgres volume `pgdata`, `./data` (traffic index, task files, transcripts, etc.), `./keys` (jwt.key), and `./skills` are all preserved. **No manual database migration is needed**: `artex` idempotently re-runs `schema.sql` on every start (with `ADD COLUMN` / `CREATE INDEX IF NOT EXISTS`), i.e. "restart equals migrate". It is still recommended to back up `./data` and the database before upgrading. +> Upgrading only swaps the program and never touches data: the Postgres volume `pgdata`, `./data` (traffic index, task files, transcripts, etc.), `./keys` (jwt.key, secret.key), and `./skills` are all preserved. **No manual database migration is needed**: `artex` idempotently re-runs `schema.sql` on every start (with `ADD COLUMN` / `CREATE INDEX IF NOT EXISTS`), i.e. "restart equals migrate". It is still recommended to back up `./data` and the database before upgrading. **Update banner (opt-in, off by default)**: start ARTEX with `ARTEX_UPDATE_CHECK=1` to have the backend ask the public GitHub releases API for the latest ARTEX tag, at most once per 24 hours (cached in memory; a failed check is not retried within that window). When the release is newer than the running version, the web UI shows a small dismissible strip linking to the Releases page. The request sends only the `User-Agent: artex-update-check` header. Unset, ARTEX makes no update request and shows no banner. diff --git a/docker-compose.yml b/docker-compose.yml index d87ee11..ecfb72b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -54,10 +54,10 @@ services: - "${ARTEX_BIND_ADDR:-127.0.0.1}:8787:8787" - "127.0.0.1:8788:8788" volumes: - # Bind the data directory (SQLite, task files, etc.) to data/ in the project root, + # Bind the runtime data directory (traffic index, task files, transcripts, etc.) to data/ in the project root, # so it is easy to inspect/back up on the host and survives container rebuilds. - ./data:/app/data - # JWT signing key (jwt.key), kept out of data/, which the file manager browses. + # JWT signing key and secret key (jwt.key, secret.key), kept out of data/, which the file manager browses. # Persisting it keeps users signed in across container rebuilds. - ./keys:/app/keys # Mount skills/ from the project root into the container (overriding the image's built-in /app/skills);