0ct0pu5/rustpad
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Clarify use of SQLITE_URI in Docker contexts

Browse source
This commit is contained in:
Eric Zhang 2021-10-21 00:24:59 -04:00
parent 6673059d3a
commit 2fd8c10ef1
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -83,9 +83,10 @@ following environment variables on startup:
documents are kept in memory before being garbage collected by the server
(default 1 day).
- `SQLITE_URI`: A SQLite connection string used for persistence. If provided,
Rustpad will persist the contents of documents to a local file on disk, which
enables documents to be retained between server restarts, and also after their
in-memory data structures expire.
Rustpad will snapshot document contents to a local file, which enables them to
be retained between server restarts and after their in-memory data structures
expire. (When deploying a Docker container, this should point to the path of a
mounted volume.)
- `PORT`: Which local port to listen for HTTP connections on (defaults to 3030).
- `RUST_LOG`: Directives that control application logging, see the
[env_logger](https://docs.rs/env_logger/#enabling-logging) docs for more