All apps · 0 apps
BTCPayServer
OfficialDocker app from Raccommode's Repository
Overview
Readme
View on GitHubBTCPay Server
BTCPay Server is a free and open-source, self-hosted Bitcoin payment processor. It lets merchants accept Bitcoin directly, without fees or intermediaries.
Start Here
- Users: Use BTCPay Server
- Operators: Deploy and operate BTCPay Server
- Developers: Build integrations and plugins
- Maintainers: Maintain this repository
See the documentation gateway for more audience-specific resources.
Project Links
Website | Documentation | Greenfield API | Demo | Issues | Discussions | Community chat
Security vulnerabilities must be reported through the process in SECURITY.md, not as public issues.
BTCPay Server is available under the MIT License.
Media gallery
Requirements
Categories
Download Statistics
Total Downloads Over Time
Related apps
Explore more like this
Explore allDetails
btcpayserver/btcpayserver:latestRuntime arguments
- Web UI
http://[IP]:[PORT:49392]- Network
bridge- Shell
sh- Privileged
- false
Template configuration
BTCPay Server web interface and internal API port. Container port: 49392.
- Target
- 49392
- Default
- 49392
- Value
- 49392
Persistent BTCPay Server data directory. Back this directory up before processing real payments.
- Target
- /datadir
- Default
- /mnt/user/appdata/btcpayserver
- Value
- /mnt/user/appdata/btcpayserver
Persistent BTCPay Server plugins directory.
- Target
- /root/.btcpayserver/Plugins
- Default
- /mnt/user/appdata/btcpayserver/plugins
- Value
- /mnt/user/appdata/btcpayserver/plugins
Address and port BTCPay binds to inside the container.
- Target
- BTCPAY_BIND
- Default
- 0.0.0.0:49392
- Value
- 0.0.0.0:49392
Bitcoin network. Use mainnet, testnet, signet, or regtest.
- Target
- BTCPAY_NETWORK
- Default
- mainnet
- Value
- mainnet
Comma-separated crypto chains enabled in BTCPay. This template defaults to Bitcoin only.
- Target
- BTCPAY_CHAINS
- Default
- btc
- Value
- btc
Optional public hostname, for example btcpay.example.com. Use a reverse proxy for HTTPS when exposing BTCPay outside your LAN.
- Target
- BTCPAY_HOST
BTCPay root path when served from a subpath. Use / for normal deployments.
- Target
- BTCPAY_ROOTPATH
- Default
- /
- Value
- /
Required Postgres connection string for the BTCPay Server database.
- Target
- BTCPAY_POSTGRES
- Default
- User ID=postgres;Host=postgres;Port=5432;Application Name=btcpayserver;Database=btcpayservermainnet
- Value
- User ID=postgres;Host=postgres;Port=5432;Application Name=btcpayserver;Database=btcpayservermainnet
Required Postgres connection string for NBXplorer data, used by BTCPay to read explorer state.
- Target
- BTCPAY_EXPLORERPOSTGRES
- Default
- User ID=postgres;Host=postgres;Port=5432;Application Name=btcpayserver;MaxPoolSize=80;Database=nbxplorermainnet
- Value
- User ID=postgres;Host=postgres;Port=5432;Application Name=btcpayserver;MaxPoolSize=80;Database=nbxplorermainnet
Required NBXplorer URL for Bitcoin, for example http://nbxplorer:32838/ on a custom Docker network or http://UNRAID-IP:32838/.
- Target
- BTCPAY_BTCEXPLORERURL
- Default
- http://nbxplorer:32838/
- Value
- http://nbxplorer:32838/
Marks this BTCPay instance as Docker-deployed. Use true or false.
- Target
- BTCPAY_DOCKERDEPLOYMENT
- Default
- true
- Value
- true
Prevents BTCPay from assuming a chain without explicit chain variables. Use true or false.
- Target
- BTCPAY_NODEFAULTCHAIN
- Default
- true
- Value
- true
Release URL used by BTCPay to check for new versions.
- Target
- BTCPAY_UPDATEURL
- Default
- https://api.github.com/repos/btcpayserver/btcpayserver/releases/latest
- Value
- https://api.github.com/repos/btcpayserver/btcpayserver/releases/latest
Debug log filename under the BTCPay data directory.
- Target
- BTCPAY_DEBUGLOG
- Default
- btcpay.log
- Value
- btcpay.log
Optional Bitcoin Lightning connection string. For example, type=clightning;server=unix://etc/clightning_bitcoin/lightning-rpc, or leave blank to configure later in BTCPay.
- Target
- BTCPAY_BTCLIGHTNING