aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorKyle Javier [kj_sh604]2026-04-03 03:05:38 -0400
committerGitHub2026-04-03 03:05:38 -0400
commit9f0a5a6fce2621e320fdeb751243b4878f920401 (patch)
treef14f6261e61e9733a6fdbe412796387008e9df46 /README
parent90ba16a3b4d1dfc29a614522824d87c5cae14bf8 (diff)
parent4fb393c616d1743b97618c734fd534d09b9bf5ee (diff)
[merge] pull request #1 from kj-sh604/feat/securityfeat/security
feat: security
Diffstat (limited to 'README')
-rw-r--r--README31
1 files changed, 31 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1494a32
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+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>/...
+
+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
+
+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_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/