Skip to content

Commit

Permalink
Merge pull request #1134 from rodekruis/lotjeredcross-patch-1
Browse files Browse the repository at this point in the history
Update Guide-How_to_set_up_an_instance.md
  • Loading branch information
elwinschmitz authored Oct 22, 2024
2 parents 1b5fc6c + eb9cc25 commit 6a117ee
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/Guide-How_to_set_up_an_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,28 @@ See the GitHub-repository website to find out how it works and how to use it.

- [ ] Go to the file: `.github/workflows/deploy-github-pages.yml` and click "**Edit this file**" (pencil icon)
- [ ] Configure the necessary variables; see comment lines to understand what each variable does
- [ ] Specifically make sure to fill in the `Google Spreadsheet ID` under `REGIONS_SHEET_IDS` (and remove the default/placeholder value)
- [ ] Save/Commit the changes
- [ ] Verify the deployment is triggered by going to the "**Actions**"-tab and checking the latest run
- [ ] After a successful run, the instance should be available on the chosen URL

- (Optional) Configure a custom (sub-)domain-name to use as public URL. (Applicable for [Solution 3](#solution-3-custom-domain-name) and [Solution 4](#solution-4-custom-sub-domain-name)

- Edit the file: `.github/workflows/deploy-github-pages.yml`, below the line:

```yml
# NOTE: When the instance will be run on a custom (sub-)domain, remove the `--base-href`-flag+value.
```

So that it looks like:

```yml
run: 'npm run build:production -- --output-path=../www'
```

- On the GitHub repository-page, go to: "Settings" → "Pages" → "Custom domain" and fill in the applicable public URL
- GitHub will validate the DNS-records for the (sub-)domain

- ✅ Done.

Editors can now see their content-changes on the public URL.
Expand Down

0 comments on commit 6a117ee

Please sign in to comment.