Skip to content

Commit

Permalink
Merge pull request #304 from ConductionNL/feature/update-installatie.md
Browse files Browse the repository at this point in the history
feature/update-installatie.md
  • Loading branch information
remko48 authored Apr 29, 2024
2 parents edc759e + b8a4a35 commit ae336a9
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 21 deletions.
58 changes: 37 additions & 21 deletions docs/techniek/Installatie.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,30 @@ De Open WOO Website is in eerste instantie opgezet om serverless gebruikt te wor
> **Stappen**
>
> 1. Rechtsboven deze repo staat een knop ["gebruiken als template"](https://github.com/new?template_name=woo-website-template&template_owner=ConductionNL), druk daarop (of [klik hier](https://github.com/new?template_name=woo-website-template&template_owner=ConductionNL)) en maak een nieuwe repository aan op je GitHub-organisatie.
> 2. Ga in de repository naar de folder `.github/workflows/`
> 3. Verwijder de workflow `product-page-deploy` als deze er nog staat
> 4. Open de workflow `woo-page-deploy` en pas de branche aan van `never` naar `main`
> 5. Pas de verdere configuratie in `woo-page-deploy` aan zoals hieronder vermeld onder configuratie en sla deze op
> 6. Ga naar acties en wacht tot de actie "Deploy the WOO Page to GitHub Pages" succesvol is afgerond
> 7. Ga naar settings->pages, selecteer onder source `deploy from branch` en geef als branche op `gh-pages`
> 8. Bovenaan de pagina verschijnt nu de URL waarop je je Open WOO Website kunt terugvinden
> 9. Als je de Open WOO Website wilt hosten onder een subdomein van je organisatie en voorzien van een PKI-certificaat, kun je daarvoor de normale GitHub Pages-handleidingen volgen of een SLA afsluiten voor ondersteuning (zie [kosten](/docs/product/Kosten.md))
> 2. [Zet de workflow permissions](#workflow-permissions) op `Read and write permissions`.
> 3. Ga op de main branch in de repository naar de folder `.github/workflows/`
> 4. Verwijder de workflow `product-page-deploy` als deze er nog staat
> 5. Open de workflow `woo-page-deploy` en pas de branche aan van `never` naar `main`
> 6. Pas de verdere configuratie in `woo-page-deploy` aan zoals [hieronder vermeld onder configuratie](#configuratie) en sla deze op
> 7. Ga naar acties en wacht tot de actie "Deploy the WOO Page to GitHub Pages" succesvol is afgerond
> 8. Ga naar settings -> pages, selecteer onder source `deploy from branch` en geef als branche op `gh-pages`
> 9. Bovenaan de pagina verschijnt nu de URL waarop je je Open WOO Website kunt terugvinden
> 10. Als je de Open WOO Website wilt hosten onder een subdomein van je organisatie en voorzien van een PKI-certificaat, kun je daarvoor de normale GitHub Pages-handleidingen volgen of een SLA afsluiten voor ondersteuning (zie [kosten](/docs/product/Kosten.md))
#### Workflow Permissions

> **Stappen**
>
> 1. Ga naar Settings
> 2. Ga naar Actions
> 3. Ga naar General.
>
> ![settings-action](settings-action.png)
>
> 4. Scroll naar Workflow permissions.
> 5. Set permissions naar `Read and write permissions`.
> ![Workflow permissions](workflow-permissions.png)
### Server Installatie

Expand All @@ -45,19 +61,19 @@ Als je de OpenWoo-website liever vanaf een eigen server draait, kan dat uiteraar

Configuratie vindt plaats via environment (env) waardes. In het geval van een serverless configuratie moeten de env-waardes worden aangepast in de [page deploy workflow](https://github.com/ConductionNL/woo-website-template/blob/main/.github/workflows/product-page-deploy.yml). In het geval van een serverinstallatie in het `.env`-bestand in de Gatsby-rootmap. We ondersteunen de volgende configuratie-opties.

| Key | Verplicht | Usage | Allowed Value | Default / Example |
|---------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------|
| GITHUB_PAGES_BRANCH | Alleen bij serverless | De branche waarop de pagina wordt gebouwd | string, max 255 characters | gh-pages |
| GITHUB_REPOSITORY_NAME | Alleen bij serverless | | string, max 255 characters | `${{ github.event.repository.name }}` |
| API_BASE_URL | Ja | De locatie van de Open Woo API | string <URL>, string, max 255 characters | "<https://api.gateway.commonground.nu/api>" |
| NL_DESIGN_THEME_CLASSNAME | Ja | De naam van het thema van de organisatie | string, max 255 characters | "conduction-theme" |
| FAVICON_URL | Ja | De locatie van de favicon van de organisatie | string <URL>, max 255 characters | "<https://conduction.nl/wp-content/uploads/2021/07/cropped-favicon-32x32.png>" |
| HEADER_LOGO_URL | Ja | De locatie van het primaire logo van de organisatie | string, moet een base encoded afbeelding zijn OF url | "<https://conduction.nl/wp-content/uploads/2021/07/cropped-conductionlogo-1.png>" |
| ORGANISATION_NAME | Ja | De naam van de organisatie | string, max 255 characters | "Conduction" |
| JUMBOTRON_IMAGE_URL | Nee | De locatie van de gebruikte header, bij leeg wordt er geen header getoond | string <URL>, max 255 characters | "<https://www.conduction.nl/wp-content/uploads/2021/07/cropped-Conduction_HOME_0000_afb1-1.png>" |
| FOOTER_LOGO_URL | Ja | De locatie van het primaire logo van de organisatie | string, moet een base encoded afbeelding zijn OF url | ... |
| FOOTER_LOGO_HREF | Ja | De homepage van de organisatie | string <URL>, max 255 characters | "<https://conduction.nl/>" |
| OIDN_NUMBER | Nee | Het OIDN-nummer van de organisatie, bij leeg worden Woo-publicaties mogelijk niet beperkt tot de eigen organisatie | integer, max 16 characters | 1234567890 |
| Key | Verplicht | Usage | Allowed Value | Default / Example |
| ------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| GITHUB_PAGES_BRANCH | Alleen bij serverless | De branche waarop de pagina wordt gebouwd | string, max 255 characters | gh-pages |
| GITHUB_REPOSITORY_NAME | Alleen bij serverless | | string, max 255 characters | `${{ github.event.repository.name }}` |
| API_BASE_URL | Ja | De locatie van de Open Woo API | string <URL>, string, max 255 characters | "<https://api.gateway.commonground.nu/api>" |
| NL_DESIGN_THEME_CLASSNAME | Ja | De naam van het thema van de organisatie | string, max 255 characters | "conduction-theme" |
| FAVICON_URL | Ja | De locatie van de favicon van de organisatie | string <URL>, max 255 characters | "<https://conduction.nl/wp-content/uploads/2021/07/cropped-favicon-32x32.png>" |
| HEADER_LOGO_URL | Ja | De locatie van het primaire logo van de organisatie | string, moet een base encoded afbeelding zijn OF url | "<https://conduction.nl/wp-content/uploads/2021/07/cropped-conductionlogo-1.png>" |
| ORGANISATION_NAME | Ja | De naam van de organisatie | string, max 255 characters | "Conduction" |
| JUMBOTRON_IMAGE_URL | Nee | De locatie van de gebruikte header, bij leeg wordt er geen header getoond | string <URL>, max 255 characters | "<https://www.conduction.nl/wp-content/uploads/2021/07/cropped-Conduction_HOME_0000_afb1-1.png>" |
| FOOTER_LOGO_URL | Ja | De locatie van het primaire logo van de organisatie | string, moet een base encoded afbeelding zijn OF url | ... |
| FOOTER_LOGO_HREF | Ja | De homepage van de organisatie | string <URL>, max 255 characters | "<https://conduction.nl/>" |
| OIDN_NUMBER | Nee | Het OIDN-nummer van de organisatie, bij leeg worden Woo-publicaties mogelijk niet beperkt tot de eigen organisatie | integer, max 16 characters | 1234567890 |

## Backend

Expand Down
Binary file added docs/techniek/settings-action.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/techniek/workflow-permissions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ae336a9

Please sign in to comment.