Files
PunktFri/README.md

46 lines
1.1 KiB
Markdown
Raw Normal View History

# PunktFri.dk
Flask landing page for PunktFri — a Danish non-profit registrar initiative for self-hosters.
## Setup
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python app.py
```
Visit `http://localhost:5000`
## Environment variables
| Variable | Default | Description |
|----------|---------|-------------|
| `PORT` | `5000` | Port to listen on |
| `DATABASE` | `punktfri.db` | SQLite database path |
| `LOG_FILE` | `signups.log` | Signup log file path |
| `ADMIN_USER` | `admin` | Admin username |
| `ADMIN_PASS` | `punktfri2024` | Admin password |
Change `ADMIN_USER` and `ADMIN_PASS` before deploying publicly.
## Routes
- `/` — Landing page + signup form
- `/tak` — Confirmation page after signup
- `/admin` — Signup table (HTTP Basic Auth)
- `/health` — Health check (returns `{"status": "ok"}`)
## Data
Signups are stored in two places:
- **SQLite** (`punktfri.db`) — queryable, used by `/admin`
- **Log file** (`signups.log`) — append-only plaintext log
Both are created automatically on first run.
## Admin
Visit `http://localhost:5000/admin` and enter the credentials above.