docker-compose.example.yml

# Example Docker Compose: 5chan board manager with bitsocial-cli (PKC RPC)
#
# Quick start:
#   cp docker-compose.example.yml docker-compose.yml
#   docker compose up -d
#   # Install the spam-blocker challenge referenced by the default preset
#   # (without it, `5chan board add --apply-defaults` is rejected by the RPC server):
#   docker compose exec bitsocial bitsocial challenge install @bitsocial/spam-blocker-challenge
#   # Now add boards via 5chan board add (see README.md)
#
# View logs:
#   docker compose logs -f 5chan

services:
  bitsocial:
    image: ghcr.io/bitsocialnet/bitsocial-cli:latest
    container_name: 5chan-bitsocial-cli
    restart: unless-stopped
    ports:
      - "9138:9138"
      - "4001:4001"      # Kubo Swarm (TCP)
      - "4001:4001/udp"  # Kubo Swarm (QUIC + WebTransport + WebRTC-direct)
    volumes:
      - bitsocial-data:/data
      - bitsocial-logs:/logs
    environment:
      # Fixed RPC auth key so 5chan board manager can connect without extracting it from logs.
      # Change this to your own random string (e.g.: openssl rand -base64 32 | tr -d '/+=')
      - PKC_RPC_AUTH_KEY=TFCh0joRU60KwlfVaprP2uenw7NCdAwsBCF5UDoVg
    # Optional: increase UDP buffer limits for QUIC transport (used by Kubo/IPFS).
    # Uncomment if you are running Docker with root privileges.
    # sysctls:
    #   - net.core.rmem_max=7500000
    #   - net.core.wmem_max=7500000
    healthcheck:
      test: ["CMD", "node", "-e", "const net=require('net');const s=net.connect(9138,'localhost',()=>{s.end();process.exit(0)});s.on('error',()=>process.exit(1));setTimeout(()=>process.exit(1),5000)"]
      interval: 30s
      timeout: 10s
      start_period: 60s
      retries: 3

  5chan:
    image: ghcr.io/bitsocialnet/5chan-board-manager:latest
    container_name: 5chan
    restart: unless-stopped
    depends_on:
      bitsocial:
        condition: service_healthy
    volumes:
      - 5chan-data:/data
    environment:
      # Must match PKC_RPC_AUTH_KEY on the bitsocial service above
      - PKC_RPC_WS_URL=ws://bitsocial:9138/TFCh0joRU60KwlfVaprP2uenw7NCdAwsBCF5UDoVg
      # Daemon debug logging — flows into `5chan logs`. Set to "" to silence.
      - DEBUG=bitsocial:5chan-board-manager*
    healthcheck:
      test: ["CMD", "node", "-e", "process.exit(Date.now() - require('fs').statSync('/data/5chan/heartbeat').mtimeMs < 600000 ? 0 : 1)"]
      interval: 60s
      timeout: 5s
      start_period: 180s
      retries: 3

volumes:
  bitsocial-data:
  bitsocial-logs:
  5chan-data: