Wil je een guide of tutorial plaatsen? Mooi. Goede handleidingen zijn precies waarom een forum nuttig blijft.
Een goede guide hoeft niet perfect geschreven te zijn, maar moet wel duidelijk maken wat iemand nodig heeft, welke stappen je volgt en hoe je controleert of het werkt.
Gebruik bij voorkeur deze structuur:
Doel
Wat wil je met deze guide bereiken?
Bijvoorbeeld:
- Jellyfin beschikbaar maken via Nginx Proxy Manager
- een Docker Compose-stack opzetten
- backups maken van Docker-volumes
- een Proxmox LXC voorbereiden
- OPNsense als thuisrouter configureren
Voor wie is deze guide?
Geef kort aan voor wie de handleiding bedoeld is.
Bijvoorbeeld:
- beginners
- mensen met Docker-ervaring
- Proxmox-gebruikers
- Synology-gebruikers
- mensen die al een domeinnaam en reverse proxy hebben
Testomgeving
Vermeld waarop je de guide hebt getest.
Handige punten:
Besturingssysteem:
Installatiemethode: Docker / LXC / VM / bare metal / NAS / VPS
Softwareversie:
Reverse proxy:
DNS-provider:
Bijzonderheden:
Benodigdheden
Wat moet iemand al hebben voordat de guide werkt?
Denk aan:
- een server of VPS
- een domeinnaam
- SSH-toegang
- Docker en Docker Compose
- werkende DNS
- een reverse proxy
- voldoende rechten op het systeem
Stappenplan
Schrijf de stappen zo concreet mogelijk uit.
Tips:
- gebruik korte stappen
- leg uit waar een commando uitgevoerd moet worden
- vermeld of iets op de host, in een container, in een VM of in een webinterface moet gebeuren
- zet commando’s en configuratie in codeblokken
- geef waarschuwingen vóór de stap waar ze relevant zijn
Controle
Laat zien hoe iemand kan controleren of het werkt.
Voorbeelden:
- welke URL moet openen
- welke service actief moet zijn
- welk commando output moet geven
- welke logregel goed of fout is
- welke poorten bereikbaar moeten zijn
Veelvoorkomende fouten
Noem bekende problemen en oplossingen.
Bijvoorbeeld:
- verkeerde rechten op een volume
- DNS wijst nog niet goed
- poort 80 of 443 is al bezet
- reverse proxy gebruikt de verkeerde scheme
- firewall blokkeert verkeer
- container start wel, maar applicatie niet
- mail werkt niet door SPF/DKIM/DMARC of SMTP-authenticatie
Veiligheid
Vermeld veiligheidszaken als die relevant zijn.
Denk aan:
- geen wachtwoorden of tokens delen
- standaardwachtwoorden wijzigen
- MFA inschakelen
- alleen noodzakelijke poorten openen
- backups maken vóór grote wijzigingen
- updates uitvoeren
- rechten beperken waar mogelijk
Terugdraaien
Als het kan, leg kort uit hoe iemand wijzigingen terugdraait.
Bijvoorbeeld:
- container stoppen
- oude configuratie terugzetten
- snapshot herstellen
- DNS-record verwijderen
- firewallregel terugdraaien
Bronnen
Plaats links naar officiële documentatie of nuttige bronnen.
Gebruik liever officiële documentatie dan willekeurige blogposts, zeker bij installaties, security en updates.
Voorbeeldtemplate
Titel:
Doel:
Voor wie:
Testomgeving:
Benodigdheden:
Stappen:
Controle:
Veelvoorkomende fouten:
Veiligheid:
Terugdraaien:
Bronnen:
Een guide hoeft niet in één keer af te zijn. Als je iets later verbetert of aanvult, bewerk je het topic gewoon. Praktisch, getest en duidelijk is belangrijker dan perfect.