ππ£ππππ
Docker-based single-container package featuring:
- Bitcoin Core: Pruned by default with optional trusted fast-sync
- Electrum Server: Personal Electrum server powered by BWT
- BTC RPC Explorer: Personal block explorer and node dashboard
- Specter Desktop: Wallet GUI for hardware and multi-sig setups
- Secure remote access using Tor Onion, SSH tunnels or SSL
Why eznode?
- Simple one command setup
- Lightweight (130 MB docker image)
- Pruning-friendly (requires <5GB of storage)
- Suitable for a dedicated box, but doesn't require one
- Supports Linux, macOS, Windows and ARMv7/v8
Support development: β‘ lightning or βοΈ on-chain via BTCPay
Website: ezno.de
π Quickstart
Install Docker (the only dependency) and start eznode with the data directory mounted to /data
:
docker run -it --rm --name ez -v ~/eznode:/data sergioglorias/eznode TOR=1 XPUB=<xpub>
This will setup a pruned Bitcoin Core full node, a personal Electrum server tracking your <xpub>
, a block explorer and a Tor onion service for secure remote access. All the information you need for accessing them will be shown on startup.
You can skip setting an XPUB
if you're not using the Electrum server.
Change ~/eznode
if you'd like to store the node's data files elsewhere (for example C:\eznode
on Windows).
They require ~4.8GB of free space.
On Windows/macOS, you'll need to publish the ports with -p
to access them locally.
Some other common options include: AUTH_TOKEN=<password>
to enable authentication, NETWORK=signet
to experiment on signet, SPECTER=1
to enable Specter Desktop and TRUSTED_FASTSYNC=1
to enable the the trusted fast-sync mode.
To setup eznode using the π§ installation wizard, run:
docker run -it --rm --name ez -v ~/eznode:/data sergioglorias/eznode wizard
Signature verification instructions are available here.
π User Guide
The full user guide is available at https://ezno.de.
- β Getting started
- π©βπ» Accessing the services
- π Packages
- π‘οΈ Secure transports
- π§ Node management
- π Signed images
- ποΈ Building locally
β€οΈ Contributing
Contributions are welcome!
eznode manages services using the (fantastic!) s6
init/supervision system (via s6-overlay
). Refer to specter
for an example of a simple service package and to the s6 docs for more information on writing services.
π License
MIT