BTCPay Server is a free, open-source & self-hosted bitcoin payment gateway. It allows self-sovereign individuals and businesses to accept bitcoin payments online or in person without any fees. This will deploy BTCPay Server with Bitcoin Full Node (with 50 GB pruning), Core Lightning Node, Spark Wallet and Ride The Lightning. Please note that features like SSH access and Onion service have been omitted to keep deployment simple. You may need to open the port `9735` in your firewall.
btcpayserver
- btcpayserver-data:/datadir
- btcpayserver-nbxplorer-data:/root/.nbxplorer
- btcpayserver-plugins:/root/.btcpayserver/Plugins
- btcpayserver-lightning-data:/etc/clightning_bitcoin
- btcpayserver-lightning-spark:/etc/clightning_bitcoin_spark
- btcpayserver-lightning-rtl-data:/etc/clightning_bitcoin_rtl
- btcpayserver-lightning-rest-certificates:/etc/clightning_bitcoin_rest_certs
btcpayserver-postgres
- btcpayserver-postgres:/var/lib/postgresql/data
btcpayserver-nbxplorer
- btcpayserver-nbxplorer-data:/datadir
- btcpayserver-bitcoind-data:/root/.bitcoin
btcpayserver-bitcoind
- btcpayserver-bitcoind-wallet-data:/walletdata
- btcpayserver-bitcoind-data:/data
btcpayserver-lightning
- btcpayserver-lightning-data:/root/.lightning
- btcpayserver-bitcoind-data:/etc/bitcoin
- btcpayserver-nbxplorer-data:/root/.nbxplorer
btcpayserver-lightning-spark
- btcpayserver-lightning-data:/etc/lightning
- btcpayserver-lightning-spark:/data
btcpayserver-lightning-rest
- btcpayserver-lightning-data:/root/.lightning
- btcpayserver-bitcoind-data:/etc/bitcoin
- btcpayserver-lightning-rest-certificates:/usr/src/app/certs
- btcpayserver-nbxplorer-data:/root/.nbxplorer
btcpayserver-rtl
- btcpayserver-lightning-data:/root/.lightning
- btcpayserver-bitcoind-data:/etc/bitcoin
- btcpayserver-lightning-rtl-data:/data
- btcpayserver-lightning-rest-certificates:/etc/clightning_bitcoin_rest_certs
General | Bind Address
Address to bind the services.
General | BTCPay Server Version
Check out their valid tags at https://hub.docker.com/r/btcpayserver/btcpayserver/tags
General | PostgreSQL Version
Check out their valid tags at https://hub.docker.com/r/btcpayserver/postgres/tags
General | NBXplorer Version
Check out their valid tags at https://hub.docker.com/r/nicolasdorier/nbxplorer/tags
General | Bitcoin Node Version
Check out their valid tags at https://hub.docker.com/r/btcpayserver/bitcoin/tags
General | Lightning Version
Check out their valid tags at https://hub.docker.com/r/btcpayserver/lightning/tags
General | Lightning Spark Version
Check out their valid tags at https://hub.docker.com/r/shesek/spark-wallet/tags
General | Lightning REST Version
Check out their valid tags at https://hub.docker.com/r/saubyk/c-lightning-rest/tags
General | Ride The Lightning Version
Check out their valid tags at https://hub.docker.com/r/shahanafarooqui/rtl/tags
General | Network Type
The type of Bitcoin network to use (e.g. `mainnet`, `testnet`, or `regtest`)
Explorer | Chain
Blockchain to be used. Defaults is `btc` and should **not** be changed.
Database | Port
Port of the PostgreSQL database host.
Database | User
User of the PostgreSQL database.
Database | Authentication Method
Method of authentication for incoming connections in PostgreSQL.
Application | Root Path
Root path of the application.
Application | Port
Port of the application host.
Application | Debug Log
Log file for debugging information.
Application | Update URL
URL to BTCPay Server releases.
Explorer | Port
Port of the NBXplorer host.
Explorer | Trim Events
Trim the amount of events in NBXplorer.
Explorer | Signal Files Directory
Path to signal files directory in NBXplorer.
Explorer | Automatic Migrations
Whether to enable automatic migrations.
Explorer | Event Migrations
Whether to disable event migrations.
Bitcoin Node | RPC Port
Port of Bitcoin node RPC.
Bitcoin Node | Node Port
Port of Bitcoin node endpoint.
Bitcoin Node | Wallet Directory
Path to wallet files directory of the Bitcoin node.
Bitcoin Node | Maximum Mempool Size
Maximum Bitcoin node mempool size in megabytes.
Bitcoin Node | Allowlist Subnet
Whitelist IP subnet using CIDR notation for the Bitcoin node.
Bitcoin Node | Prune
Configure a disk space on stored blocks of the Bitcoin node, denoted in megabytes. Default is 50 gigabytes, this will keep around 6 months of blocks.
Bitcoin Node | Additional Arguments
Additional Bitcoin node startup arguments.
Lightning Node | Announced Address
IP address of your server. E.g. `123.123.123.123`.
Lightning Node | Alias
An alias for your Lightning node.
Lightning Node | Port
Port of your Lightning node host.
Lightning Node | Ready File
Path to Bitcoin node ready status indicator file in the Lightning node.
Lightning Node | Bitcoin Data Directory
Path to Bitcoin data directory in the Lightning node.
Lightning Node | Additional Arguments
Additional Lightning node startup arguments.
Lightning Node | Spark | Lightning Network Files
Additional start up options for Lightning Spark.
Lightning Node | Spark | Port
Port of Lightning Spark host.
Lightning Node | REST | Protocol
Which HTTP protocol to use in Lightning REST.
Lightning Node | Spark | Lightning REST API Port
REST API port of the Lightning node.
Ride The Lightning | Lightning Implementation
Lightning implementation used for Ride The Lightning.
Ride The Lightning | Lightning Configuration
Path to Lightning configuration for Ride The Lightning.
Ride The Lightning | Lightning REST Server Port
Port of the Lightning REST server for Ride The Lightning.
Ride The Lightning | Macaroon Path
Path to the macaroon file for Ride The Lightning.
Ride The Lightning | Configuration Path
Path to the configuration file for Ride The Lightning.
Ride The Lightning | Bitcoin Configuration Path
Path to the Bitcoin configuration file for Ride The Lightning.
Ride The Lightning | Single-Sign-On
Whether to use Single-Sign-On for Ride The Lightning.
Ride The Lightning | Cookie Path
Path to the cookie file for Ride The Lightning.
Ride The Lightning | Log-Out Redirect Link
Log-Out redirect link for Ride The Lightning.
Ride The Lightning | Port
Port of Ride The Lightning host.