Aktueller Stand
This commit is contained in:
15
README.md
15
README.md
@@ -8,14 +8,17 @@ State-of-the-art mail cleanup tool with multi-tenant support, newsletter unsubsc
|
||||
- DB: PostgreSQL
|
||||
- Queue: Redis + BullMQ worker
|
||||
|
||||
Node.js:
|
||||
- Docker images use Node.js 24.13.0 (LTS)
|
||||
|
||||
## Quick start
|
||||
```bash
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
- Web UI: http://localhost:3000
|
||||
- API: http://localhost:8000
|
||||
- API Docs: http://localhost:8000/docs
|
||||
- Web UI: `http://localhost:${WEB_PORT}` (see root `.env`)
|
||||
- API: `http://localhost:${API_PORT}`
|
||||
- API Docs: `http://localhost:${API_PORT}/docs`
|
||||
|
||||
## API (initial)
|
||||
- `POST /auth/register` `{ tenantName, email, password }`
|
||||
@@ -84,7 +87,7 @@ npm run prisma:seed
|
||||
- DSGVO: data storage is designed for tenant isolation; encryption at rest will be added.
|
||||
|
||||
## Environment
|
||||
`docker-compose.yml` sets default dev credentials. Adjust before production use.
|
||||
All config lives in the repo root `.env` (see `.env.example`).
|
||||
|
||||
Export settings:
|
||||
- `EXPORT_DIR` (default `/tmp/mailcleaner-exports`)
|
||||
@@ -94,3 +97,7 @@ Proxy settings (Nginx Proxy Manager):
|
||||
- `TRUST_PROXY=true`
|
||||
- `VITE_API_URL=https://your-domain.tld`
|
||||
- `GOOGLE_REDIRECT_URI=https://your-domain.tld/oauth/gmail/callback`
|
||||
|
||||
Local ports (override via `.env` in repo root):
|
||||
- `API_PORT` (default `8000`, now set to `8201` in `.env`)
|
||||
- `WEB_PORT` (default `3000`, now set to `3201` in `.env`)
|
||||
|
||||
Reference in New Issue
Block a user