From 763ed95a6ead2c74b0e3137f0204e94111277b91 Mon Sep 17 00:00:00 2001 From: "David E. Myers" Date: Tue, 21 Jan 2020 09:30:51 -0500 Subject: [PATCH] Document using Google Cloud Shell --- README.md | 2 +- docs/deploy-from-cloudshell.md | 15 +++++++++++++++ docs/index.md | 1 + 3 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/deploy-from-cloudshell.md diff --git a/README.md b/README.md index cf64162..c044d3d 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Algo VPN is a set of Ansible scripts that simplify the setup of a personal WireG ## Deploy the Algo Server -The easiest way to get an Algo server running is to run it on your local system and let it set up a _new_ virtual machine in the cloud for you. +The easiest way to get an Algo server running is to run it on your local system or from [Google Cloud Shell](docs/deploy-from-cloudshell.md) and let it set up a _new_ virtual machine in the cloud for you. 1. **Setup an account on a cloud hosting provider.** Algo supports [DigitalOcean](https://m.do.co/c/4d7f4ff9cfe4) (most user friendly), [Amazon Lightsail](https://aws.amazon.com/lightsail/), [Amazon EC2](https://aws.amazon.com/), [Vultr](https://www.vultr.com/), [Microsoft Azure](https://azure.microsoft.com/), [Google Compute Engine](https://cloud.google.com/compute/), [Scaleway](https://www.scaleway.com/), [DreamCompute](https://www.dreamhost.com/cloud/computing/) or other OpenStack-based cloud hosting, [Exoscale](https://www.exoscale.com) or other CloudStack-based cloud hosting, or [Hetzner Cloud](https://www.hetzner.com/). diff --git a/docs/deploy-from-cloudshell.md b/docs/deploy-from-cloudshell.md new file mode 100644 index 0000000..f0f0fed --- /dev/null +++ b/docs/deploy-from-cloudshell.md @@ -0,0 +1,15 @@ +# Deploy from Google Cloud Shell + +If you want to try Algo but don't wish to install the software on your own system you can use the **free** [Google Cloud Shell](https://cloud.google.com/shell/) to deploy a VPN to any supported cloud provider. Note that you cannot choose `Install to existing Ubuntu server` to turn Google Cloud Shell into your VPN server. + +1. See the [Cloud Shell documentation](https://cloud.google.com/shell/docs/) to start an instance of Cloud Shell in your browser. + +2. Follow the [Algo installation instructions](https://github.com/trailofbits/algo#deploy-the-algo-server) as shown but skip step **3. Install Algo's core dependencies** as they are already installed. Run Algo to deploy to a supported cloud provider. + +3. Once Algo has completed, retrieve a copy of the configuration files that were created to your local system. While still in the Algo directory, run: + ``` + zip -r configs configs + dl configs.zip + ``` + +4. Unzip `configs.zip` on your local system and use the files to configure your VPN clients. diff --git a/docs/index.md b/docs/index.md index 7c7bde6..8b6ac8f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,6 +7,7 @@ - Deploy from [Ansible](deploy-from-ansible.md) non-interactively - Deploy onto a [cloud server at time of creation with shell script or cloud-init](deploy-from-script-or-cloud-init-to-localhost.md) - Deploy from [macOS](deploy-from-macos.md) + - Deploy from [Google Cloud Shell](deploy-from-cloudshell.md) * Client setup - Setup [Android](client-android.md) clients - Setup [Generic/Linux](client-linux.md) clients with Ansible