README.md

BTCPay Server Documentation

Introduction

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.

Contributing

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.

Build the Documentation Locally

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

The setup is straight forward:

# Link external doc repos
./setup-deps.sh

# Install dependencies
npm install

# 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:

:::tip
foo
:::

A yellow box with a cautious warning:

:::warning
foo
:::

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

:::danger foo
bar
:::

Embedding YouTube videos

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

[![BTCPay Server Crowdfunding](https://img.youtube.com/vi/tFbfyneDj88/mqdefault.jpg)](https://www.youtube.com/watch?v=tFbfyneDj88 "BTCPay Server Crowdfunding")

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 setup-deps.sh script.

Supporters

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

Square Crypto

BTSE

DG Lab

ACINQ

LunaNode

Wallet of Satoshi

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