# BTCPay Server Docker Documentation

This documentation covers the official Docker deployment of BTCPay Server. For product usage, stores, wallets, and integrations, see the BTCPay Server documentation.

# Get Started

  • Installation: requirements, the production deployment path, and what the setup script changes on the host
  • Architecture: required components, data flow, generated files, and optional services

# Configure the Stack

  • Configuration: environment variables and storage or memory profiles
  • Networking: domains, ports, HTTPS, reverse proxies, tunnels, and optional Nginx routes
  • Lightning: choosing and enabling CLN, LND, or Phoenixd
  • Cryptocurrencies: selecting supported chains and understanding support boundaries
  • Optional fragments: the catalog of optional stack features

# Operate and Maintain

  • Operations: service lifecycle, command-line tools, logs, and database access
  • Updating: updating the repository and stack, archived update logs, and image cleanup
  • Backup and restore: creating, encrypting, and restoring deployment backups
  • Troubleshooting: infrastructure checks and diagnostics to collect before requesting help

# Customize and Develop

  • Customization: generated Compose files and custom fragments
  • Development: generator development and adding a new cryptocurrency

# Optional Services

The fragment catalog lists every available optional fragment, including features that do not require a separate guide.

# Build Provenance

# Help

Use the BTCPay Server community chat (opens new window) for deployment questions. Report reproducible defects in the Docker tooling on the btcpayserver-docker issue tracker (opens new window).