Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?


Failed to load latest commit information.
Latest commit message
Commit time
December 21, 2022 17:32
September 26, 2022 18:44
January 5, 2019 22:27
March 14, 2023 17:36

BTCPay Server Documentation

Build Status


BTCPay Server is an open-source, self-hosted payment processor for Bitcoin and other cryptocurrencies.

If you have trouble using BTCPay Server, consider joining the communities listed on the official website to get help from community members.

Only file a Github issue for technical issues you can't resolve through other channels or feature requests you've validated with other members of community.

Please check out our official website, our complete documentation and FAQ for more details.


Pull requests are welcome and appreciated. To contribute to BTCPay Server, first check the contributing guidelines.

If you're beginner, take a look at the step by step guide on how to contribute to BTCPay Server documentation below.

Contributing to Documentation

Build the Documentation Locally

In order to build the website locally, you'll need Node.js >= 12.16 (or basically the latest LTS version). A prerequisite for the script is jq.

The setup is straight forward:

# Install dependencies
npm install

# Link external doc repos

# Serve locally (by default on port 8080)
npm start

Text Highlights

There are three types of text highlights that can be used to display different colored boxes.

A green box displaying a friendly tip:


A yellow box with a cautious warning:


A red box with a clear danger, you can also add a title foo to any container:

:::danger foo

SEO improvements

We are using the Vuepress SEO plugin to add relevant meta tags to the site and individual pages.

To improve the meta attributes of a specific page, you can add them as YAML frontmatter like this: (see the WooCommerce page for an example)

description: How to integrate BTCPay Server into your WooCommerce store.
- WooCommerce
- WordPress
- Plugin
- eCommerce
# WooCommerce integration

This document explains how to **integrate BTCPay Server into your WooCommerce store**.

Embedding YouTube videos

To add a YouTube video with a preview, you can so so by linking to it like this:


Note that the link item need to be a preview image (either from YouTube or a custom one) to result in an embedded video.

External documentation repos

The build documentation site combines a bunch of docs living in different repositories.

Before the build we check out the other repositories, copy their docs into the right places and link them just as the docs in this repo.

The process for that is defined in the script.

External repos can trigger the docs build whenever they change. You can use GitHub's repository_dispatch feature for this, which is exposed via the API:

curl -X POST \
  -u "${{ secrets.GH_PAT }}" \
  -H "Accept: application/vnd.github.everest-preview+json" \
  -H "Content-Type: application/json" \
  --data '{"event_type": "build_docs"}'

The GH_PAT needs to be a personal access token.


The BTCPay Server Project is proudly supported by these entities through the BTCPay Server Foundation.

Spiral Baillie Gifford Strike Human Rights Foundation LunaNode Wallet of Satoshi Coincards IVPN

If you'd like to support the project, please visit the donation page.