btcpayserver/btcpayserver-googlecloud
btcpayserver/btcpayserver-googlecloud
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

more imagesand video link

Browse Source
This commit is contained in:
Masashi Nakane 2018-10-23 19:34:54 -07:00
parent 656d61536e
commit 3767b4ff80
3 changed files with 66 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
README.md
View File

@ -6,34 +6,52 @@ The following instructions assume you have [Google Cloud](https://console.cloud.
[![Open in Cloud Shell](http://gstatic.com/cloudssh/images/open-btn.svg)](https://console.cloud.google.com/cloudshell/open?git_repo=https%3A%2F%2Fgithub.com%2Fbtcpayserver%2Fbtcpayserver-googlecloud&page=editor)
You can see our video for an overview: COMMING SOON!
[![BTCPay - One Command Setup on Google Cloud](http://img.youtube.com/vi/Bxs95BdEMHY/mqdefault.jpg)]
You can see our video for an overview:
[![BTCPay - Google cloud shell Setup](https://i.ytimg.com/vi/LXwEuvHK9Aw/hqdefault.jpg)](https://youtu.be/LXwEuvHK9Aw "BTCPay - Google cloud shell Setup")
You can find more details about the tooling install in the Virtual Machine in [the tooling section of BTCPayServer-Docker repository](https://github.com/btcpayserver/btcpayserver-docker/blob/master/README.md#tooling).
## Overview
To install BTCPay server with this google cloud deployment template
1. Install gcloud sdk locally or use Google cloud shell on console with the link above
2. set the default project and zone to gcloud env where the BTCPay instance belongs
3. Modify the instance and BTCPay's parameters in yaml file
4. run deploy script and it shows static IP for DNS
1. Start Google cloud shell with the link above (or Install gcloud sdk local computer)
2. set the default project and zone to gcloud env where the BTCPay instance belongs
3. Modify the instance and BTCPay's parameters in yaml file
4. run deploy script and it shows static IP assgined for later use, DNS
5. Do DNS setup with your Domain name provider (Google DNS, GOdaddy etc.)
6. ssh into the vm instance and run changedomain.sh to setup free ssl certificate
7. test to access the https:<yourdomain> and sign up (1st user becomes admin user)
7. test to access https://\<yourdomain\> and sign up (1st registered user becomes the admin user)
## Setup gcloud tool
In case you run the deploy script from local (PC or mac), you need to install gcloud tool. https://cloud.google.com/sdk/docs/
(But, if you prefer the Google cloud shell, you dont need it.It's already there.)
In case that you run the deploy script from local computer, you need to install gcloud sdk tool. https://cloud.google.com/sdk/docs/
If you prefer the Google cloud shell, you dont need to install anything and what is better? You dont need update the sdk. It's already in the cloud .Just click the link above in this document. This document is written for google cloud shell, but it should be very similar to local gcloud sdk.
Then, setup the gcloud environment by gcloud init command as prompted by installer.
You will authenticate to connect google cloud with your google accout and set up the default project and default zone.
Now, assuming that you have a google cloud shell running on your browser, you would notice this repo is automatically cloned and change-directory-ed to the folder. How cool ! Let's set up the default project and default zone.
```
hypergori@cloudshell:~/btcpayserver-googlecloud$ gcloud config set project testproject
Updated property [core/project].
hypergori@cloudshell:~/btcpayserver-googlecloud (testproject)$ gcloud config set compute/zone asia-northeast1-b
Updated property [compute/zone].
```
## Modify parameters in the main.btcpay.yaml
Either from your local gcloud environment or from Google console's gcloud environment, you have to customize your BTCPay server install parameters by modifying in the file.
Either from your local gcloud environment or from Google console's gcloud environment, you can customize your BTCPay server install parameters by modifying in the file.THe detail is the table below.
The default config is,
* region is asia-northeast1
* zone is asia-northeast1-b
* 1 vCPU with 7.6G Memory
* boot disksize : 500GB
* bitcoin testnet
* use lnd
* temporary Hostname is btcpaytest.mycompany.net (will change it later)
* prune mode with 1 year data
![config yaml](images/yaml.png)
### Parameters
Mandatory fields are required and you have to decide what to set.
Mandatory fields in the red rectangle above are required and you have to decide what to set.
Optional parameters are not required and normally just keep it empty.
Customze parameters are for experts only and change only when you know what you are doing.
@ -41,36 +59,43 @@ Customze parameters are for experts only and change only when you know what you
| ------------- | ------------- |------------- | ------------- |
| Mandatory| region | Region to deploy | asia-northeast1|
| Mandatory| zone | Zone to deploy | asia-northeast1-b |
| Mandatory| vmtype | vm type,f1-micro etc or custom-numOfCpu-memInMeg-ext | custom-1-7680-ext |
| Mandatory| vmtype | [vm type,f1-micro etc or custom-numOfCpu-memInMeg-ext](https://cloud.google.com/compute/docs/machine-types) | custom-1-7680-ext |
| Mandatory| diskSizeGb | root disk size in GB | 500 |
| Mandatory| BTCPAY_HOST | host name of the btcpay server | btcpaytest.mycompany.net|
| Mandatory| NBITCOIN_NETWORK | network type | testnet |
| Mandatory| NBITCOIN_NETWORK | [network type](https://github.com/btcpayserver/btcpayserver-docker/tree/master/Production) | testnet |
| Mandatory| BTCPAYGEN_CRYPTO1 | crypto currecy | btc |
| Mandatory| BTCPAYGEN_LIGHTNING | lightning implementation type (lnd or c-lightning) | lnd |
| Optional| LETSENCRYPT_EMAIL | email notified by let's encrypt free SSL | |
| Optional| LIGHTNING_ALIAS | lightning node's alias | |
| Optional| BTCPAYGEN_CRYPTO2 | other crypto currency, ltc ,btg | |
| Optional| CUSTOM_SSH_KEY | ssh public key | | |
| Customize| BTCPAYGEN_ADDITIONAL_FRAGMENTS | bitcoind prune config | opt-save-storage |
| Customize| BTCPAYGEN_ADDITIONAL_FRAGMENTS | [bitcoind prune config](https://github.com/btcpayserver/btcpayserver-docker/blob/master/README.md#generated-docker-compose-) | opt-save-storage |
| Customize| BTCPAY_DOCKER_REPO | btcpay github repo |https://github.com/btcpayserver/btcpayserver-docker |
| Customize| BTCPAY_DOCKER_REPO_BRANCH | btcpay github repo branch |master |
| Customize| BTCPAYGEN_REVERSEPROXY | reverse proxy |nginx |
| Customize| ACME_CA_URI | let's encrpt url |https://acme-staging.api.letsencrypt.org/directory |
## What the Deployment script does
It would cost USD 70 with above default config,and you can adjust the config in yaml.
What dose this deployment script do ?
1. It creates the VM instance as you configured in the yaml, that is CPU, Memory, Disk size etc. It uses gcloud command under the hood.
1. It creates the VM instance as you configured in the yaml, that is CPU, Memory, Disk size. It runs gcloud command under the hood.
2. It creates 1 public static IP and attach it to the instance
3. Install BTCPay server on the root directory as root using docker compose from BTCPay Github repo
## What the Deployment script does not do
1. DNS ip mapping should be done manually in any DNS server of your choice
2. then, ssl certificate generation should be done via ssh
1. DNS ip mapping should be done manually by yourself at any DNS service of your choice
2. Also, ssl certificate generation should be done via ssh from Google cloud console
## Deploy
Once you configure the yaml file. You are ready to deploy it to GCP.
It outpus the static IP address when it succeeded. The name passed after the deploy script can be anything and it becomes the name of the deployment, vm instance name in GCE with suffix "-vm" and network name with suffix "-network"
Once you configure the yaml file. You are ready to deploy it to GCP.
Do "chmod" to the shell scripts and run it.
```
chmod 755 *.sh
./deploy btcpaytest1
```
Around 1 minute later, it outputs the static IP address when it succeeded. If you failed or made mistake on config. you can easily cleanup by undeploy.sh .
The name passed after the deploy shell script can be anything and it becomes the name of the deployment, vm instance name in GCE with suffix "-vm" and network name with suffix "-network"
With bash,
```
@ -82,8 +107,22 @@ With Powershell
```
![Run deploy script](images/gcloud-on-cloudshell.png)
Then, Go to your DNS service and map the IP with your domain name.
Now, you have to generate free SSL certificate with Let's encrypt.
## UnDeploy
With bash,
```
./undeploy.sh btcpaytest1
```
With Powershell
```ps
./undeploy.ps1 btcpaytest1
```
## DNS Mapping and generate ssl certificate
Then, Go to your DNS service and map the IP with your domain name.
Now, you want to generate free SSL certificate with Let's encrypt.
It's easy. just ssh to the vm and run 1 command.
Go to Google Cloud console -> Compute Engine -> VM instances
You will see the name of the deployment with "-vm" appended in the list of VMs.
@ -96,23 +135,15 @@ cd /btcpayserver-docker/
change directory to /btcpay , and then run changedomain.sh with the domain name.
```
changedomain.sh btcpaytest1.mycompany.net
changedomain.sh your.newdmain.name
```
![How to change domain name and setup ssl certificate](images/changeDomain.png)
Test the install by accessing https://\<your host name\> and signup the 1st user.
You will see the BTCPay top page.
## Undeploy
![Conglatulation!](images/BTCPay_top.png)
When you undeploy it, you can use undeploy script. It remove everything from vm to IP address.
With bash,
```
./undeploy.sh btcpaytest1
```
With Powershell
```ps
./undeploy.ps1 btcpaytest1
```

BIN
images/BTCPay_top.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 265 KiB

BIN
images/yaml.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 112 KiB