AaronFiore/btcpayserver-docker
1
0
Fork 0
Code Activity

Merge pull request #20 from ch4ot1c/docs/readme

Browse Source 
[docs] Final Readme.md touchups
This commit is contained in:
Nicolas Dorier
2018-08-24 18:30:46 +09:00
committed by GitHub
parent 8c49cafbd6 2efd92fb32
commit d5a698dbf6
1 changed files with 14 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -19,10 +19,10 @@ Final installation steps:
* Browse to `https://SERVER-AZURE-DNS/` * Browse to `https://SERVER-AZURE-DNS/`
* Register a new account (this account will be granted server administrator rights) * Register a new account (this account will be granted server administrator rights)
* Go to `https://SERVER-AZURE-DNS/server/maintenance` * Go to `https://SERVER-AZURE-DNS/server/maintenance`
* Enter your DNS name and click on confirm * Enter your domain name and click on confirm
* Wait 1 to 5 minutes * (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/` 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: For advanced users, you can connect via SSH with information on `https://btcpay.YOUR-DOMAIN/server/services/ssh`, then you can:
@@ -59,9 +59,11 @@ 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. You can also install BTCPayServer on your own machine or VPS instance.
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). The officially supported setup is driven by Docker (and Docker-Compose).
Let's assume it is `btcpay.example.com`. 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`.
If you want to support Litecoin, Bitcoin, and C-Lightning, and want HTTPS automatically configured by Nginx: If you want to support Litecoin, Bitcoin, and C-Lightning, and want HTTPS automatically configured by Nginx:
@@ -78,7 +80,7 @@ git clone https://github.com/btcpayserver/btcpayserver-docker
cd btcpayserver-docker cd btcpayserver-docker
# Run btcpay-setup.sh with the right parameters # 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 NBITCOIN_NETWORK="mainnet"
export BTCPAYGEN_CRYPTO1="btc" export BTCPAYGEN_CRYPTO1="btc"
export BTCPAYGEN_CRYPTO2="ltc" export BTCPAYGEN_CRYPTO2="ltc"
@@ -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. 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 # Environment variables
`btcpay-setup.sh` will use the following environment variables: `btcpay-setup.sh` will use the following environment variables:
@@ -250,10 +255,10 @@ WantedBy=multi-user.target
`.env` (`$BTCPAY_ENV_FILE`) contains environment variables passed to the containers managed by your docker-compose: `.env` (`$BTCPAY_ENV_FILE`) contains environment variables passed to the containers managed by your docker-compose:
```ini ```ini
BTCPAY_HOST=btcpay.example.com BTCPAY_HOST=btcpay.EXAMPLE.com
ACME_CA_URI=https://acme-v01.api.letsencrypt.org/directory ACME_CA_URI=https://acme-v01.api.letsencrypt.org/directory
NBITCOIN_NETWORK=mainnet NBITCOIN_NETWORK=mainnet
LETSENCRYPT_EMAIL=me@example.com LETSENCRYPT_EMAIL=me@EXAMPLE.com
BTCPAY_SSHTRUSTEDFINGERPRINTS=SHA256:eSCD7NtQ/Q6IBl2iRB9caAQ3lDZd8s8iUL6SdeNnhpA BTCPAY_SSHTRUSTEDFINGERPRINTS=SHA256:eSCD7NtQ/Q6IBl2iRB9caAQ3lDZd8s8iUL6SdeNnhpA
BTCPAY_SSHKEYFILE=/datadir/id_rsa BTCPAY_SSHKEYFILE=/datadir/id_rsa
``` ```
@@ -270,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: Instead, install [.NET Core 2.1 SDK](https://www.microsoft.com/net/download/windows) and run:
```bash ```bash
BTCPAYGEN_CRYPTO1="xxx" BTCPAYGEN_CRYPTO1="EXAMPLE-COIN"
BTCPAYGEN_SUBNAME="test" BTCPAYGEN_SUBNAME="test"
cd docker-compose-generator/src cd docker-compose-generator/src
dotnet run dotnet run