88 lines
2.9 KiB
Markdown
88 lines
2.9 KiB
Markdown
[](https://git.klemek.fr/klemek/tout-doux/actions?workflow=py-lint.yml) [](https://git.klemek.fr/klemek/tout-doux/actions?workflow=ts-lint.yml) [](https://git.klemek.fr/klemek/tout-doux/actions?workflow=docker-build.yml)
|
|
|
|
<h1><img src="./public/assets/favicon.svg" width="24"> Tout Doux</h1>
|
|
|
|
> A shareable task list with auto resetting items.
|
|
|
|
|
|
|
|
**[todo.klemek.fr](https://todo.klemek.fr)**
|
|
|
|
## Running your own
|
|
|
|
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
|
|
```
|