diff --git a/README.md b/README.md index 3d78147..a2a4d59 100644 --- a/README.md +++ b/README.md @@ -6,28 +6,80 @@ **[todo.klemek.fr](https://todo.klemek.fr)** -## TODO +## Running your own -- [x] auto refresh task completion -- [x] validate cron string -- [x] clone task -- [x] delete task -- [x] list option: sort -- [x] list option: show last completion -- [x] list option: show next refresh -- [x] list option: move completed below -- [x] list option: hide completed -- [x] options in cookies -- [x] Empty list message -- [x] change lang -- [x] toasts -- [x] handle errors -- [x] list per URL -- [x] home screen -- [x] share link -- [x] lang in cookies -- [x] Dockerfile -- [ ] html cards -- [ ] custom background -- [x] favicon -- [ ] README +Every argument is available as env var (`APP_URL`, `PORT`, etc.) + +```txt +usage: tout-doux [-h] [--debug | --no-debug] [--quiet | --no-quiet] [--env APP_ENV] [--app-url APP_URL] [--bind BIND] [--port PORT] + [--workers WORKERS] [--timeout TIMEOUT] [--db-uri DB_URI] [--cache-uri CACHE_URI] [--api-rate-limit API_RATE_LIMIT] + +options: + -h, --help show this help message and exit + --debug, --no-debug + --quiet, --no-quiet + --env APP_ENV environnement (default: production) + --app-url APP_URL app external url (default: http://localhost:5000) + --bind BIND server bind address (default: 0.0.0.0) + --port PORT server http port (default: 5000) + --workers WORKERS WSGI workers (default: 4) + --timeout TIMEOUT WSGI timeout (default: 120) + --db-uri DB_URI database connection URI (default: sqlite://db.sqlite) + --cache-uri CACHE_URI + cache connection URI (default: memory://) + --api-rate-limit API_RATE_LIMIT + API rate limit (flask-limiter syntax) (default: 100/minute) +``` + +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 +```