From 15039ea8bcc1b9f72acd1011e5db763e6fa80e56 Mon Sep 17 00:00:00 2001 From: "nicolas.dorier" Date: Tue, 20 Mar 2018 14:10:32 +0900 Subject: [PATCH] Add instructions for docker noobs --- .gitignore | 1 + README.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/.gitignore b/.gitignore index 11b954d..00f3bfd 100644 --- a/.gitignore +++ b/.gitignore @@ -293,4 +293,5 @@ BTCPayServer/wwwroot/bundles/* !BTCPayServer/wwwroot/bundles/.gitignore Production/.env +.env .vscode/ diff --git a/README.md b/README.md index a5374ce..0b4e687 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,38 @@ You can use it easily: bitcoin-cli.sh getblockcount ``` +# For docker noobs + +If you are a docker noob here is how you would create a HTTPS ready server. + +First step is to make sure you have a domain name pointing to your host, and that port `443` and `80` and externally accessible. +Let's assume it is `btcpay.example.com`. + +Then, create a `.env` file in the directory. + +Clone the repository: +``` +git clone https://github.com/btcpayserver/btcpayserver-docker +cd btcpayserver-docker +``` + +Create an `.env` file with the parameters documented in [Production](Production) or [Production-NoReverseProxy](Production-NoReverseProxy). + +``` +NBITCOIN_NETWORK=mainnet +BTCPAY_HOST=btcpay.example.com +LETSENCRYPT_EMAIL=me@example.com +ACME_CA_URI=https://acme-v01.api.letsencrypt.org/directory +``` + +Save, then run it: + +``` +docker-compose -f "$(pwd)/Production/docker-compose.btc-ltc.yml" up -d +``` + +Wait a little bit, then you can now browse `https://btcpay.example.com/`. + # About generate-docker-compose The files in `Production` and `Production-NoReverseProxy` are generated by a dotnet program located in `docker-compose-generator`.