158 lines
5.3 KiB
Markdown
158 lines
5.3 KiB
Markdown
# Deploy-workflow (kort)
|
|
|
|
> **Belangrijk — gebruik de scripts.** Eerdere mislukte pushes kwamen door een
|
|
> achtergebleven `.git/index.lock` die `git commit` blokkeerde (dan valt er
|
|
> niets te pushen en zegt git "up-to-date"). De scripts ruimen dat automatisch
|
|
> op en **controleren** of de push echt is doorgekomen.
|
|
|
|
**1. Op je dev-machine** (Windows / PowerShell), in de repo-map:
|
|
|
|
```powershell
|
|
.\scripts\push.ps1 "korte omschrijving van de wijziging"
|
|
```
|
|
|
|
Dit verwijdert een eventuele lock, commit (alleen als er iets is), pusht naar
|
|
`origin/<branch>` en meldt **OK** of **LET OP** (met reden) — geen stille
|
|
mislukkingen meer. Krijg je "LET OP", dan staat de oorzaak in de git-uitvoer
|
|
erboven (meestal een SSH-/sleutelprobleem).
|
|
|
|
**2. Op de test-server**, in de repo-map:
|
|
|
|
```bash
|
|
./scripts/deploy.sh
|
|
```
|
|
|
|
Dit haalt de laatste code op (`git reset --hard origin/<branch>`), herbouwt de
|
|
containers (incl. migraties via de entrypoint) en controleert of er een nieuwe
|
|
frontend-bundel staat.
|
|
|
|
Nieuwe **modules** verschijnen daarna pas in de app nadat je ze aanzet via
|
|
**⚙ → Modulebeheer**.
|
|
|
|
---
|
|
|
|
# E-mail aanzetten (wachtwoordreset-links)
|
|
|
|
Zonder configuratie gaan e-mails naar de **console-log** van de backend-container
|
|
(zichtbaar met `docker compose logs backend`) — prima om te testen. Voor échte
|
|
e-mail via SMTP zet je in `.env` op de server:
|
|
|
|
```
|
|
DJANGO_EMAIL_BACKEND=django.core.mail.backends.smtp.EmailBackend
|
|
EMAIL_HOST=smtp.jouwprovider.nl
|
|
EMAIL_PORT=587
|
|
EMAIL_HOST_USER=postvak@jouwschool.nl
|
|
EMAIL_HOST_PASSWORD=...
|
|
EMAIL_USE_TLS=1
|
|
DEFAULT_FROM_EMAIL=Roosterwijs <noreply@jouwschool.nl>
|
|
FRONTEND_BASE_URL=http://rooster-test.example.nl:8080
|
|
```
|
|
|
|
`FRONTEND_BASE_URL` bepaalt de basis van de resetlink in de e-mail (zonder
|
|
`FRONTEND_BASE_URL` wordt die afgeleid uit het verzoek). Daarna
|
|
`docker compose up -d` (of `./scripts/deploy.sh`) om de nieuwe waarden te laden.
|
|
|
|
---
|
|
|
|
# Draaien op de test-server (Docker)
|
|
|
|
De stack bestaat uit drie containers:
|
|
|
|
| Container | Rol |
|
|
|-----------|-----|
|
|
| `db` | PostgreSQL (data in een Docker-volume) |
|
|
| `backend` | Django via gunicorn |
|
|
| `nginx` | serveert de React-frontend en stuurt `/api` + `/admin` door naar de backend |
|
|
|
|
Je hoeft op de server **niets** te installeren behalve Docker zelf (met de
|
|
`docker compose`-plugin). Python, Node, Postgres enz. zitten in de images.
|
|
|
|
## Eenmalig: server klaarzetten
|
|
|
|
1. Zorg dat Docker + Compose op de test-server staan:
|
|
```bash
|
|
docker --version
|
|
docker compose version
|
|
```
|
|
2. Haal de code op:
|
|
```bash
|
|
git clone <jouw-forgejo-url>/Roostersoftware.git
|
|
cd Roostersoftware
|
|
```
|
|
3. Maak het `.env`-bestand aan vanuit het voorbeeld en vul echte waarden in:
|
|
```bash
|
|
cp .env.example .env
|
|
nano .env
|
|
```
|
|
Belangrijk om aan te passen:
|
|
- `DJANGO_SECRET_KEY` — genereer met
|
|
`python3 -c "import secrets; print(secrets.token_urlsafe(50))"`
|
|
- `DJANGO_ALLOWED_HOSTS` — de hostnaam/IP van de test-server
|
|
- `DJANGO_CSRF_TRUSTED_ORIGINS` — `http://<host>:8080` (of je echte URL)
|
|
- `POSTGRES_PASSWORD` — een sterk wachtwoord
|
|
|
|
`.env` staat in `.gitignore` en komt dus **niet** in git — dat hoort zo.
|
|
|
|
## Starten
|
|
|
|
```bash
|
|
docker compose up -d --build
|
|
```
|
|
|
|
Wat er dan gebeurt: Postgres start, de backend wacht tot de database er is,
|
|
voert automatisch de migraties en `collectstatic` uit, en gunicorn + nginx
|
|
komen op. De app is bereikbaar op:
|
|
|
|
```
|
|
http://<server-host>:8080
|
|
```
|
|
|
|
(Poort `8080` staat ingesteld in `docker-compose.yml` bij de `nginx`-service;
|
|
pas hem daar aan als die poort bezet is.)
|
|
|
|
### Eerste keer: beheerder aanmaken
|
|
|
|
```bash
|
|
docker compose exec backend python manage.py createsuperuser
|
|
```
|
|
|
|
Daarna kun je inloggen op `http://<server-host>:8080/admin/`.
|
|
|
|
## Updaten na nieuwe code
|
|
|
|
```bash
|
|
git pull
|
|
docker compose up -d --build
|
|
```
|
|
|
|
Migraties draaien automatisch mee bij het opstarten van de backend.
|
|
|
|
## Handige commando's
|
|
|
|
| Doel | Commando |
|
|
|------|----------|
|
|
| Logs volgen | `docker compose logs -f` |
|
|
| Alleen backend-logs | `docker compose logs -f backend` |
|
|
| Status containers | `docker compose ps` |
|
|
| Stoppen | `docker compose down` |
|
|
| Stoppen **incl. database wissen** | `docker compose down -v` (let op: gegevens weg!) |
|
|
| Migratie handmatig | `docker compose exec backend python manage.py migrate` |
|
|
| Django-shell | `docker compose exec backend python manage.py shell` |
|
|
|
|
## Aandachtspunten
|
|
|
|
- **HTTPS/domein:** deze opzet draait op poort 8080 zonder TLS. Voor productie
|
|
zet je er een reverse proxy (bv. Caddy of Traefik) vóór die HTTPS regelt, of
|
|
je breidt de nginx-config uit met certificaten. De nginx-container is daar al
|
|
het logische punt voor. **Zet daarna `DJANGO_SECURE=1` in `.env`** — dat
|
|
activeert veilige cookies, HSTS en een https-redirect in Django.
|
|
- **Inloggen verplicht:** de hele API vereist een ingelogde gebruiker; de
|
|
frontend toont eerst een inlogscherm. Maak gebruikers aan via
|
|
`createsuperuser` (zie boven) of in de Django-admin. Modulebeheer is
|
|
voorbehouden aan beheerders (`is_staff`).
|
|
- **Backups:** de database leeft in het volume `pgdata`. Maak hiervan backups,
|
|
bijvoorbeeld met `docker compose exec db pg_dump -U rooster rooster > backup.sql`.
|
|
- **`DJANGO_DEBUG` blijft 0** op de server. Zet hem nooit op 1 in productie.
|
|
- **Test eerst hier, dan productie:** bouw het image één keer, test op deze
|
|
server, en draai exact dezelfde code/compose op de productieserver met een
|
|
eigen `.env`.
|