diff --git a/README.md b/README.md index 7364514b..f859d875 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,8 @@ Algo VPN is a set of Ansible scripts that simplifies the setup of a personal IPS The easiest way to get an Algo server running is to 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://www.digitalocean.com/) (most user friendly), [Amazon EC2](https://aws.amazon.com/), [Google Compute Engine](https://cloud.google.com/compute/), and [Microsoft Azure](https://azure.microsoft.com/). -2. [Download Algo](https://github.com/trailofbits/algo/archive/master.zip) -3. Install Algo's core dependencies for your operating system. To do this, open a terminal and `cd` into the directory where you downloaded Algo, then: +2. [Download Algo](https://github.com/trailofbits/algo/archive/master.zip) and decompress it in a convienent location. +3. Install Algo's core dependencies for your operating system. To do this, open the Terminal app and `cd` into the directory where you downloaded Algo, then run: macOS: `sudo easy_install pip` @@ -41,9 +41,9 @@ The easiest way to get an Algo server running is to let it set up a _new_ virtua Windows: See the [Windows documentation](docs/WINDOWS.md) -4. Install Algo's remaining dependencies for your operating system. Using the same terminal window as the previous step, run: +4. Install Algo's remaining dependencies for your operating system. Using the same terminal window as the previous step and run the command below. If you're on macOS, this may prompt you to install `cc` which you should accept. - `sudo pip install virtualenv && virtualenv env && source env/bin/activate && pip install -r requirements.txt` + `pip install virtualenv && virtualenv env && source env/bin/activate && pip install -r requirements.txt` 5. Open `config.cfg` in your favorite text editor. Specify the users you wish to create in the `users` list. 6. Start the deployment. Return to your terminal. In the Algo directory, run `./algo` and follow the instructions. There are several optional features available. None are required for a fully functional VPN server. These optional features are described in greater detail in [ROLES.md](docs/ROLES.md). diff --git a/algo b/algo index 76132fff..f8be2a13 100755 --- a/algo +++ b/algo @@ -94,7 +94,7 @@ Name the vpn server: azure_server_name=${azure_server_name:-algo} read -p " - What region should the server be located in? + What region should the server be located in? (https://azure.microsoft.com/en-us/regions/) 1. South Central US 2. Central US 3. North Europe @@ -109,6 +109,19 @@ Name the vpn server: 12. West Central US 13. UK South 14. UK West + 15. West US + 16. Brazil South + 17. Canada Central + 18. Central India + 19. East Asia + 20. Germany Central + 21. Germany Northeast + 22. Korea Central + 23. Korea South + 24. North Central US + 25. South India + 26. West India + Enter the number of your desired region: [1]: " -r azure_region azure_region=${azure_region:-1} @@ -128,6 +141,18 @@ Enter the number of your desired region: 12) region="westcentralus" ;; 13) region="uksouth" ;; 14) region="ukwest" ;; + 15) region="westus" ;; + 16) region="brazilsouth" ;; + 17) region="canadacentral" ;; + 18) region="centralindia" ;; + 19) region="eastasia" ;; + 20) region="germanycentral" ;; + 21) region="germanynortheast" ;; + 22) region="koreacentral" ;; + 23) region="koreasouth" ;; + 24) region="northcentralus" ;; + 25) region="southindia" ;; + 26) region="westindia" ;; esac read -p " diff --git a/docs/WINDOWS.md b/docs/WINDOWS.md index 3a53f7e2..fcd5d977 100644 --- a/docs/WINDOWS.md +++ b/docs/WINDOWS.md @@ -27,6 +27,6 @@ Install additional packages: Clone the Algo repository: -`https://github.com/trailofbits/algo && cd algo` +`git clone https://github.com/trailofbits/algo && cd algo` Now, you can go through the [README](https://github.com/trailofbits/algo#deploy-the-algo-server) (start from the 4th step) and deploy your Algo server!