Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 5.61 KB

README.md

File metadata and controls

38 lines (28 loc) · 5.61 KB
Raw

ODPC

Lokaal opstarten met Docker Compose

Je kan ODPC lokaal opstarten door het volgende commando uit te voeren in de rootmap van de repository: docker compose up

ODRC als afhankelijkheid in Docker Compose

We hebben ervoor gekozen om ODRC als afhankelijkheid op te nemen in Docker Compose. Dit houdt in dat er een instantie van ODRC wordt opgestart.

De configuratie en benodigde bestanden zijn overgenomen uit De github repository van ODRC. Als daar iets in wijzigt, zullen we dat hier moeten doorvoeren.

Als je met een separate installatie (bijvoorbeeld een testomgeving) van ODRC wil koppelen, moet je de variabelen ODRC_BASE_URL en ODRC_API_KEY aanpassen. Dit kun je ofwel in het docker-compose.yml bestand aanpassen (zorg dat je dit niet incheckt!), ofwel in je user secrets bestand. In het laatste geval moet je de variabelen verwijderen uit het docker-compose.yml bestand.

Standaard wordt bij het draaien van docker compose up de laatste versie van het image van ODRC opgehaald. Als je dit wil forceren kan je het commando docker compose pull odrc-django uitvoeren.

Als je een specifieke versie van het image van ODRC wil vastpinnen, zet je dit in de enviroment variable ODRC_VERSION

Omgevingsvariabelen

Variabele Uitleg
POSTGRES_DB Naam van de database bij ODPC
POSTGRES_USER Gebruikersnaam voor toegang van ODPC tot de DB
POSTGRES_PASSWORD Wachtwoord van de Postgres user
POSTGRES_HOST Hostnaam van de Postgres database server
POSTGRES_PORT Poort om verbinding te maken met de Postgres database server
OIDC_AUTHORITY URL van de OpenID Connect Identity Provider
Meer informatie Bijvoorbeeld: https://login.microsoftonline.com/ce1a3f2d-2265-4517-a8b4-3e4f381461ab/v2.0
OIDC_CLIENT_ID Voor toegang tot de OpenID Connect Identity Provider
Meer informatie Bijvoorbeeld: 54f66f54-71e5-45f1-8634-9158c41f602a
OIDC_CLIENT_SECRET Secret voor de OpenID Connect Identity Provider
Meer informatie Bijvoorbeeld: VM2B!ccnebNe.M*gxH63*NXc8iTiAGhp
OIDC_ROLE_CLAIM_TYPE De naam van de claim in het JWT token van de OpenID Connect Provider waarin de rollen van de ingelogde gebruiker staan.
(default waarde is roles)
OIDC_ADMIN_ROLE De waarde van de role claim in het JWT token van de OpenID Connect Provider voor beheerders
Meer informatie Bijvoorbeeld: odpc-admin
OIDC_ID_CLAIM_TYPE De naam van de claim in het JWT token van de OpenID Connect Provider waarin de unieke identificatie van de ingelogde gebruiker staat.
(default waarde is preferred_username met een fallback op email)
OIDC_NAME_CLAIM_TYPE De naam van de claim in het JWT token van de OpenID Connect Provider waarin de volledige naam van de ingelogde gebruiker staat
(default waarde is name)
ODRC_BASE_URL De base url van de ODRC (Registratiecomponent) waarmee gekoppeld moet worden.
Meer informatie Bijvoorbeeld: https://odrc.mijn-gemeente.nl
ODRC_API_KEY De geheime sleutel voor de ODRC (Registratiecomponent) waarmee gekoppeld moet worden.
Meer informatie Bijvoorbeeld: VM2B!ccnebNe.M*gxH63*NXc8iTiAGhp
UPLOAD_TIMEOUT_MINUTES Het aantal minuten dat het uploaden van bestanden maximaal mag duren.
(default waarde is 10)
DOWNLOAD_TIMEOUT_MINUTES Het aantal minuten dat het downloaden van bestanden maximaal mag duren.
(default waarde is 10)