kzwo/bitcoin-ii-dashboard repository overview
BitcoinII Dashboard (Docker)
A lightweight, self-hosted dashboard & explorer for a BitcoinII full node, designed to run alongside kzwo/bitcoin-ii using Docker or Docker Compose.
- ✅ No exposed RPC by default
- ✅ Uses cookie-based RPC auth (best practice)
- ✅ Works on x86 & ARM (Raspberry Pi)
- ✅ Minimal, fast, and dependency-light
- ✅ Explorer + Health UI with shared theme
- ✅ Ready for future indexer & Grafana integration
Screenshots
Health Dashboard
Node status & sync overview
Shows:
- chain & block height
- sync / IBD status
- peers
- mempool size & usage
- node version
Lightweight Explorer
RPC-only explorer (UTXO-based)
Supports:
- latest blocks
- mempool sample
- block / tx / address lookup (address history is UTXO-only unless an indexer is enabled)
Requirements
- Docker ≥ 20
- Docker Compose v2
- A running BitcoinII node (Docker or native)
Recommended:
Quick Start (Recommended: Docker Compose)
Create a new folder
mkdir bitcoinii-stack
cd bitcoinii-stack
Create docker-compose.yml
services:
bitcoinii:
image: kzwo/bitcoin-ii:latest
container_name: bitcoinii
restart: unless-stopped
volumes:
- bc2-data:/data
ports:
- "8338:8338" # P2P
- "127.0.0.1:8339:8339" # local-only service
command:
- "-printtoconsole=1"
- "-server=1"
- "-rpcport=8337"
- "-rpcbind=0.0.0.0"
- "-rpcallowip=172.30.0.0/24"
healthcheck:
test: ["CMD-SHELL", "bitcoinII-cli -datadir=/data -rpcwait=30 getblockchaininfo >/dev/null 2>&1 || exit 1"]
interval: 30s
timeout: 10s
retries: 20
start_period: 120s
networks:
bc2net:
ipv4_address: 172.30.0.10
dashboard:
image: kzwo/bitcoin-ii-dashboard:latest
container_name: bitcoinii-dashboard
restart: unless-stopped
depends_on:
bitcoinii:
condition: service_healthy
volumes:
- bc2-data:/data:ro # read-only access to RPC cookie
environment:
RPC_HOST: bitcoinii
RPC_PORT: "8337"
RPC_COOKIE: "/data/.cookie"
# Future use
INDEXER_ENABLED: "false"
INDEXER_PROVIDER: ""
ports:
- "127.0.0.1:3000:3000"
healthcheck:
test: ["CMD-SHELL", "wget -qO- http://127.0.0.1:3000/health | grep -q '\"ok\"'"]
interval: 15s
timeout: 5s
retries: 10
start_period: 20s
networks:
bc2net:
ipv4_address: 172.30.0.20
networks:
bc2net:
driver: bridge
ipam:
config:
- subnet: 172.30.0.0/24
volumes:
bc2-data:
Start everything
docker compose up -d
Open the UI
-
Health Dashboard: 👉 http://127.0.0.1:3000/health-ui
-
Explorer: 👉 http://127.0.0.1:3000/explorer
(Root / redirects to Explorer)
How it works (Security model)
-
The BitcoinII node creates an RPC cookie at:
/data/.cookie -
The dashboard mounts this file read-only
-
No RPC username/password required
-
RPC port is never exposed publicly
This matches Bitcoin Core’s recommended security model.
Health & Monitoring
/health— JSON health endpoint (Docker / k8s friendly)- Docker container includes a built-in healthcheck
- Designed for Prometheus / Grafana integration later
Common Commands
View logs
docker compose logs -f bitcoinii
docker compose logs -f dashboard
Stop everything
docker compose down
Restart
docker compose up -d
Update images
docker compose pull
docker compose up -d
Running Dashboard with a Non-Docker Node (Advanced)
If bitcoinIId runs natively:
docker run -d \
--name bitcoinii-dashboard \
-p 127.0.0.1:3000:3000 \
-v ~/.bitcoinII:/data:ro \
-e RPC_COOKIE=/data/.cookie \
-e RPC_HOST=host.docker.internal \
-e RPC_PORT=8337 \
kzwo/bitcoin-ii-dashboard:latest
Contributing
Contributions are welcome!
Ideas:
- Prometheus
/metricsendpoint - Grafana dashboard
- Indexed address history (Fulcrum / ElectrumX)
- Peer table
- Disk usage & uptime
- Dark/light theme toggle
Development
git clone https://github.com/kleokzwo/health_check
cd health_check/dashboard
docker build -t bitcoinii-dashboard-dev .
docker run -p 3000:3000 bitcoinii-dashboard-dev
Disclaimer
This is an unofficial community project and not endorsed by the BitcoinII Core developers.
Use at your own risk.
License
MIT
Tag summary
Content type
Image
Digest
sha256:23449a25a…
Size
48.4 MB
Last updated
10 months ago
docker pull kzwo/bitcoin-ii-dashboard