Eerste Administrator Guide draft

Tibo De Peuter 2025-03-06 15:22:18 +01:00
parent da01065d04
commit 66087c55e9

@ -0,0 +1,113 @@
Welkom bij de Dwengo-1 Administrator handleiding. Deze handleiding beschrijft de administratietaken voor Dwengo-1, het interactieve leerplatform. Dwengo-1 is een full-stack applicatie.
**Doelpubliek**
Deze handleiding is gericht aan de gebruikers die hun eigen Dwengo-1 server willen installeren, instellen en optimaliseren. Voor meer informatie over de gebruikersinterface, zie [de handleiding voor leerkrachten](#TODO) en [de handleiding voor leerlingen](#TODO).
## Installatie en server configuratie
### Systeemvereisten
Voor de beste performantie, stabiliteit en functionaliteit raden we de volgende systeemvereisten aan.
| Platform | Options |
| :--- | :--- |
| Operating System (64-bit) | <ul><li>Ubuntu 24.04 LTS</li><li>**Ubuntu 22.04 LTS** (aangeraden)</li><li>**Red Hat Enterprise Linux 9** (aangeraden)</li><li>Red Hat Enterprise Linux 8</li><li>Debian 12 (Bookworm)</li><li>Alpine Linux</li></ul> |
| Database | PostgreSQL 13/14/15/16/17 |
| Webserver | Nginx |
### Installatie op Linux
Er zijn verschillende manieren om Dwengo-1 te installeren afhankelijk van uw voorkeuren, vereisten en toepassingen.
Als u een geautomatiseerde installatie verkiest, dan heeft u keuze uit:
- gebruik de [Dwengo-1 Docker image(s)](#TODO). Deze image is ... WIP
Als u liever installeert vanaf de broncode, dan kan u Dwengo-1 opzetten vanaf scratch. Deze handleiding doorloopt alle stappen die nodig zijn om Dwengo-1 te installeren op Ubuntu 24.04 LTS met Nginx en PostgreSQL, gebruik makende van [de Dwengo-1 .tar](#TODO-link-naar-github-release). Deze methode wordt aangeraden om Dwengo-1 te installeren.
Deze handleiding biedt een overzicht van de stappen die je moet doorlopen om Dwengo-1 te installeren. Voor een handleiding specifiek voor je distributie, zie [Voorbeeldinstallatie op Ubuntu 22.04 LTS](#TODO-link-naar-subpart).
**Vereisten voor handmatige installatie**
WIP
**Nginx Web server configuratie**
WIP
**SSL aanzetten**
WIP
### Voorbeeldinstallatie op Ubuntu 22.04 LTS
De packages die nodig zijn voor een typische Dwengo-1 installatie, gebruik makend van Nginx en PostgreSQL, kunnen geïnstalleerd worden door het volgende commando in een terminal uit te voeren:
```shell
sudo apt update && sudo apt upgrade
sudo apt install nginx postgres
```
- Dit commando installeert de packages voor de basis van Dwengo-1. Houd er rekening mee dat als u plant een bijzondere configuratie te gebruiken, het mogelijk is dat u extra packages nodig zal hebben.
Nu moet u een database gebruiker en database maken via de Postgres command line interface. De database tabellen zullen gemaakt worden door Dwengo-1 als je de applicatie voor de eerste keer opstart.
Om Postgres in command line mode te starten, gebruik het volgende commando:
```shell
psql
```
Er verschijnt een prompt `>`. Vul daar de volgende lijnen in, waarin je `username` en `password` vervangt door de juiste waarden, en bevestig de lijnen met de Enter toets:
```shell
CREATE USER.... WIP
```
Je kan het prompt stoppen door `quit;` in te geven.
Download nu een archief van de laatste Dwengo-1 versie:
- Ga naar de [Dwengo-1 release pagina](#TODO-link-naar-releases).
- Vind de laatste release of een release naar uw keuze en download ofwel het `.tar.bz2` of `.zip` archief.
- Dit download een bestand met als naam `dwengo-1-x.y.z.tar.bz2` of `dwengo-1-x.y.z.zip` (waarbij `x.y.z` een versienummer is).
- Extraheer de inhoud van het archief. Voer het juiste commando uit voor uw type archief:
```shell
tar -xjvf dwengo-1-x.y.z.tar.bz2
unzip dwengo-1-x.y.z.zip
```
- Dit pakt een map uit `dwengo-1`. Kopieer de Dwengo-1 map naar zijn uiteindelijke bestemming. (TODO Juiste map voor Nginx suggereren.)
```shell
TODO Voorbeeld commando van cp commando
```
- Verander als laatste stap de eigenaar van de mappen naar jouw HTTP gebruiker (TODO Als dat relevant is voor Nginx)
```shell
TODO Voorbeeld commando van chown commando
```
**Backend**
WIP
**Frontend**
WIP
## Dwengo-1 configuratie
WIP
## Gebruikers beheren
WIP
## Onderhoud
WIP