Supported software

Following pages will guide you through using each included software.

Operating system

Only Debian 10 (Buster) is currently tested and officially supported. All distributions based on it (Ubuntu, Mint...) should work as well. If you try it, please report your experience to us.

Applications

Supported applications in the repository include the most important stack to use Bitcoin full node with Lightning Network Daemon. Apps for managing software with UI are one click away on Selfhost Dashboard, this includes Thunderhub, Ride The Lightning, BTCPayServer, BTC RPC Explorer, BTC Transmuter.

Selfhost Dashboard can be installed as apt install selfhost-dashboard and is reachable on your server under /dashboard.

Selfhost Dashboard

Nextcloud and similar apps for selfhosting services might be added in the future.

Other software and management tools are currently not accessible via UI but can be easily handled using terminal.

Installing applications

After you successfully added repository to your list of sources and updated information about packages, installing apps comes down to simple apt install. Keep in mind to install just desired applications and don't care about their dependencies.

For example, if you want to use Lightning with UI, you can run only:

apt install thunderhub ridetheln 

Which will install bitcoind, lnd, tor with all their dependencies and then Thunderhub and RTL, everything automatically connected with correct configuration.

Apps are by default accessible via tor onion service. Hostname can be found in /var/lib/tor/selfhost_hidden_service/hostname

Let's look how to install all applications and features in one command:

apt install selfhost-dashboard thunderhub ridetheln btcpayserver btc-transmuter electrs btc-rpc-explorer

Installing everything you need with one command like this makes sure all configuration is satisfied and doesn't have to change in the future (maybe trigger Bitcoin resync). Plus now you are ready to use full power of all Bitcoin weapons without ****further hesitation.

Updating

Packages are regularly updated with newest releases, new features and fixes. Updating whole stack is as easy as any other software:

sudo apt update
sudo apt dist-upgrade

For information how to use individual apps, proceed to following pages.

Overview of currently supported and planned application packages

• bitcoind

• bitcoin-mainnet

• bitcoin-pruned-mainnet (provides bitcoin-chain-mode-mainnet) DO NOT DEPEND ON THIS ONE!!!

• bitcoin-fullchain-mainnet (provides bitcoin-chain-mode-mainnet)

• bitcoin-txindex-mainnet (provides bitcoin-chain-mode-mainnet)

• bitcoin-chain-mode-mainnet makes sure to consistently select pruned/non-pruned/txindex

• bitcoin-zmq-mainnet

• bitcoin-cli (with a wrapper that uses bitcoin-mainnet by default)

• bitcoin-p2p-mainnet (virtual, Bitcoin P2P protocol)

• bitcoin-rpc-proxy

• bitcoin-rpc-proxy-mainnet

• bitcoin-timechain-mainnet (public timechain RPC calls)

• electrs

• electrs-mainnet

• electrs-esplora

• electrs-esplora-mainnet

• esplora

• esplora-mainnet

• electrumx (low priority)

• electrumx-mainnet (low priority)

• electrum-server-mainnet (virtual, electrum server implementation)

• electrum (desktop package without .desktop file)

• electrum-trustless-mainnet (desktop package configured to use electrum-server-mainnet)

• wasabi-trustless-mainnet

• wasabi (desktop package without .desktop file)

• nbxplorer

• nbxplorer-mainnet (no integration into nginx yet)

• btcpayserver

• btcpayserver-system-mainnet

• btcpayserver-lnp-system-mainnet (connects LND with BTCPayServer)

• btc-transmuter

• btc-transmuter-system-mainnet

• selfhost (a tooling/framework for selfhosting applications easily)

• selfhost-nginx (nginx gateway for selfhost)

• selfhost-clearnet (sets up clearnet domain)

• selfhost-clearnet-certbot (automatically sets up Let's Encrypt for selfhost-clearnet)

• selfhost-onion (automatically sets up onion address for selfhost)

• lnd

• lnd-system-mainnet

• lnd-auto-unlock

• lnd-unlocker-system-mainnet

• lnd-genmacaroon (generates additional macaroons - currently only invoice+readonly for use with btcpay)

• lnd-genmacaroon-mainnet

• lncli (with a wrapper that uses lnd-system-mainnet by default)

• lndconnect a CLI tool for creating lndconnect link

• eclair

• eclair-system-mainnet

• eclair-turbo

• eclair-turbo-system-mainnet

• eclair-rpc-proxy

• eclair-rpc-proxy-mainnet

• eclair-invoice-mainnet (virtual, I guess)

• ln-system-mainnet (virtual, provides system-wide Lightning Network implementation)

• ridetheln

• ridetheln-system

• ridetheln-lnd-system-mainnet

• thunderhub

• thunderhub-system-mainnet

• btc-rpc-explorer

• btc-rpc-explorer-mainnet

• lighter

• multiuser-ln (completely new application allowing multiple users to share a LN implementation)

• multiuser-ln-mainnet

• liblightning (a completely new library abstracting away implementation details and allowing multiple wallets) - maybe just use lighter instead

• ln-contacts (a completely new application providing contact list for Lightning Network nodes)

• ln-dialog (partialy done in qpay, a simple dialog which shows whenever the user attempts to pay, create invoice or open LNURL)

• qpay-rpc-service

• qpay-client

• ln-mime (makes sure to register appropriate mime types and launch correct application)

• remote-service-bridge (a framework for securely bridging services to remote computers, needs to be written)

• samourai-dojo

• samourai-dojo-mainnet

• joinmarket

• joinmarket-mainnet

• lnpbp-testkit (framework for testing LNP/BP applications)

• remir (a simple server for controlling IR devices; not freedom related, but why not?)

• translations

• all services for regtest

• all services for signet

• all services for testnet