aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorkj_sh6042026-04-03 03:00:40 -0400
committerkj_sh6042026-04-03 03:00:40 -0400
commit4fb393c616d1743b97618c734fd534d09b9bf5ee (patch)
treef14f6261e61e9733a6fdbe412796387008e9df46 /README
parent9134a3bc588dabe5e8ff010fa2e16f65034ae3a7 (diff)
feat: prod-ready sqlite
refactor: remove migration scripts
Diffstat (limited to 'README')
-rw-r--r--README34
1 files changed, 19 insertions, 15 deletions
diff --git a/README b/README
index f38a8d1..1494a32 100644
--- a/README
+++ b/README
@@ -3,25 +3,29 @@ shim
small static site host for archive uploads.
-
what it does
-- users upload one archive, app publishes it under a slug
-- public routes: /s/<slug>/... and /_site/<slug>/...
+ - users upload one archive, app publishes it under a slug
+ - public routes: /s/<slug>/... and /_site/<slug>/...
quick start (assumes POSIX)
-- python3 -m venv .venv
-- source .venv/bin/activate
-- pip install -r requirements.txt
-- python3 server.py
-- open http://127.0.0.1:8585/app
+ - python3 -m venv .venv
+ - source .venv/bin/activate
+ - pip install -r requirements.txt
+ - python3 server.py
+ - open http://127.0.0.1:8585/app
config
-- SHIM_APP_NAME: ui/app name (default: shim)
-- SHIM_BIND: bind address (default: 0.0.0.0)
-- SHIM_PORT: port (default: 8585)
-- SHIM_MOJICRYPT_BIN: mojicrypt path (default: ./vendor/mojicrypt)
-- SHIM_COOKIE_SECURE: auto|true|false (default: auto)
+ - SHIM_APP_NAME: ui/app name (default: shim)
+ - SHIM_BIND: bind address (default: 0.0.0.0)
+ - SHIM_PORT: port (default: 8585)
+ - SHIM_MOJICRYPT_BIN: mojicrypt path (default: ./vendor/mojicrypt)
+ - SHIM_COOKIE_SECURE: auto|true|false (default: auto)
+ - SHIM_SQLITE_TIMEOUT_SECONDS (default: 30.0)
+ - SHIM_SQLITE_BUSY_TIMEOUT_MS (default: 30000)
+ - SHIM_SQLITE_CACHE_SIZE_KIB (default: 32768)
+ - SHIM_SQLITE_MMAP_SIZE_BYTES (default: 268435456)
+ - SHIM_SQLITE_WAL_AUTOCHECKPOINT_PAGES (default: 1000)
data paths
-- db: data/shim.db
-- site files: data/sites/
+ - db: data/shim.db
+ - site files: data/sites/