mirror of
https://github.com/btcpayserver/btcpayserver.git
synced 2024-11-20 02:28:31 +01:00
151 lines
6.9 KiB
Markdown
151 lines
6.9 KiB
Markdown
|
|
|
|
|
|
[](https://hub.docker.com/r/nicolasdorier/btcpayserver/)
|
|
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fbtcpayserver%2Fbtcpayserver-azure%2Fmaster%2Fazuredeploy.json)
|
|
[](https://circleci.com/gh/btcpayserver/btcpayserver)
|
|
|
|
# BTCPay Server
|
|
|
|
## Introduction
|
|
|
|
BTCPay Server is a free and open-source cryptocurrency payment processor which allows you to receive payments in Bitcoin and altcoins directly, with no fees, transaction cost or a middleman.
|
|
|
|
BTCPay is a non-custodial invoicing system which eliminates the involvement of a third-party. Payments with BTCPay go directly to your wallet, which increases the privacy and security. Your private keys are never uploaded to the server. There is no address re-use, since each invoice generates a new address deriving from your xpubkey.
|
|
|
|
The software is built in C# and conforms to the invoice [API of BitPay](https://bitpay.com/api). It allows for your website to be easily migrated from BitPay and configured as a self-hosted payment processor.
|
|
|
|
You can run BTCPay as a self-hosted solution on your own server, or use a [third-party host](https://github.com/btcpayserver/btcpayserver-doc/blob/master/ThirdPartyHosting.md).
|
|
|
|
The self-hosted solution allows you not only to attach an unlimited number of stores and use the Lightning Network but also become the payment processor for others.
|
|
|
|
Thanks to the [apps](https://github.com/btcpayserver/btcpayserver-doc/blob/master/Apps.md) built on top of it, you can use BTCPay to receive donations, start a crowdfunding campaign or have an in-store Point of Sale.
|
|
|
|
[](https://www.youtube.com/watch?v=q7xJMno_B3U "What is BTCPay")
|
|
|
|
## Table of Contents
|
|
|
|
* [Features](#features)
|
|
* [Getting Started](#getting-started)
|
|
* [Documentation](#documentation)
|
|
* [Contributing](#Contributing)
|
|
* [How to build](#how-to-build)
|
|
* [How to run](#how-to-run)
|
|
* [How to debug](#how-to-debug)
|
|
* [Dependencies](#dependencies)
|
|
|
|
## Features
|
|
|
|
* Direct, peer-to-peer Bitcoin and altcoin payments
|
|
* No transaction fees (other than those for the crypto networks)
|
|
* No processing fees
|
|
* No middleman
|
|
* No KYC
|
|
* User has complete control over private keys
|
|
* Enhanced privacy
|
|
* Enhanced security
|
|
* Self-hosted
|
|
* SegWit support
|
|
* Lightning Network support (LND and c-lightning)
|
|
* Tor support
|
|
* Full compatibility with BitPay API (easy migration)
|
|
* Process payments for others
|
|
* Easy-embeddable Payment buttons
|
|
* Point of sale app
|
|
* Crowdfunding app
|
|
* Payment requests
|
|
|
|
## Getting Started
|
|
|
|
Firstly, decide if you want to host an instance yourself or use a [third-party host](https://docs.btcpayserver.org/deployment/thirdpartyhosting). If you've chosen to self-host, we documented plenty [ways to deploy BTCPay Server](https://docs.btcpayserver.org/deployment/deployment).
|
|
|
|
After successful deployment, make sure to check our [getting started](https://docs.btcpayserver.org/btcpay-basics/gettingstarted) and [walkthrough](https://docs.btcpayserver.org/btcpay-basics/walkthrough) guides. In case you would like to use Lightning Network, see [Lightning guide](https://docs.btcpayserver.org/features/lightningnetwork).
|
|
|
|
## Documentation
|
|
|
|
Please check out our [official website](https://btcpayserver.org/), our [complete documentation](https://github.com/btcpayserver/btcpayserver-doc) and [FAQ](https://github.com/btcpayserver/btcpayserver-doc/tree/master/FAQ#btcpay-frequently-asked-questions-and-common-issues) for more details.
|
|
|
|
If you have trouble using BTCPay, consider joining [communities listed on official website](https://btcpayserver.org/#communityCTA) to get help from BTCPay community members. Only file [Github issue](https://github.com/btcpayserver/btcpayserver/issues) for technical issues you can't resolve through other channels or feature requests you've validated with other members of community.
|
|
|
|
Main community chat is located on [Mattermost](https://chat.btcpayserver.org/).
|
|
|
|
## Contributing
|
|
BTCPay is built and maintained entirely by volunteer contributors around the internet. We welcome and appreciate new contributions.
|
|
|
|
If you're a developer looking to help, but you're not sure where to begin, check the [good first issue label](https://github.com/btcpayserver/btcpayserver/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), which contains small pieces of work that have been specifically flagged as being friendly to new contributors.
|
|
|
|
Contributors looking to do something a bit more challenging, before opening a pull request, please [create an issue](https://github.com/btcpayserver/btcpayserver/issues/new/choose) or join [our community chat](https://chat.btcpayserver.org/) to get early feedback, discuss best ways to tackle the problem and to ensure there is no work duplication.
|
|
|
|
You also have an awesome video of our contributors which explains you how to get started.
|
|
|
|
[](https://www.youtube.com/embed/VNMnd-dX9Q8)
|
|
|
|
## How to build
|
|
|
|
While the documentation advises to use docker-compose, you may want to build BTCPay yourself.
|
|
|
|
First install .NET Core SDK v2.1.9 as specified by [Microsoft website](https://www.microsoft.com/net/download/dotnet-core/2.1).
|
|
|
|
On Powershell:
|
|
```
|
|
.\build.ps1
|
|
```
|
|
|
|
On linux:
|
|
```
|
|
./build.sh
|
|
```
|
|
|
|
## How to run
|
|
|
|
Use the `run` scripts to run BTCPayServer, this example shows how to print the available command line arguments of BTCPayServer.
|
|
|
|
On Powershell:
|
|
```
|
|
.\run.ps1 --help
|
|
```
|
|
|
|
On linux:
|
|
```
|
|
./run.sh --help
|
|
```
|
|
|
|
## How to debug
|
|
|
|
If you want to debug, use Visual Studio Code or Visual Studio 2017.
|
|
|
|
You need to run the development time docker-compose as described [in the test guide](BTCPayServer.Tests/README.md).
|
|
|
|
You can then run the debugger by using the Launch Profile `Docker-Regtest` on either Visual Studio Code or Visual Studio 2017.
|
|
|
|
If you need to debug ledger wallet interaction, install the development time certificate with:
|
|
|
|
```bash
|
|
# Install development time certificate in the trust store
|
|
dotnet dev-certs https --trust
|
|
```
|
|
|
|
Then use the `Docker-Regtest-https` debug profile.
|
|
|
|
## Other dependencies
|
|
|
|
For more information, see the documentation: [How to deploy a BTCPay server instance](https://github.com/btcpayserver/btcpayserver-doc/#deployment).
|
|
|
|
## Supported altcoins
|
|
|
|
Bitcoin is the only focus of the project and its core developers. However, opt in integrations are present for several altcoins:
|
|
|
|
* Bitcore (BTX)
|
|
* Dash (DASH)
|
|
* Dogecoin (DOGE)
|
|
* Feathercoin (FTC)
|
|
* Groestlcoin (GRS)
|
|
* Litecoin (LTC)
|
|
* Monacoin (MONA)
|
|
* Polis (POLIS)
|
|
* Viacoin (VIA)
|
|
* BGold (BTG) (also known as Bitcoin Gold)
|
|
* BPlus (XBC) (also known as Bitcoin Plus)
|
|
|
|
Altcoins are maintained by their respective communities.
|