BTCPay Server web interface and internal API port. Container port: 49392.

Ziel

49392

Standard

49392

Wert

49392

Persistent BTCPay Server data directory. Back this directory up before processing real payments.

Ziel

/datadir

Standard

/mnt/user/appdata/btcpayserver

Wert

/mnt/user/appdata/btcpayserver

Persistent BTCPay Server plugins directory.

Ziel

/root/.btcpayserver/Plugins

Standard

/mnt/user/appdata/btcpayserver/plugins

Wert

/mnt/user/appdata/btcpayserver/plugins

Address and port BTCPay binds to inside the container.

Ziel

BTCPAY_BIND

Standard

0.0.0.0:49392

Wert

0.0.0.0:49392

Bitcoin network. Use mainnet, testnet, signet, or regtest.

Ziel

BTCPAY_NETWORK

Standard

mainnet

Wert

mainnet

Comma-separated crypto chains enabled in BTCPay. This template defaults to Bitcoin only.

Ziel

BTCPAY_CHAINS

Standard

btc

Wert

btc

Optional public hostname, for example btcpay.example.com. Use a reverse proxy for HTTPS when exposing BTCPay outside your LAN.

Ziel

BTCPAY_HOST

BTCPay root path when served from a subpath. Use / for normal deployments.

Ziel

BTCPAY_ROOTPATH

Standard

/

Wert

/

Required Postgres connection string for the BTCPay Server database.

Ziel

BTCPAY_POSTGRES

Standard

User ID=postgres;Host=postgres;Port=5432;Application Name=btcpayserver;Database=btcpayservermainnet

Wert

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.

Ziel

BTCPAY_EXPLORERPOSTGRES

Standard

User ID=postgres;Host=postgres;Port=5432;Application Name=btcpayserver;MaxPoolSize=80;Database=nbxplorermainnet

Wert

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/.

Ziel

BTCPAY_BTCEXPLORERURL

Standard

http://nbxplorer:32838/

Wert

http://nbxplorer:32838/

Marks this BTCPay instance as Docker-deployed. Use true or false.

Ziel

BTCPAY_DOCKERDEPLOYMENT

Standard

true

Wert

true

Prevents BTCPay from assuming a chain without explicit chain variables. Use true or false.

Ziel

BTCPAY_NODEFAULTCHAIN

Standard

true

Wert

true

Release URL used by BTCPay to check for new versions.

Ziel

BTCPAY_UPDATEURL

Standard

https://api.github.com/repos/btcpayserver/btcpayserver/releases/latest

Wert

https://api.github.com/repos/btcpayserver/btcpayserver/releases/latest

Debug log filename under the BTCPay data directory.

Ziel

BTCPAY_DEBUGLOG

Standard

btcpay.log

Wert

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.

Ziel

BTCPAY_BTCLIGHTNING