From 9dfa755aa15983a61898c4e837b8d63091a109d6 Mon Sep 17 00:00:00 2001 From: "nicolas.dorier" Date: Fri, 27 Jul 2018 11:25:07 +0900 Subject: [PATCH] Clarify doc to not confuse user about old docker-compose --- Production-NoReverseProxy/README.md | 13 ++++++++++++- Production/README.md | 13 ++++++++++++- README.md | 23 +++++------------------ 3 files changed, 29 insertions(+), 20 deletions(-) diff --git a/Production-NoReverseProxy/README.md b/Production-NoReverseProxy/README.md index 8292909..095358e 100644 --- a/Production-NoReverseProxy/README.md +++ b/Production-NoReverseProxy/README.md @@ -1,4 +1,15 @@ -# About this docker-compose +# About those pre-generated docker-compose + +All `docker-compose` files in this folder are generated by running the [build-pregen.sh](build-pregen.sh) (or [build-pregen.ps1](build-pregen.ps1)) script from the fragments located in [docker-compose-generator/docker-fragments](docker-compose-generator/docker-fragments). + +The pre-generated `docker-compose` files only cover `btc`, `ltc`, `clightning` without reverse proxy. + +--- + +We strongly advise you to not use the pre-generated docker-compose of this folder, they are deprecated and kept only for backward compatibility. +Instead use the [build.sh](../build.sh) as documented in (README)(../Readme.md) to generate a docker-compose which fit your needs. + +--- This `docker-compose` files can be used for production purpose. diff --git a/Production/README.md b/Production/README.md index ce32189..fbbb0c1 100644 --- a/Production/README.md +++ b/Production/README.md @@ -1,4 +1,15 @@ -# About this docker-compose +# About those docker-compose + +All `docker-compose` files in [Production](Production) and [Production-NoReverseProxy](Production-NoReverseProxy) are generated by running the [build-pregen.sh](build-pregen.sh) (or [build-pregen.ps1](build-pregen.ps1)) script from the fragments located in [docker-compose-generator/docker-fragments](docker-compose-generator/docker-fragments). + +The pre-generated `docker-compose` files only cover `btc`, `ltc`, `clightning` with `nginx`. + +--- + +We strongly advise you to not use the pre-generated docker-compose of this folder, they are deprecated and kept only for backward compatibility. +Instead use the [build.sh](../build.sh) as documented in (README)(../Readme.md) to generate a docker-compose which fit your needs. + +--- The `docker-compose` can be used for production purpose. diff --git a/README.md b/README.md index 8ca03d4..e911bd3 100644 --- a/README.md +++ b/README.md @@ -79,29 +79,18 @@ A wide range of tooling get available on your system when btcpay is installed: * `bitcoin-lightning-cli.sh` access your clightning node instance * `changedomain.sh` change the domain of your BTCPayServer * `btcpay-update.sh` update BTCPay to the latest version +* `btcpay-up.sh` Run docker-compose up +* `btcpay-down.sh` Run docker-compose down * `btcpay-setup.sh` change the settings of your server (run `. ./btcpay-setup.sh` to get more information about additional parameters, run `. ./btcpay-setup.sh -i` to setup again your btcpay server) # Under the hood -## Prebuilt docker-compose - -For your custom need, you will find some working example of `docker-compose` file which will setup everything for you. - -The [Production](Production) `docker-compose` files are used for production environment. It adds NGinx as a reverse proxy and [Let's Encrypt and DockerGen](https://github.com/gilyes/docker-nginx-letsencrypt-sample) to automatically configure HTTPS. - -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) - -The [Production-NoReverseProxy](Production-NoReverseProxy) `docker-compose` files are used for environment which are already behind a reverse proxy. It exposes BTCPayServer directly on port 80. - ## Generated docker-compose -All `docker-compose` files in [Production](Production) and [Production-NoReverseProxy](Production-NoReverseProxy) are generated by running the [build-pregen.sh](build-pregen.sh) (or [build-pregen.ps1](build-pregen.ps1)) scripts from the fragments located in [docker-compose-generator/docker-fragments](docker-compose-generator/docker-fragments). +Under the hood, your environment variable are used by [build.sh](build.sh) (or [build.ps1](build.ps1)) to generate a docker-compose adapted for your need. +By default, this script will generate `Generated/docker-compose.generated.yml`. -The pre-generated `docker-compose` files cover `btc`, `ltc`, `clightning` for configuration with or without `nginx `reverse proxy. - -If you want any other configuration, you need to run [build.sh](build.sh) (or [build.ps1](build.ps1)) with environment variables correctly set. +The build script is generating the docker-compose by gluing together the relevant [docker fragment](docker-compose-generator/docker-fragments) for your setup. To configure your custom docker-compose, the following environment variables are supported: @@ -110,8 +99,6 @@ To configure your custom docker-compose, the following environment variables are * `BTCPAYGEN_LIGHTNING`: Specify the lightning network implementation (Valid value: `clightning`, `none`) * `BTCPAYGEN_SUBNAME`: The sub name of the generated docker-compose file, where the full name will be `Generated/docker-compose.SUBNAME.yml` (Default: `generated`) -Then, running [build.sh](build.sh) (or [build.ps1](build.ps1)) will then generate a `docker-compose.generated.yml` in the [Generated](Generated) folder of this repository. - For example, if you want `btc` and `ltc` support with `nginx` and `clightning` inside `Generated/docker-compose.custom.yml`: Note: The first run might take a while, but next run are instantaneous.