diff --git a/README.md b/README.md index c5acbde..5b10c8a 100644 --- a/README.md +++ b/README.md @@ -32,23 +32,87 @@ Archivum är ett självhostat wiki- och dokumenthanteringssystem. Det är tänkt ## Snabbstart med Docker Compose -**1. Skapa en `.env`-fil** i mappen `docker/` (eller i roten): +### Alternativ A — Hämta image från privat registry (rekommenderat) + +Det enklaste sättet att köra Archivum är att hämta en färdigbyggd image från ett privat registry, utan att behöva källkoden. + +**1. Logga in mot ditt registry (om det kräver autentisering):** + +```bash +docker login ditt-registry.example.com +``` + +**2. Skapa en `docker-compose.yml`:** + +```yaml +services: + archivum: + image: ditt-registry.example.com/archivum:latest + container_name: archivum + restart: unless-stopped + ports: + - "${HOST_PORT:-8080}:4000" + environment: + DOCKER_PATH: /config + UI_DIR: /srv/archivum/ui + PUID: ${PUID:-1000} + PGID: ${PGID:-1000} + TZ: ${TZ:-Europe/Stockholm} + volumes: + - ${DOCKER_PATH:-./local}/config:/config + - ${DOCKER_PATH:-./local}/data:/data + networks: + - archivum-net + +networks: + archivum-net: + driver: bridge +``` + +> Om du kör en **reverse proxy** (t.ex. Nginx Proxy Manager eller Traefik) i en separat compose-stack kan du låta dem dela nätverk istället för att exponera porten direkt. Deklarera då det externa nätverket: +> +> ```yaml +> networks: +> proxy-net: +> external: true +> ``` +> +> Och byt ut `archivum-net` mot `proxy-net` i service-definitionen. Ta även bort `ports`-sektionen om proxyn hanterar all trafik. + +**3. Skapa en `.env`-fil i samma katalog som `docker-compose.yml`:** ```env -DOCKER_PATH=/opt/archivum # Host-katalog där config/ och data/ skapas +# Sökväg på hosten där config/ och data/ skapas +DOCKER_PATH=/opt/archivum + +# Port som exponeras på hosten HOST_PORT=8080 + +# Kör containern som denna användare/grupp (kör `id` för att se dina värden) PUID=1000 PGID=1000 + +# Tidszon TZ=Europe/Stockholm ``` -**2. Starta:** +**4. Starta:** ```bash -docker compose -f docker/docker-compose.yml up -d +docker compose up -d ``` -**3. Öppna** `http://localhost:8080` i webbläsaren. Installationsguiden startar automatiskt vid första körningen. +**5. Öppna** `http://localhost:8080` i webbläsaren. Installationsguiden startar automatiskt vid första körningen. + +--- + +### Alternativ B — Bygg imagen lokalt från källkod + +Klona repot och använd den medföljande compose-filen som också bygger imagen: + +```bash +docker compose -f docker/docker-compose.yml up -d --build +``` ---