feat: add docker support

Author: realtlos

.gitignore

@@ -1,4 +1,5 @@
 config.json
+config.docker.json
 potat-api
 perm
 dump

Dockerfile

@@ -0,0 +1,24 @@
+# syntax=docker/dockerfile:1.7
+
+FROM golang:1.23 AS builder
+WORKDIR /src
+
+# Cache mod download layer
+COPY go.mod go.sum ./
+RUN --mount=type=cache,target=/go/pkg/mod \
+    go mod download
+
+COPY . .
+RUN --mount=type=cache,target=/go/pkg/mod \
+    CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o potat-api ./
+
+FROM gcr.io/distroless/base-debian12 AS runner
+WORKDIR /app
+
+COPY --from=builder /src/potat-api /app/potat-api
+COPY exampleconfig.json /app/exampleconfig.json
+COPY --from=builder /src/haste/static /app/haste/static
+
+EXPOSE 8080
+
+ENTRYPOINT ["/app/potat-api"]

README.md

@@ -15,6 +15,12 @@ On startup if the required Postgres tables for haste, url shortener, or image ho
 - Optionally install [ClickHouse](https://clickhouse.com/docs/en/quick-start), and [RabbitMQ](https://www.rabbitmq.com/docs/download) if enabling the PotatBotat backend, and [Prometheus](https://prometheus.io/docs/prometheus/latest/installation/) if enabling metrics
 - Populate `exampleconfig.json` with the database credentials, and ports for services you want to run. It will be renamed on startup.
 
+### To run with Docker
+
+- Copy `config.docker.json.example` to `config.docker.json` and fill in your credentials
+- Run `docker compose up --build -d`
+- API will be available at `http://localhost:8080`
+
 ### Example Chatterino uploader configuration
 
 

config.docker.json.example

@@ -0,0 +1,63 @@
+{
+  "twitch": {
+    "client_id": "your_twitch_client_id",
+    "client_secret": "your_twitch_client_secret",
+    "oauth_uri": "http://localhost:8080"
+  },
+  "loops": {
+    "enabled": false
+  },
+  "nats": {
+    "enabled": false
+  },
+  "api": {
+    "enabled": true,
+    "host": "0.0.0.0",
+    "port": "8080"
+  },
+  "socket": {
+    "enabled": false,
+    "host": "0.0.0.0",
+    "port": "8090"
+  },
+  "redirects": {
+    "enabled": false,
+    "host": "0.0.0.0",
+    "port": "8091"
+  },
+  "uploader": {
+    "authkey": "your_uploader_auth_key",
+    "enabled": false,
+    "port": "8092",
+    "host": "0.0.0.0"
+  },
+  "haste": {
+    "enabled": false,
+    "host": "0.0.0.0",
+    "port": "8081",
+    "keyLength": 6
+  },
+  "prometheus": {
+    "enabled": false,
+    "host": "0.0.0.0",
+    "port": "9100"
+  },
+  "postgres": {
+    "host": "postgres",
+    "port": "5432",
+    "database": "potat",
+    "user": "potat",
+    "password": "potat"
+  },
+  "clickhouse": {
+    "host": "clickhouse",
+    "port": "9000",
+    "database": "potat",
+    "user": "default",
+    "password": ""
+  },
+  "redis": {
+    "host": "redis",
+    "port": "6379"
+  }
+}

docker-compose.yml

@@ -0,0 +1,75 @@
+version: "3.9"
+
+services:
+  potat-api:
+    build:
+      context: .
+      target: runner
+    image: potat-api:local
+    depends_on:
+      postgres:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+      clickhouse:
+        condition: service_healthy
+    ports:
+      - "8080:8080"
+    volumes:
+      - ./config.docker.json:/app/config.json:ro
+    restart: unless-stopped
+
+  postgres:
+    image: postgres:16
+    environment:
+      POSTGRES_USER: potat
+      POSTGRES_PASSWORD: potat
+      POSTGRES_DB: potat
+    ports:
+      - "5432:5432"
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U $$POSTGRES_USER"]
+      interval: 5s
+      timeout: 5s
+      retries: 12
+    restart: unless-stopped
+
+  redis:
+    image: redis:7
+    ports:
+      - "6379:6379"
+    volumes:
+      - redis_data:/data
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 5s
+      timeout: 3s
+      retries: 20
+    restart: unless-stopped
+
+  clickhouse:
+    image: clickhouse/clickhouse-server:24.8
+    environment:
+      CLICKHOUSE_DB: potat
+      CLICKHOUSE_USER: default
+      CLICKHOUSE_PASSWORD: ""
+      CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: "1"
+    ports:
+      - "9000:9000"
+    volumes:
+      - clickhouse_data:/var/lib/clickhouse
+      - clickhouse_logs:/var/log/clickhouse-server
+    healthcheck:
+      test: ["CMD-SHELL", "clickhouse-client --query 'SELECT 1'"]
+      interval: 10s
+      timeout: 5s
+      retries: 12
+    restart: unless-stopped
+
+volumes:
+  postgres_data:
+  redis_data:
+  clickhouse_data:
+  clickhouse_logs: