Skip to content

Commit b0f9397

Browse files
agnetemoosagnetemoos
committed
Forbedret installationsvejledning
1 parent bcb93d8 commit b0f9397

File tree

1 file changed

+159
-20
lines changed

1 file changed

+159
-20
lines changed

‎docs/drift-og-hjemtagelse/installation-og-drift.md

Lines changed: 159 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,166 @@ parent: "Drift og hjemtagelse"
44
nav_exclude: false
55
---
66

7+
## Download OS2BorgerPC Admin indstallationspakke
8+
9+
Den nyeste version af **OS2BorgerPC Admin installationspakken** kan downloades som en tar.gz-pakke via nedenstående link:
10+
11+
[Download OS2BorgerPC Admin](https://github.com/OS2borgerPC/os2borgerpc-admin-site-deployment/releases/latest){: .btn .btn-blue }
12+
13+
14+
## Installationsvejledning
15+
Installationspakken er testet på Ubuntu Server 22.04 og 24.04.
16+
17+
### Forudsætninger
18+
Før du begynder, skal du sikre dig, at følgende er installeret på dit system:
19+
1. **Docker**: Installer [Docker Engine](https://docs.docker.com/engine/install/) (version 20.10 eller nyere). Sørg for at den bruger, som du vil installere med, har de nødvendige rettigheder til at køre Docker-kommandoer ved at gøre brugeren til medlem af `docker`-gruppen).
20+
21+
2. **Docker Compose**: [Installer Docker Compose v2](https://docs.docker.com/compose/install/linux/).
22+
23+
3. **Task**: Installer [Taskfile](https://taskfile.dev/#/installation). Task er et automatiseringsværktøj som som installationspakken bygger på.
24+
25+
26+
### Tjek at forudsætninger virker som de skal
27+
28+
Kør følgende kommandoer for at verificere, at forudsætningerne er installeret:
29+
30+
```bash
31+
# Kontroller Docker-installation
32+
docker --version
33+
34+
# Kontroller Docker Compose-installation
35+
docker compose version
36+
37+
# Kontroller Taskfile CLI-installation
38+
task --version
39+
```
40+
41+
### Download og udpak
42+
Download OS2BorgerPC Admin installationspakken. [Her er link til seneste release.](https://github.com/OS2borgerPC/os2borgerpc-admin-site-deployment/releases/latest)
43+
44+
Brug f. eks. kommandoen `wget <URL>` til at downloade.
45+
46+
Udpak den downloadede fil:
47+
48+
```bash
49+
# Opretter en mappe til systemet
50+
mkdir -p os2borgerpc-admin
51+
# Udpakker til mappen
52+
tar -xvzf <FILNAVN>.tar.gz -C os2borgerpc-admin
53+
```
54+
### Installation med task
55+
Kør `task`. Der vises en menu med alle tilgængelige kommandoer.
56+
57+
```bash
58+
# Gå ind i mappen
59+
cd os2borgerpc-admin
60+
# List alle tilgængelige kommandoer
61+
task
62+
```
63+
Menuen ser sådan ud:
64+
```bash
65+
task: Available tasks for this project:
66+
* default: The default task that shows help
67+
* down: Remove all containers and volumes
68+
* install: Install the project
69+
* reinstall: Reinstall from scratch. Removes the database, all containers, and volumes.
70+
* stop: Stop all containers without altering anything else
71+
* up: Take the environment up without altering the existing state of the containers
72+
* upgrade: Upgrades the admin site to a newer version
73+
```
74+
Man installerer ved at køre denne kommando:
75+
76+
```bash
77+
task install
78+
```
79+
Der er nogle præ-installations krav, der skal være opfyldt. Læs mere om præ-installationskravene her.
80+
81+
Tast `yes` for at fortsætte.
82+
83+
```bash
84+
====================================================
85+
Pre-installation Requirements
86+
====================================================
87+
88+
To proceed with the installation, ensure the following steps are completed:
89+
1. Update '.env'. Change the passwords and secret keys.
90+
2. Place your SSL certificate files ('nginx.crt' and 'nginx.key') in the 'ssl' directory.
91+
92+
Have you completed the above pre-installation steps? (yes/no)
93+
```
94+
95+
Installationen kører færdig uden yderligere interaktion.
96+
97+
Til slut vises info om, hvordan du logger ind. Det der vises afhænger af dine indstillinger i `.env`:
98+
99+
```bash
100+
====================================================
101+
OS2Borgerpc Admin is now available via the URLs below
102+
====================================================
103+
Admin: https://display-devs.sonderborg.dk
104+
Django Backend: https://display-devs.sonderborg.dk/admin
105+
====================================================
106+
You can log in with the following credentials:
107+
Username: admin
108+
Password: admin
109+
```
110+
111+
### Præ-installationskrav
112+
Lokale systemindstillinger sættes i filen `.env`.
113+
114+
Kopier filen `.env.example.` til `.env`.
115+
116+
```bash
117+
cp .env.example .env
118+
```
119+
120+
Åbn `.env` i en text editor som f. eks. `nano`.
121+
122+
```bash
123+
nano .env
124+
```
125+
126+
Af sikkerhedshensyn opdaterer ALTID disse indstillinger med dine egne værdier:
127+
- `DOMAIN`: Dit domænenavn som skal matche dit SSL certifikat
128+
- `DB_PASSWORD`: Angiv et stærkt password
129+
- `SECRET_KEY`: Angiv en stærk nøgle.
130+
131+
132+
### Oversigt over systemindstillinger
133+
134+
| Variabel | Forklaring | Standardværdi | Påkrævet |
135+
|------------------------------|----------------------------------------------------------------------------|-------------------------------------------------------|----------|
136+
| `DOMAIN` | Domænenavn for applikationen | `demo.os2borgerpc.dk` | Ja |
137+
| `VERSION` | Version af applikationen. Find versionsnummer for seneste version her: https://github.com/OS2borgerPC/os2borgerpc-admin-site/releases | `7.0.1` | Ja |
138+
| `DB_HOST` | Databasevært | `db` | Ja |
139+
| `DB_NAME` | Navn på databasen | `bpc` | Ja |
140+
| `DB_USER` | Brugernavn til databasen | `bpc` | Ja |
141+
| `DB_PASSWORD` | Adgangskode til databasen | `bpc` | Ja |
142+
| `DB_PORT` | Databaseport | Ingen | Nej |
143+
| `ALLOWED_HOSTS` | Hvis din applikation er tilgængelig via internettet, kan adgangen begrænses til enheder fra dit netværk. Tilføj dine offentlige udgående IP-adresse til ALLOWED_HOSTS. Andre, der forsøger at forbinde, vil få et 404 svar. | `*` | Ja |
144+
| `CORE_SCRIPT_VERSION_TAG` | Version af de globale scripts. Find versionsmummer for seneste version her: https://github.com/OS2borgerPC/os2borgerpc-core-scripts/releases | `v1.0.1` | Ja |
145+
| `CORE_SCRIPT_COMMIT_HASH` | Hver version af globale scripts har et matchende commit-hash. Find det i release beskrivelsen her: https://github.com/OS2borgerPC/os2borgerpc-core-scripts/releases | `a96d19567bf5c002c76d16cf80f6c894c2af499` | Ja |
146+
| `PC_IMAGE_RELEASES_URL` | URL til download af BorgerPC ISO images | `https://github.com/OS2borgerPC/os2borgerpc-image/releases` | Nej |
147+
| `KIOSK_IMAGE_RELEASES_URL` | URL til download af Kiosk ISO images | `https://github.com/OS2borgerPC/os2borgerpc-kiosk-image/releases` | Nej |
148+
| `DEBUG` | Aktiverer debug-tilstand i Django | `True` | Nej |
149+
| `SECRET_KEY` | Hemmelig nøgle til Django | `v3rys1kr3t` | Ja |
150+
| `ADMIN_USERNAME` | Brugernavn for admin-bruger | `admin` | Ja |
151+
| `ADMIN_EMAIL` | Email for admin-bruger. Kan ændres i GUI efter installation (Hovedmenu > Brugere). | `os2borgerpc_admin@os2borgerpc-vendor.example` | Ja |
152+
| `ADMIN_PASSWORD` | Adgangskode for admin-bruger. Ændres i GUI efter installation (Hovedmenu > Brugere). | `admin` | Ja |
153+
| `TIME_ZONE` | Tidszone for applikationen | `Europe/Copenhagen` | Ja |
154+
| `LANGUAGE_CODE` | Sprogkode for applikationen | `da-dk` | Ja |
155+
| `INITIALIZE_DATABASE` | Initialiserer databasen ved første kørsel | `True` | Nej |
156+
| `LOG_LEVEL` | Logniveau for applikationen | `INFO` | Nej |
157+
| `CICERO_URL` | URL for Cicero-server | `CICERO_SERVER_HERE` | Nej |
158+
| `CITIZEN_LOGIN_API_VALIDATOR`| Validator for citizen login API | `system.utils.always_validate_citizen` | Nej |
159+
| `USE_X_FORWARDED_HOST` | Aktiverer brug af `X-Forwarded-Host` header bag proxy | `True` | Nej |
160+
| `SECURE_PROXY_SSL_HEADER` | Header til at indikere SSL bag proxy | `('HTTP_X_FORWARDED_PROTO', 'https')` | Nej |
161+
162+
163+
---
7164
## Introduktion
165+
166+
8167
**OS2BorgerPC admin-site** er designet som et Docker-image. Bygning og publicering håndteres af en [GitHub-pipeline](https://github.com/OS2borgerPC/os2borgerpc-admin-site/actions/workflows/docker-image.yml), som uploader Docker-image'et til [GitHub Packages](https://github.com/orgs/OS2borgerPC/packages?repo_name=os2borgerpc-admin-site). Her kan du finde image-tags og URLs.
9168

10169
Konfiguration sker via miljøvariabler (beskrevet nedenfor) og omfatter desuden specifikationer for driftskrav. En `compose.yaml`-fil leveres som reference til udvikling og konfiguration.
@@ -13,26 +172,6 @@ Konfiguration sker via miljøvariabler (beskrevet nedenfor) og omfatter desuden
13172

14173
---
15174

16-
## Oversigt over Miljøvariabler
17-
18-
| Variabel | Forklaring | Standardværdi | Påkrævet |
19-
|------------------------------|----------------------------------------------------------------------------|-----------------|----------|
20-
| `ADMIN_USERNAME` | Brugernavn for admin-bruger | Ingen | Ja |
21-
| `ADMIN_PASSWORD` | Adgangskode for admin-bruger | Ingen | Ja |
22-
| `ADMIN_EMAIL` | Email for admin-bruger | Ingen | Ja |
23-
| `DB_HOST` | Databasevært | Ingen | Ja |
24-
| `DB_PORT` | Databaseport | Ingen | Ja |
25-
| `DB_USER` | Brugernavn til databasen | Ingen | Ja |
26-
| `DB_PASSWORD` | Adgangskode til databasen | Ingen | Ja |
27-
| `DB_NAME` | Navn på databasen | Ingen | Ja |
28-
| `CORE_SCRIPT_VERSION_TAG` | Version af de globale scripts | Ingen | Ja |
29-
| `CORE_SCRIPT_COMMIT_HASH` | Matchende commit-hash for scripts | Ingen | Ja |
30-
| `HTTPS_GUARANTEED` | Aktiverer behandling af HTTP som HTTPS bag proxy | false | Nej |
31-
| `PC_IMAGE_RELEASES_URL` | URL til download af BorgerPC ISO images | Ingen | Nej |
32-
| `KIOSK_IMAGE_RELEASES_URL` | URL til download af Kiosk ISO images | Ingen | Nej |
33-
34-
---
35-
36175
## Drift Anbefalinger
37176

38177
For at understøtte leverandører og kommuner i at sætte OS2BorgerPC admin-site i drift samt håndtere opgraderinger anbefales følgende fremgangsmåde:

0 commit comments

Comments
 (0)