|
|
|
## Centraal gebruik ##
|
|
|
|
|
|
|
|
De centrale installatie van KIK-Starter zorgt voor een zeer lage instapdrempel om te experimenteren met KIK-Starter zonder iets te installeren. Deze versie van KIK-Starter staat het uploaden van je eigen data niet toe, dus het is alleen mogelijk om te experimenteren met de aangeleverde testdata. Om uw eigen gegevens te gebruiken, kijkt u in het gedeelte over decentraal gebruik hieronder.
|
|
|
|
|
|
|
|
### Gebruik ###
|
|
|
|
|
|
|
|
- Navigeer in een browser naar [decentral.acceptance.starter.kik-v.ocs.nu](https://decentral.acceptance.starter.kik-v.ocs.nu) (of klik op de link)
|
|
|
|
|
|
|
|
## Decentraal gebruik ##
|
|
|
|
# Decentraal gebruik #
|
|
|
|
|
|
|
|
Dit is in de meeste gevallen de beste manier om KIK-Starter te gebruiken, en het is ook de enige manier om KIK-Starter te gebruiken met uw eigen gegevens.
|
|
|
|
|
|
|
|
### Vereisten ###
|
|
|
|
## Vereisten ##
|
|
|
|
|
|
|
|
- [Installeer Docker](https://docs.docker.com/get-docker/)
|
|
|
|
|
|
|
|
### Start Frontend ###
|
|
|
|
## Start Frontend ##
|
|
|
|
|
|
|
|
- Uitvoeren
|
|
|
|
_LET OP: Dit is een testinstallatie en bevat een oudere versie en daarom hoef je voor het testen geen versienummer op te geven._
|
| ... | ... | @@ -24,15 +16,15 @@ docker run -tp 8080:80 -p 8443:443 registry.istandaarden.nl/kik-v/starter/decent |
|
|
|
```
|
|
|
|
waarbij `` <versie> '' de gewenste versie is of `` nieuwste '' om automatisch de nieuwste versie te starten.
|
|
|
|
|
|
|
|
### Aansluiten ###
|
|
|
|
## Aansluiten ##
|
|
|
|
|
|
|
|
- Navigeer in een browser naar [localhost:8080](http://localhost:8080) (of klik op de link)
|
|
|
|
|
|
|
|
### Frontend-configuratie ###
|
|
|
|
## Frontend-configuratie ##
|
|
|
|
|
|
|
|
De frontend is ontworpen om zonder enige configuratie te kunnen worden gebruikt bij gebruik van de applicatie, het eenvoudigste scenario van een enkele gebruiker die de applicatie op zijn eigen computer draait. Voor andere scenario's, zoals het uitvoeren van de applicatie die door meerdere gebruikers wordt gedeeld, is enige configuratie nodig.
|
|
|
|
|
|
|
|
#### TLS-configuratie ####
|
|
|
|
## TLS-configuratie ###
|
|
|
|
|
|
|
|
TLS moet altijd worden gebruikt als de toepassing op een andere computer wordt uitgevoerd dan die van de enige gebruiker. Deze scenario's worden ondersteund, in grove volgorde van complexiteit:
|
|
|
|
|
| ... | ... | @@ -43,11 +35,11 @@ T3) met behulp van een door de gebruiker geleverd certificaat. |
|
|
|
|
|
|
|
Scenario 0 is de standaardinstelling en vereist geen configuratie. Het mag alleen worden gebruikt in een scenario voor één gebruiker.
|
|
|
|
|
|
|
|
##### Zelfondertekend certificaat #####
|
|
|
|
#### Zelfondertekend certificaat ####
|
|
|
|
|
|
|
|
Om de applicatie te gebruiken met een zelfondertekend certificaat, hoeft u alleen maar een hostnaam op te geven met `VKV_HOSTNAME`. De applicatie levert automatisch een zelfondertekend certificaat. Dit betekent dat gebruikers een waarschuwing krijgen en het certificaat handmatig moeten vertrouwen. Zorg ervoor dat u de certificaatopslag koppelt aan permanente opslag (zie hieronder), anders levert de toepassing elke keer een nieuw certificaat, waardoor gebruikers het elke keer moeten accepteren.
|
|
|
|
|
|
|
|
##### Let's Encrypt certificaat #####
|
|
|
|
#### Let's Encrypt certificaat ####
|
|
|
|
|
|
|
|
[Let's Encrypt](https://letsencrypt.org) biedt gratis certificaten van hoge kwaliteit die door de meeste browsers worden vertrouwd. Om dit te gebruiken, moet je VKV-installatie toegankelijk zijn vanaf internet op poort 80 met de naam die is opgegeven in `VKV_HOSTNAME`. Bovendien moet u een e-mailadres opgeven in `VKV_EMAIL`, dat wordt gebruikt voor de uitgifte.
|
|
|
|
|
| ... | ... | @@ -55,11 +47,11 @@ Zorg ervoor dat u de certificaatopslag koppelt aan permanente opslag (zie hieron |
|
|
|
|
|
|
|
Certificaten worden tweemaal daags vernieuwd op willekeurige tijdstippen en bij herstart van de image.
|
|
|
|
|
|
|
|
##### Door gebruiker geleverd certificaat #####
|
|
|
|
#### Door gebruiker geleverd certificaat ####
|
|
|
|
|
|
|
|
Deze optie is voor meer gevorderde gebruikers met meer specifieke behoeften (bijvoorbeeld als u Staat der Nederlanden PKIoverheid certificaten moet gebruiken) of waar de applicatie niet bereikbaar is vanaf internet (dus de standaard Let's Encrypt certificeringsprocedure is niet operationeel). Om dit te laten werken, geeft u `VKV_KEY` en` VKV_CERT_CHAIN` op.
|
|
|
|
|
|
|
|
#### Overzicht configuratieparameters ####
|
|
|
|
### Overzicht configuratieparameters ###
|
|
|
|
|
|
|
|
| parameter | standaard | betekenis | verplicht in scenario's |
|
|
|
|
| ---------------- | ------- | ------- | ---------------------- |
|
| ... | ... | @@ -70,7 +62,7 @@ Deze optie is voor meer gevorderde gebruikers met meer specifieke behoeften (bij |
|
|
|
|
|
|
|
Merk op dat hoewel PEM-certificaten / -sleutels base64-gecodeerde gegevens bevatten, de waarden die aan KIK-Starter worden verstrekt opnieuw base-64-gecodeerd moeten zijn, zodat het na base64-decodering een geldig certificaat / sleutelbestand genereert.
|
|
|
|
|
|
|
|
#### Overzicht toepassingslocatie ####
|
|
|
|
### Overzicht toepassingslocatie ###
|
|
|
|
|
|
|
|
Sommige toepassingslocaties hebben een speciale betekenis en kunnen / zouden moeten worden toegewezen aan permanente locaties met behulp van [bind mounts](https://docs.docker.com/storage/bind-mounts/) of [volumes](https://docs.docker.com/storage/volumes/) (Docker), of met behulp van [persistente volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) (Kubernetes).
|
|
|
|
|
| ... | ... | @@ -82,9 +74,9 @@ In de standaardconfiguratie *hoef je geen* volumes te binden, de applicatie zal |
|
|
|
| `/data/ephemeral` | Kortstondige opslag | Gegevens geüpload door gebruiker | Bewaar geüploade gegevens tussen het opnieuw opstarten van de applicatie. Dit kan handig zijn als de toepassing vaak opnieuw wordt opgestart, maar houd er rekening mee dat deze gegevens gevoelig kunnen zijn. |
|
|
|
|
| `/tls` | Certificaatopslag | TLS-certificaten | Bij gebruik van TLS-scenario's T1 en T2 hierboven. |
|
|
|
|
|
|
|
|
#### Voorbeelden ####
|
|
|
|
### Voorbeelden ###
|
|
|
|
|
|
|
|
##### Verbeterde beveiliging voor één gebruiker #####
|
|
|
|
#### Verbeterde beveiliging voor één gebruiker ####
|
|
|
|
Om de KIK-Starter-frontend uit te voeren met behulp van TLS-scenario T1 (zelfondertekend certificaat), waarbij certificaten worden opgeslagen in de huidige map op het hostsysteem, voert u het volgende uit:
|
|
|
|
|
|
|
|
```
|
| ... | ... | @@ -96,7 +88,7 @@ docker run -tp 8080:80 -p 8443:443 \ |
|
|
|
|
|
|
|
Opmerking: de syntaxis `$ (pwd)` werkt op Unix-achtige systemen (Linux, Max OS X); onder Windows geeft u het volledige pad op, bijvoorbeeld `d: \\ tls`.
|
|
|
|
|
|
|
|
##### Verbeterde beveiliging met Let's Encrypt, snellere start en blijvende uploads tussen herstarts #####
|
|
|
|
#### Verbeterde beveiliging met Let's Encrypt, snellere start en blijvende uploads tussen herstarts ####
|
|
|
|
|
|
|
|
Om de KIK-Starter-frontend uit te voeren met behulp van TLS-scenario T2 (Let's Encrypt-certificaat), het opslaan van certificaten in een `tls`-map onder de huidige map, het opslaan van geüploade gegevens in` data / uploads` en het opslaan van updates van de centrale service in `data / central `, voer uit:
|
|
|
|
|
| ... | ... | @@ -122,4 +114,12 @@ docker run -tp 8080:80 -p 8443:443 \ |
|
|
|
registry.istandaarden.nl/kik-v/volt/frontend: <versie>
|
|
|
|
```
|
|
|
|
|
|
|
|
Zolang de map `/tls` aan hetzelfde hostpad is gebonden, kan KIK-Starter uitzoeken hoe het certificaat indien nodig kan worden vernieuwd. Als de VKV-installatie de externe naam verandert, voer het dan uit met de nieuwe hostnaam in `VKV_HOSTNAME` en het juiste e-mailadres in` VKV_EMAIL` om in plaats daarvan een nieuw certificaat aan te vragen en te gebruiken. |
|
|
\ No newline at end of file |
|
|
|
Zolang de map `/tls` aan hetzelfde hostpad is gebonden, kan KIK-Starter uitzoeken hoe het certificaat indien nodig kan worden vernieuwd. Als de VKV-installatie de externe naam verandert, voer het dan uit met de nieuwe hostnaam in `VKV_HOSTNAME` en het juiste e-mailadres in` VKV_EMAIL` om in plaats daarvan een nieuw certificaat aan te vragen en te gebruiken.
|
|
|
|
|
|
|
|
# Centraal gebruik #
|
|
|
|
|
|
|
|
De centrale installatie van KIK-Starter zorgt voor een zeer lage instapdrempel om te experimenteren met KIK-Starter zonder iets te installeren. Deze versie van KIK-Starter staat het uploaden van je eigen data niet toe, dus het is alleen mogelijk om te experimenteren met de aangeleverde testdata. Om uw eigen gegevens te gebruiken, kijkt u in het gedeelte over decentraal gebruik hieronder.
|
|
|
|
|
|
|
|
## Gebruik ##
|
|
|
|
|
|
|
|
- Navigeer in een browser naar [decentral.acceptance.starter.kik-v.ocs.nu](https://decentral.acceptance.starter.kik-v.ocs.nu) (of klik op de link) |
