diff --git a/Production/README.md b/Production/README.md index 55f33e1..7bef8ce 100644 --- a/Production/README.md +++ b/Production/README.md @@ -1,6 +1,6 @@ # About this docker-compose -The docker-compose can be used for production purpose. +The `docker-compose` can be used for production purpose. It is composed of: @@ -13,7 +13,7 @@ It is composed of: ![Architecture](Production.png) -This docker-compose is used for [one click deploy on azure](https://github.com/btcpayserver/btcpayserver-azure) by an Ubuntu, it can be used on any docker supporting host. +This `docker-compose` is used for [one click deploy on azure](https://github.com/btcpayserver/btcpayserver-azure) by an Ubuntu, it can be used on any docker supporting host. The relevant environment variables are: diff --git a/README.md b/README.md index d290014..d29803b 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,23 @@ # How to use -Here is BTCPay Architecture +This repository is hosting different docker-compose which can be used to facilitate deployment of BTCPay Server. ![Architecture](https://github.com/btcpayserver/btcpayserver-doc/raw/master/img/Architecture.png) -As you can see, it depends on several piece of infrastructure, mainly NBXplorer, Postgres, and Bitcoin Core. -Setting up the dependencies might be time consuming, this repository is meant to give working example of docker-compose file which will setup everything for you. +As you can see, it depends on several piece of infrastructure, mainly: -This assume you already know how docker-compose works. +* A lightweight block explorer (NBXplorer), +* A database (Postgres, or SQLite), +* A full node (Bitcoin Core) + +Setting up the dependencies might be time consuming, this repository is meant to give working example of `docker-compose` file which will setup everything for you. Used docker image used [BTCPayServer](https://hub.docker.com/r/nicolasdorier/btcpayserver/), [NBXplorer](https://hub.docker.com/r/nicolasdorier/nbxplorer/), [Bitcoin Core](https://hub.docker.com/r/nicolasdorier/docker-bitcoin/) and [Postgres](https://hub.docker.com/_/postgres/). -The [Regtest](Regtest) docker-compose is used for local testing. +The [Regtest](Regtest) `docker-compose` can be used for local testing. -The [Production](Production) docker-compose is used for production environment. It is using NGinx as a reverse proxy and [Let's Encrypt and DockerGen](https://github.com/gilyes/docker-nginx-letsencrypt-sample) to automatically configured HTTPS. +The [Production](Production) `docker-compose` is used for production environment. It is using NGinx as a reverse proxy and [Let's Encrypt and DockerGen](https://github.com/gilyes/docker-nginx-letsencrypt-sample) to automatically configured HTTPS. -You can provision a production BTCPay Server on Azure via this button: +The production `docker-compose` is used under the hood to deploy an instance of BTCPay on Microsoft Azure in one click: [![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) \ No newline at end of file diff --git a/Regtest/README.md b/Regtest/README.md index bb0ee05..4e5e37a 100644 --- a/Regtest/README.md +++ b/Regtest/README.md @@ -1,6 +1,8 @@ # About this docker-compose -This docker-compose shows how to configure postgres, bitcoind, NBXplorer and BTCPay on regtest. +This `docker-compose` shows how to configure postgres, bitcoind, NBXplorer and BTCPay on regtest. + +![Architecture](https://github.com/btcpayserver/btcpayserver-doc/raw/master/img/Architecture.png) It exposes BTCPay on the host address http://localhost:8080/.