From 8fbf8bdcc9a65669f01b46ccfc60d3f6d77dc421 Mon Sep 17 00:00:00 2001 From: "nicolas.dorier" Date: Thu, 22 Mar 2018 01:44:39 +0900 Subject: [PATCH] update readme --- Production-NoReverseProxy/README.md | 6 +++++- Production/README.md | 6 +++++- README.md | 2 +- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/Production-NoReverseProxy/README.md b/Production-NoReverseProxy/README.md index 91ad71e..36b67ba 100644 --- a/Production-NoReverseProxy/README.md +++ b/Production-NoReverseProxy/README.md @@ -14,7 +14,11 @@ The relevant environment variables are: * `BTCPAY_PROTOCOL`: the protocol used to access this website from the internet (valid values: `http` and `https`, default: `https`) * `LIGHTNING_ALIAS`: Optional, if using the integrated lightning feature, customize the alias of your nodes -The port `80` is exposed. +The ports mapped on the host are: + +1. `80` for the website +3. `9735` for the bitcoin lightning network node (if used) +4. `9736` for the litecoin lightning network node (if used) Note that you need to set `BTCPAY_PROTOCOL=http` if you want to do some tests locally without https. diff --git a/Production/README.md b/Production/README.md index cfe30a1..0f32b03 100644 --- a/Production/README.md +++ b/Production/README.md @@ -27,10 +27,12 @@ Use `docker-compose.btc-ltc.yml` for bitcoin and litecoin support, or `docker-co Any unset or empty environment variable will be set for a `regtest` deployment. -The necessary open ports are: +The ports mapped on the host are: 1. `80` for Let's encrypt 2. `443` for the website +3. `9735` for the bitcoin lightning network node (if used) +4. `9736` for the litecoin lightning network node (if used) Example for running on `mainnet`: @@ -54,4 +56,6 @@ docker-compose up ` -e "ACME_CA_URI=https://acme-v01.api.letsencrypt.org/directory" ``` +See also [The guide for docker noobs](../README.md#fornoobs). + Make sure the domain `btcpay.example.com` point to your server and that port `80` and `443` are open. \ No newline at end of file diff --git a/README.md b/README.md index 13ed8cc..f1a5bab 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ You can use it easily: ./bitcoin-cli.sh getblockcount ``` -# For docker noobs +# For docker noobs If you are a docker noob here is how you would create a HTTPS ready server.