Retropex/btcpayserver-docker
1
0
Fork 0
mirror of https://github.com/Retropex/btcpayserver-docker.git synced 2025-05-13 05:20:40 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
nicolas.dorier 2018-03-22 01:44:39 +09:00
parent 3c64158903
commit 8fbf8bdcc9
3 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Production-NoReverseProxy/README.md
View File

@ -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`) * `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 * `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. Note that you need to set `BTCPAY_PROTOCOL=http` if you want to do some tests locally without https.

6
Production/README.md
View File

@ -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. 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 1. `80` for Let's encrypt
2. `443` for the website 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`: Example for running on `mainnet`:
@ -54,4 +56,6 @@ docker-compose up `
-e "ACME_CA_URI=https://acme-v01.api.letsencrypt.org/directory" -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. Make sure the domain `btcpay.example.com` point to your server and that port `80` and `443` are open.

2
README.md
View File

@ -37,7 +37,7 @@ You can use it easily:
./bitcoin-cli.sh getblockcount ./bitcoin-cli.sh getblockcount
``` ```
# For docker noobs # For docker noobs <a name="fornoobs" />
If you are a docker noob here is how you would create a HTTPS ready server. If you are a docker noob here is how you would create a HTTPS ready server.