Database-free, self-hosted Bitcoin explorer, via RPC to Bitcoin Core.
The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
Simple, database-free Bitcoin blockchain explorer, via RPC to Bitcoin Core.
This is a simple, self-hosted explorer for the Bitcoin blockchain, driven by RPC calls to your own Bitcoin node. It is easy to run and can be connected to other tools (like ElectrumX) to achieve a full-featured explorer.
Whatever reasons one may have for running a full node (trustlessness, technical curiosity, supporting the network, etc) it's helpful to appreciate the "fullness" of your node. With this explorer, you can explore not just the blockchain database, but also explore the functional capabilities of your own node.
Live demo available at: https://explorer.btc21.org
txindex=1) and the RPC server enabled (
If you're running on mainnet with the default datadir and port, the default configuration should Just Work. Otherwise, see the Configuration section below.
npm install -g btc-rpc-explorer btc-rpc-explorer
git clone [email protected]:janoside/btc-rpc-explorer.git
Using either method (
npm installor run from source), after startup open http://127.0.0.1:3002/
Configuration options may be set via environment variables or CLI arguments.
To configure with environment variables, you need to create one of the 2 following files and enter values in it:
.envin the working directory for btc-rpc-explorer
In either case, refer to .env-sample for a list of the options and formatting details.
For configuring with CLI arguments, run
btc-rpc-explorer --helpfor the full list of options. An example execution is:
btc-rpc-explorer --port 8080 --bitcoind-port 18443 --bitcoind-cookie ~/.bitcoin/regtest/.cookie
To match the features visible on the demo site at https://explorer.btc21.org you'll need to set the following non-default configuration values:
BTCEXP_DEMO=true # enables some demo/informational aspects of the site BTCEXP_NO_RATES=false # enables querying of exchange rate data BTCEXP_SLOW_DEVICE_MODE=false # enables resource-intensive tasks (UTXO set query, 24hr volume querying) that are inappropriate for "slow" devices
docker build -t btc-rpc-explorer .
docker run -it -p 3002:3002 -e BTCEXP_HOST=0.0.0.0 btc-rpc-explorer
See instructions here for using nginx+certbot (letsencrypt) for an HTTPS-accessible, reverse-proxied site.
If you get value from this project, please consider supporting my continued work with a donation. Any and all donations are truly appreciated.