Bitcoin CKPool Docker Setup

This repository provides a convenient Docker setup combining Bitcoin Core, ckpool, PostgreSQL, and the ckstats monitoring dashboard. It includes Docker Compose configuration for quick deployment and easy scalability.

Features

• Builds and runs Bitcoin Core (x86_64 or ARM64).
• Compiles and runs ckpool from source.
• Persistent storage for Bitcoin blockchain data.
• PostgreSQL database integration for statistics and monitoring.
• Web-based monitoring dashboard (ckstats), accessible via localhost:4000.

---

Table of Contents

• Prerequisites
• File Structure
• Docker Compose Services
  • Bitcoin-ckpool
  • PostgreSQL
  • ckstats Dashboard
• Setup & Run
• Accessing ckstats Dashboard
• Troubleshooting
• Support & Donations
• License

Prerequisites

• Docker & Docker Compose installed.
• At least 1TB available disk space (for blockchain data).

File Structure

.
├── ckpool/             # ckpool Docker build context
├── ckstats/            # ckstats dashboard Docker build context
├── db/                 # PostgreSQL setup
│   ├── data/           # Persistent database data
│   └── init-user-db.sh # Initialization script for database
├── docker-compose.yml
├── entrypoint.sh       # Container entrypoint script
└── README.md           # This documentation

Docker Compose Services

Bitcoin-ckpool

• Bitcoin Core node and ckpool mining pool integrated.
• Configurable via environment variables in docker-compose.yml.
• Persistent blockchain data in ./ckpool/data.

PostgreSQL

• Database service for storing ckstats monitoring data.
• Uses default database credentials:
  • User: ckstats
  • Password: ckstats
  • Database: ckstats
• Exposes port 5432.

ckstats Dashboard

• Web-based monitoring dashboard.
• Accessible at http://localhost:4000.
• Depends on PostgreSQL database.

Docker Compose Configuration

Here's the complete Docker Compose file for deployment:

services:
  bitcoin-ckpool:
    build:
      context: ckpool/
      # For x86_64 builds:
      args:
        TARGETARCH: amd64
      # Or for ARM64:
      # args:
      #   TARGETARCH: arm64
    container_name: bitcoin-ckpool

    # Define environment variables to fill the config files at runtime:
    environment:
      # Bitcoin config
      TESTNET: "0"
      ALGO: "sha256d"
      DAEMON: "1"
      SERVER: "1"
      TXINDEX: "0"
      MAXCONNECTIONS: "300"
      DISABLEWALLET: "0"
      RPCALLOWIP: "0.0.0.0/0"
      PORT: "8433"
      RPCPORT: "8432"
      RPCBIND: "0.0.0.0"
      RPCUSER: "rpcuser"
      RPCPASSWORD: "rpcpassword"
      ONLYNET: "IPv4"
      ZMQPUBHASHBLOCK: "tcp://127.0.0.1:28435"
      DATADIR: "/home/cna.bitcoin/mainnet"

      # ckpool config
      BTCD_URL: "127.0.0.1:8432"
      BTCD_AUTH: "rpcuser"
      BTCD_PASS: "rpcpassword"
      SERVERURL: "0.0.0.0:3333"
      BTCADDRESS: "xxx"
      BTCSIG: "/mined by me/"
      BLOCKPOLL: "10"
      DONATION: "0.0"
      NONCE1LENGTH: "4"
      NONCE2LENGTH: "8"
      UPDATE_INTERVAL: "60"
      VERSION_MASK: "1fffe000"
      MINDIFF: "512"
      STARTDIFF: "10000"
      LOGDIR: "/logs"
      ZMQBLOCK: "tcp://127.0.0.1:28435"

    volumes:
      - ./ckpool/data:/home/cna.bitcoin/mainnet

    ports:
      # Publish Bitcoin ports:
      - "8435:8433"  # p2p
      # Publish Bitcoin RPC port:
      - "8434:8432"  # rpc
      # Publish ckpool port (if you want to accept external connections for miners):
      - "3334:3333"
      # API port (for ckstats):
      - "4029:4028"
      # Web port (for ckstats):
      - "4001:80"

  db-bitcoin:
    image: postgres:13
    container_name: db-bitcoin
    environment:
      POSTGRES_USER: ckstats
      POSTGRES_PASSWORD: ckstats
      POSTGRES_DB: ckstats
    volumes:
      - ./db/data:/var/lib/postgresql/data
      - ./db/init-user-db.sh:/docker-entrypoint-initdb.d/init-user-db.sh
    ports:
      - "5433:5432"
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U ckstats -t 20 && psql -U ckstats -d dbshadow -c 'SELECT 1' >/dev/null 2>&1"]
      interval: 20s
      timeout: 30s
      retries: 5
  ckstats-bitcoin:
    build:
      context: ckstats/
      dockerfile: Dockerfile
      # For x86_64 builds:
      args:
        TARGETARCH: amd64
      # Or for ARM64:
      # args:
      #   TARGETARCH: arm64
    container_name: ckstats-bitcoin
    depends_on:
      db-bitcoin:
        condition: service_healthy
    environment:
      DATABASE_URL: "postgres://ckstats:ckstats@db-bitcoin/ckstats"
      SHADOW_DATABASE_URL: "postgres://ckstats:ckstats@db-bitcoin/dbshadow"
      API_URL: "http://bitcoin-ckpool"
      RPCUSER: "rpcuser"
      RPCPASSWORD: "rpcpassword"
      RPCPORT: "8432"
    ports:
    # Publish ckstats port:
      - "4000:3000"

Build & Run

Clone this repository and launch all services:

docker-compose up --build

Verify Bitcoin Node

Check the node's status:

docker exec -it bitcoin-ckpool bitcoin-cli -conf=/etc/bitcoin/bitcoin.conf getblockchaininfo

Common Issues

• Error Code -28 (Loading Blocks...): Wait until Bitcoin finishes syncing.
• RPC connection issues: Wait for node initialization.

Donations & Support

• Bitcoin Address: bc1qv649ya0aqqzghpl0wypnhhdw5xvrz893wxyj2d
• GitHub: Casraw

Feel free to donate if this setup helps you!

License

Licensed under the MIT License. Refer to Bitcoin and ckpool licenses for their specific terms.