From 58480317ee3e50aee82253ddc8455de955a9f341 Mon Sep 17 00:00:00 2001 From: Jon Layton Date: Thu, 23 Aug 2018 14:40:45 -0500 Subject: [PATCH 1/4] [docs] Add docker badge, touchups --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 28a5880..4460d7e 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,10 @@ Final installation steps: * Browse to `https://SERVER-AZURE-DNS/` * Register a new account (this account will be granted server administrator rights) * Go to `https://SERVER-AZURE-DNS/server/maintenance` -* Enter your DNS name and click on confirm -* Wait 1 to 5 minutes +* Enter your domain name and click on confirm +* (Wait 1 to 5 minutes) -That's it, you can now browse `https://btcpay.YOUR-DOMAIN/` +That's it, you can now browse to `https://btcpay.YOUR-DOMAIN/`! For advanced users, you can connect via SSH with information on `https://btcpay.YOUR-DOMAIN/server/services/ssh`, then you can: @@ -59,6 +59,8 @@ Note: The setup process can be time consuming, but is heavily automated to make You can also install BTCPayServer on your own machine or VPS instance. +The officially supported setup is driven by Docker (and Docker-Compose). + First, make sure you have a domain name pointing to your host, with ports `443` and `80` externally accessible (and perhaps additional ports like `9735` and `9736` for Bitcoin and Litecoin lightning). Let's assume it is `btcpay.example.com`. @@ -100,6 +102,9 @@ exit You can read [the article](https://medium.com/@BtcpayServer/hosting-btcpay-server-for-cheap-2b27761fdb9d) for step by step instructions. +[![Docker automated build](https://img.shields.io/docker/automated/nicolasdorier/btcpayserver.svg)](https://hub.docker.com/r/nicolasdorier/btcpayserver/) + + # Environment variables `btcpay-setup.sh` will use the following environment variables: From 21cd2fb9a311aa0c154fc2cbefec38241b5e06e3 Mon Sep 17 00:00:00 2001 From: Jon Layton Date: Thu, 23 Aug 2018 14:46:15 -0500 Subject: [PATCH 2/4] [docs] Capitalize all EXAMPLEs --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4460d7e..2172384 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ The officially supported setup is driven by Docker (and Docker-Compose). First, make sure you have a domain name pointing to your host, with ports `443` and `80` externally accessible (and perhaps additional ports like `9735` and `9736` for Bitcoin and Litecoin lightning). -Let's assume it is `btcpay.example.com`. +Let's assume it is `btcpay.EXAMPLE.com`. If you want to support Litecoin, Bitcoin, and C-Lightning, and want HTTPS automatically configured by Nginx: @@ -80,7 +80,7 @@ git clone https://github.com/btcpayserver/btcpayserver-docker cd btcpayserver-docker # Run btcpay-setup.sh with the right parameters -export BTCPAY_HOST="btcpay.example.com" +export BTCPAY_HOST="btcpay.EXAMPLE.com" export NBITCOIN_NETWORK="mainnet" export BTCPAYGEN_CRYPTO1="btc" export BTCPAYGEN_CRYPTO2="ltc" @@ -255,10 +255,10 @@ WantedBy=multi-user.target `.env` (`$BTCPAY_ENV_FILE`) contains environment variables passed to the containers managed by your docker-compose: ```ini -BTCPAY_HOST=btcpay.example.com +BTCPAY_HOST=btcpay.EXAMPLE.com ACME_CA_URI=https://acme-v01.api.letsencrypt.org/directory NBITCOIN_NETWORK=mainnet -LETSENCRYPT_EMAIL=me@example.com +LETSENCRYPT_EMAIL=me@EXAMPLE.com BTCPAY_SSHTRUSTEDFINGERPRINTS=SHA256:eSCD7NtQ/Q6IBl2iRB9caAQ3lDZd8s8iUL6SdeNnhpA BTCPAY_SSHKEYFILE=/datadir/id_rsa ``` @@ -275,7 +275,7 @@ When testing your coin, **DO NOT USE `build.sh`**, since it uses a pre-built doc Instead, install [.NET Core 2.1 SDK](https://www.microsoft.com/net/download/windows) and run: ```bash -BTCPAYGEN_CRYPTO1="xxx" +BTCPAYGEN_CRYPTO1="EXAMPLE-COIN" BTCPAYGEN_SUBNAME="test" cd docker-compose-generator/src dotnet run From 8654c8184b803af3df61b516c9beaec40ef0cfae Mon Sep 17 00:00:00 2001 From: Jon Layton Date: Thu, 23 Aug 2018 15:03:37 -0500 Subject: [PATCH 3/4] [docs] Add warning / help with Full installation DNS --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2172384..35f51be 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ You can also install BTCPayServer on your own machine or VPS instance. The officially supported setup is driven by Docker (and Docker-Compose). -First, make sure you have a domain name pointing to your host, with ports `443` and `80` externally accessible (and perhaps additional ports like `9735` and `9736` for Bitcoin and Litecoin lightning). +First, make sure you have a domain name pointing to your host (CNAME), with ports `443` and `80` externally accessible (and perhaps additional ports like `9735` and `9736` for Bitcoin and Litecoin lightning). Otherwise, you will have to set it manually by running `changedomain.sh`. Let's assume it is `btcpay.EXAMPLE.com`. From 2efd92fb32377a501969559aaff6f451add56d39 Mon Sep 17 00:00:00 2001 From: Jon Layton Date: Thu, 23 Aug 2018 16:12:56 -0500 Subject: [PATCH 4/4] [docs] Remind users to create their store after setup --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 35f51be..c890216 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Final installation steps: * Enter your domain name and click on confirm * (Wait 1 to 5 minutes) -That's it, you can now browse to `https://btcpay.YOUR-DOMAIN/`! +That's it, you can now browse to `https://btcpay.YOUR-DOMAIN/` to create your store! For advanced users, you can connect via SSH with information on `https://btcpay.YOUR-DOMAIN/server/services/ssh`, then you can: