diff --git a/README.md b/README.md new file mode 100644 index 0000000..2a0a338 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +PWSS + +Password static serve, a cookies based static file web server, with +different password to every first level subfolder. + +See the env-example for env variables. +Run service-up to run the Docker service + + diff --git a/env-example b/env-example index a0fb837..072330a 100644 --- a/env-example +++ b/env-example @@ -1,10 +1,20 @@ +# Expose this port outside EXPOSE=8088 +# User ID of files ownership UUID=1000 +# How long a password is valid SESSION_EXPIRY=1800 +# Secret key to encrypt cookies (CHANGE!) SECRET_KEY=2f6aa45dfcfc37a50537f0b05af6452c +# Config files location (/data hardcoded in docker-compose.yaml) CONFIG_FOLDER=/data/configs +# Served files location (/data hardcoded in docker-compose.yaml) STATIC_FOLDER=/data/static -DATABASE=/dev/shm/serve.db +# Password login sessions database, in memory for speed, /data/configs/sessions.db for keeping over restarts +DATABASE=/dev/shm/sessions.db +# Number of processes serving files WORKERS=6 +# Timezone TZ=Europe/Helsinki +# Limiter rule, as serving over flask is not optimal.. LIMITER_SHARE=200 per 5 seconds