Add docker-compose file for dev

.github/workflows/build-docker-image.yml

@@ -33,7 +33,7 @@ jobs:
         uses: docker/setup-buildx-action@v3
 
       - name: Log in to the container registry
-        if: github.event_name != 'pull_request'
+        if: ${{ github.event_name != 'pull_request' && !env.ACT }}
         uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
@@ -54,7 +54,7 @@ jobs:
       - name: Build and push Docker image
         uses: docker/build-push-action@v5
         with:
-          push: ${{ github.event_name != 'pull_request' }}
+          push: ${{ github.event_name != 'pull_request' && !env.ACT }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           build-args: |

.gitignore

@@ -1,7 +1,5 @@
-/config
-/data
-
-docker-compose.*
+docker/data
+docker/config
 
 .vscode/
 .idea/

README.md

@@ -16,7 +16,7 @@ A set of <a href="https://github.com/gawel/irc3">irc3</a> plugins providing vari
 
 Requirements:
 
-* PostgreSQL
+- PostgreSQL
 
 ## Setting up the development environment
 
@@ -32,6 +32,15 @@ uv run pre-commit install
 
 ## Running
 
+### Docker
+
+```sh
+cp docker/.env.example docker/.env # Open and set any empty variables
+docker compose -f docker/docker-compose.dev.yml up --build --pull always
+```
+
+### Manual
+
 ```sh
 cp config.ini.dist config.ini
 $EDITOR config.ini

docker/.env.example

@@ -0,0 +1,4 @@
+CFG_BOT_NICK=
+CFG_BOT_USERNAME=
+CFG_BOT_REALNAME=
+CFG_IRC_HOST=

docker/docker-compose.dev.yml

@@ -0,0 +1,57 @@
+services:
+  cappuccino:
+    container_name: cappuccino
+    restart: "no"
+    init: true
+    read_only: true
+    user: ${PUID:-1000}:${PGID:-1000}
+    depends_on:
+      db:
+        condition: service_healthy
+    env_file: .env
+    environment:
+      CFG_BOT_NICK: ${CFG_BOT_NICK:?}
+      CFG_BOT_REALNAME: ${CFG_BOT_REALNAME:?}
+      CFG_BOT_USERNAME: ${CFG_BOT_USERNAME:?}
+      CFG_DB_URI: ${CFG_DB_URI:-postgresql://${DB_USER:-cappuccino}:${DB_PASSWORD:-cappuccino}@${DB_HOST:-db}/${DB_NAME:-cappuccino}}
+      CFG_IRC_HOST: ${CFG_IRC_HOST:?}
+      CFG_IRC_PORT: ${CFG_IRC_PORT:-6697}
+      CFG_IRC_SSL: ${CFG_IRC_SSL:-true}
+    volumes:
+      - /etc/localtime:/etc/localtime:ro
+      - ${BASE_DIR:-.}/config/app:/config
+      - ../:/app:ro
+    tmpfs:
+      - /tmp
+    networks:
+      - cappuccino
+    build:
+      context: ../
+
+  db:
+    image: postgres:17-alpine
+    container_name: cappuccino_db
+    restart: "no"
+    user: ${PUID:-1000}:${PGID:-1000}
+    env_file: .env
+    environment:
+      POSTGRES_DB: ${DB_NAME:-cappuccino}
+      POSTGRES_PASSWORD: ${DB_PASSWORD:-cappuccino}
+      POSTGRES_USER: ${DB_USER:-cappuccino}
+    volumes:
+      - ${BASE_DIR:-.}/data/postgresql:/var/lib/postgresql/data
+    networks:
+      - cappuccino
+    healthcheck:
+      test:
+        [
+          "CMD-SHELL",
+          "pg_isready -q --username=$$POSTGRES_USER --host=$$POSTGRES_HOST",
+        ]
+      start_period: 5s
+      start_interval: 1s
+      interval: 10s
+      timeout: 1s
+
+networks:
+  cappuccino: