docs: README

README.md

@@ -6,28 +6,80 @@
 
 **[todo.klemek.fr](https://todo.klemek.fr)**
 
-## TODO
+## Running your own
 
-- [x] auto refresh task completion
+Every argument is available as env var (`APP_URL`, `PORT`, etc.)
-- [x] validate cron string
+
-- [x] clone task
+```txt
-- [x] delete task
+usage: tout-doux [-h] [--debug | --no-debug] [--quiet | --no-quiet] [--env APP_ENV] [--app-url APP_URL] [--bind BIND] [--port PORT]
-- [x] list option: sort
+                 [--workers WORKERS] [--timeout TIMEOUT] [--db-uri DB_URI] [--cache-uri CACHE_URI] [--api-rate-limit API_RATE_LIMIT]
-- [x] list option: show last completion
+
-- [x] list option: show next refresh
+options:
-- [x] list option: move completed below
+  -h, --help            show this help message and exit
-- [x] list option: hide completed
+  --debug, --no-debug
-- [x] options in cookies
+  --quiet, --no-quiet
-- [x] Empty list message
+  --env APP_ENV         environnement (default: production)
-- [x] change lang
+  --app-url APP_URL     app external url (default: http://localhost:5000)
-- [x] toasts
+  --bind BIND           server bind address (default: 0.0.0.0)
-- [x] handle errors
+  --port PORT           server http port (default: 5000)
-- [x] list per URL
+  --workers WORKERS     WSGI workers (default: 4)
-- [x] home screen
+  --timeout TIMEOUT     WSGI timeout (default: 120)
-- [x] share link
+  --db-uri DB_URI       database connection URI (default: sqlite://db.sqlite)
-- [x] lang in cookies
+  --cache-uri CACHE_URI
-- [x] Dockerfile
+                        cache connection URI (default: memory://)
-- [ ] html cards
+  --api-rate-limit API_RATE_LIMIT
-- [ ] custom background
+                        API rate limit (flask-limiter syntax) (default: 100/minute)
-- [x] favicon
+```
-- [ ] README
+
+Docker compose example:
+
+```yaml
+networks:
+    backend:
+
+volumes:
+    postgres-data:
+    redis-data:
+
+services:
+    tout-doux:
+        build: tout-doux # path to this project
+        environment:
+            - DB_URI=postgres://tout-doux:tout-doux@postgres:5432/tout-doux
+            - CACHE_URI=redis://redis:6379
+            - APP_URL=http://localhost:5000
+        ports:
+            - 5000:5000
+        networks:
+            - backend
+
+    vite:
+        image: oven/bun:latest
+        volumes:
+            - .:/app
+        working_dir: /app
+        command: bun run dev
+        ports:
+            - "5173:5173"
+        networks:
+            - backend
+
+    postgres:
+        image: postgres:17
+        environment:
+            - POSTGRES_DB=tout-doux
+            - POSTGRES_USER=tout-doux
+            - POSTGRES_PASSWORD=tout-doux
+            - PGDATA=/var/lib/postgresql/data/pgdata
+        volumes:
+            - "postgres-data:/var/lib/postgresql/data"
+        networks:
+            - backend
+
+    redis:
+        image: redis:8
+        volumes:
+            - redis-data:/data
+        networks:
+            - backend
+```