btcpayserver/README.md

203 lines
9.5 KiB
Markdown
Raw Normal View History

2017-12-19 03:41:33 +01:00
![BTCPay Server](BTCPayServer/wwwroot/img/btc_pay_BG_twitter.png)
[![Docker Automated build](https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg)](https://hub.docker.com/r/btcpayserver/btcpayserver/)
2017-12-19 04:41:15 +01:00
[![Deploy to Azure](https://azuredeploy.net/deploybutton.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fbtcpayserver%2Fbtcpayserver-azure%2Fmaster%2Fazuredeploy.json)
2018-10-28 12:28:16 +01:00
[![CircleCI](https://circleci.com/gh/btcpayserver/btcpayserver.svg?style=svg)](https://circleci.com/gh/btcpayserver/btcpayserver)
2017-09-29 08:13:07 +02:00
2017-09-13 08:47:34 +02:00
# BTCPay Server
## Introduction
2017-09-13 08:47:34 +02:00
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.
2017-09-13 08:47:34 +02:00
BTCPay Server is a non-custodial invoicing system which eliminates the involvement of a third-party. Payments with BTCPay Server 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.
2017-09-13 08:47:34 +02:00
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.
2017-10-21 13:30:59 +02:00
You can run BTCPay Server 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).
2018-06-23 17:45:57 +02:00
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.
2019-04-19 13:23:35 +02:00
[![What is BTCPay](https://img.youtube.com/vi/q7xJMno_B3U/sddefault.jpg)](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](#other-dependencies)
## Features
* Direct, peer-to-peer Bitcoin payments
* No transaction fees (other than the [network fee](https://en.bitcoin.it/wiki/Miner_fees))
* No processing fees
* No middleman
* No KYC
* Non-custodial (complete control over the private key)
* Enhanced privacy
* Enhanced security
* Self-hosted
* SegWit support
* Lightning Network support (LND, c-lightning, Eclair and Ptarmigan)
* Tor support
2020-02-09 17:35:00 +01:00
* Opt-in [altcoin](https://github.com/btcpayserver/btcpayserver-doc/blob/master/Altcoins.md) integrations
* Full compatibility with BitPay API (easy migration)
* Process payments for others
* Easy-embeddable Payment buttons
* Point of sale app
* Crowdfunding app
* Payment Requests
2020-02-09 17:35:00 +01:00
* Internal, full-node reliant wallet with [hardware wallet integration](https://github.com/btcpayserver/btcpayserver-doc/blob/master/Vault.md)
## 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/getting-started/registeraccount) 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).
2017-12-19 04:19:08 +01:00
## Documentation
2017-10-21 13:53:48 +02:00
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.
2018-03-02 21:04:00 +01:00
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/).
2018-03-05 16:58:27 +01:00
2019-04-10 20:37:37 +02:00
## Contributing
2019-04-10 20:37:37 +02:00
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.
- [Setting up development environment on Windows](https://www.youtube.com/watch?v=ZePbMPSIvHM)
- [Setting up development environment Linux (Ubuntu)](https://www.youtube.com/watch?v=j486T_Rk-yw&t)
- [Setting up development environment MacOS](https://www.youtube.com/watch?v=GWR_CcMsEV0)
2019-04-12 11:03:05 +02:00
You also have an awesome video of our contributors which explains how to get started.[![Rockstar Dev and Britt Kelly - Btc Pay Server Code Along](https://img.youtube.com/vi/ZePbMPSIvHM/sddefault.jpg)](https://www.youtube.com/embed/VNMnd-dX9Q8)
2019-04-12 11:03:05 +02:00
Here is some info about [how to extend the themes](https://github.com/btcpayserver/btcpayserver-doc/blob/master/Theme.md)
2018-03-05 16:58:27 +01:00
## How to build
While the documentation advises to use docker-compose, you may want to build BTCPay Server yourself.
2018-03-05 16:58:27 +01:00
First install .NET Core SDK v3.1 as specified by [Microsoft website](https://dotnet.microsoft.com/download/dotnet-core/3.1).
2018-03-06 15:35:20 +01:00
2018-03-06 15:18:00 +01:00
On Powershell:
2018-03-05 16:58:27 +01:00
```
2018-03-06 15:18:00 +01:00
.\build.ps1
```
On linux:
```
2018-03-06 15:40:21 +01:00
./build.sh
2018-03-05 16:58:27 +01:00
```
## How to run
2018-10-14 14:26:47 +02:00
Use the `run` scripts to run BTCPayServer, this example shows how to print the available command line arguments of BTCPayServer.
2018-03-06 15:18:00 +01:00
On Powershell:
```
.\run.ps1 --help
```
On linux:
2018-03-05 16:58:27 +01:00
```
2018-03-06 15:40:21 +01:00
./run.sh --help
2018-03-05 16:58:27 +01:00
```
2018-03-06 15:40:21 +01:00
## How to debug
If you want to debug, use Visual Studio Code or Visual Studio 2019.
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.
2018-03-06 15:40:21 +01:00
## Other dependencies
2018-10-14 14:28:09 +02:00
For more information, see the documentation: [How to deploy a BTCPay server instance](https://github.com/btcpayserver/btcpayserver-doc/#deployment).
2019-04-10 19:30:54 +02:00
## Supported altcoins
2019-11-07 11:33:11 +01:00
Bitcoin is the only focus of the project and its core developers. However, opt in integrations are present for [several altcoins](https://github.com/btcpayserver/btcpayserver-doc/blob/master/Altcoins.md). Altcoins are maintained by their respective communities.
## License
2020-02-09 19:01:52 +01:00
BTCPay Server software, logo and designs are provided under [MIT License](https://github.com/btcpayserver/btcpayserver/blob/master/LICENSE).
2019-11-07 11:33:11 +01:00
## Supporters
The BTCPay Server Project is proudly supported by these entities through the [BTCPay Server Foundation](https://foundation.btcpayserver.org/).
<table>
<tbody>
<tr>
<td align="center" valign="middle">
<a href="https://twitter.com/sqcrypto" target="_blank">
2019-11-13 10:38:31 +01:00
<img src="BTCPayServer/wwwroot/img/squarecrypto.svg" alt="Square Crypto" height=100>
2019-11-07 11:33:11 +01:00
<br/>
<span>Square Crypto</span>
</a>
2019-11-13 10:38:31 +01:00
</td>
2020-03-10 10:28:15 +01:00
<td align="center" valign="middle">
<a href="https://www.btse.com" target="_blank">
<img src="BTCPayServer/wwwroot/img/btse.svg" alt="BTSE" height=100>
<br/>
<span>BTSE</span>
</a>
</td>
2019-11-13 10:38:31 +01:00
<td align="center" valign="middle">
<a href="https://www.dglab.com/en/" target="_blank">
<img src="BTCPayServer/wwwroot/img/dglab.svg" alt="DG Lab" height=100>
<br/>
<span>DG Lab</span>
</a>
2019-11-07 11:33:11 +01:00
</td>
<td align="center" valign="middle">
<a href="https://acinq.co/" target="_blank">
<img src="BTCPayServer/wwwroot/img/acinq-logo.svg" alt="ACINQ" height=100>
<br/>
<span>ACINQ</span>
</a>
</td>
2019-11-18 15:55:56 +01:00
<td align="center" valign="middle">
<a href="https://lunanode.com" target="_blank">
<img src="BTCPayServer/wwwroot/img/lunanode.svg" alt="LunaNode" height=100>
<br/>
<span>LunaNode</span>
</a>
</td>
<td align="center" valign="middle">
<a href="https://walletofsatoshi.com/" target="_blank">
<img src="BTCPayServer/wwwroot/img/walletofsatoshi.svg" alt="Wallet of Satoshi" height=100>
<br/>
<span>Wallet of Satoshi</span>
2019-11-18 15:55:56 +01:00
</a>
</td>
2019-11-07 11:33:11 +01:00
</tr>
</tbody>
</table>
If you'd like to support the project, please visit the [donation page](https://btcpayserver.org/donate/).