diff --git a/README.md b/README.md index 80a422a..a43b696 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,33 @@ Web UI for managing an existing dockerized [Caddy](https://caddyserver.com/) ins ## Setup -### 1. Clone and configure +### 1. Create a `docker-compose.yml` -```bash -git clone https://git.d4nn13.de/d4nn13/KonCad /opt/KonCad +```yaml +services: + koncad: + image: git.d4nn13.de/d4nn13/koncad:latest + restart: unless-stopped + ports: + - "8080:80" + volumes: + - koncad_data:/data + - /opt/caddy:/caddy:ro + environment: + CADDY_ADMIN_URL: http://caddy:2019 + CADDYFILE_IMPORT: /caddy/Caddyfile + networks: + - caddy-network + +volumes: + koncad_data: + +networks: + caddy-network: + external: true ``` -Edit `docker-compose.yml` to match your environment: +Adjust to match your environment: | Setting | Description | |---|---| @@ -36,8 +56,13 @@ Edit `docker-compose.yml` to match your environment: ### 2. Start ```bash -cd /opt/KonCad -docker compose up -d --build +docker compose up -d +``` + +### Updating + +```bash +docker compose pull && docker compose up -d ``` KonCad is available at `http://:8080`.