From 580678aed52bbb3edc1d2c8e7812dfb280fd69c3 Mon Sep 17 00:00:00 2001 From: hwdsl2 Date: Wed, 26 Aug 2020 23:48:08 -0500 Subject: [PATCH] Update docs --- README-zh.md | 2 +- README.md | 2 +- aws/README.md | 48 +++++++++--------- .../cloudformation-launch-stack-button.png | Bin 4 files changed, 25 insertions(+), 27 deletions(-) rename {docs/images => aws}/cloudformation-launch-stack-button.png (100%) diff --git a/README-zh.md b/README-zh.md index 0c3fe22..c68941a 100644 --- a/README-zh.md +++ b/README-zh.md @@ -65,7 +65,7 @@ wget https://git.io/vpnsetup -O vpnsetup.sh && sudo sh vpnsetup.sh - CentOS 6 (x86_64) with Updates - Red Hat Enterprise Linux (RHEL) 8, 7 或者 6 -请参见 详细步骤 以及 EC2 定价细节。另外，你也可以参见[此页面](aws/README.md)来了解如何使用**AWS Cloudformation**来快速在EC2上部署一个VPN服务器。 +请参见 详细步骤 以及 EC2 定价细节。另外，你也可以使用 [CloudFormation](aws/README.md) 来快速地在 EC2 上部署。 **-或者-** diff --git a/README.md b/README.md index 35463fb..b6b03df 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ A newly created Amazon EC2 - CentOS 6 (x86_64) with Updates - Red Hat Enterprise Linux (RHEL) 8, 7 or 6 -Please see detailed instructions and EC2 pricing. As an alternative, you can also launch a VPN server on EC2 with **AWS Cloudformation**. See detailed instructions [here](aws/README.md). +Please see detailed instructions and EC2 pricing. As an alternative, you can also deploy on EC2 using [CloudFormation](aws/README.md). **-OR-** diff --git a/aws/README.md b/aws/README.md index 62ffeb5..a4c0294 100644 --- a/aws/README.md +++ b/aws/README.md @@ -1,54 +1,52 @@ -# Deploy to AWS (Beta) +# Deploy to Amazon EC2 using CloudFormation (Beta) -> **Note:** The AWS deployment template is still in **BETA** phase. You may encounter failures during the deployment. In that case, please let us know the issue. +> **Note:** This deployment template is still in **BETA**. You may encounter failures during deployment. In that case, please open a new issue. -This template will create a fully-working IPSec/L2TP VPN server on AWS (Amazon Web Service). Please make sure to check the [pricing details](https://aws.amazon.com/ec2/pricing/on-demand/) of Virtual Machine on EC2 before starting the launch sequence. +This template will create a fully-working IPsec VPN server on Amazon Elastic Compute Cloud (Amazon EC2). Please make sure to check the EC2 [pricing details](https://aws.amazon.com/ec2/pricing/on-demand/) before continuing. Using a `t2.micro` server instance for your deployment may qualify for the [AWS Free Tier](https://aws.amazon.com/free/). -You can also use `t2.micro` instance as your server for your deployment, which is free of charge within the first year since your AWS account is registered. For more information on AWS free usage tier, go to [this page](https://aws.amazon.com/free/). +## Available customization parameters: -## Available Customization Parameters: - -- AWS EC2 Instance Type -- OS for your VPN Server (Ubuntu16.04, Ubuntu18.04, Debian9-Stretch or Debian10-Buster) -> **Note:** To use Debian9 or Debian10 images on EC2, to need to subscribe them first at AWS marketplace. [**Debian9**](https://aws.amazon.com/marketplace/pp/B073HW9SP3) [**Debian10**](https://aws.amazon.com/marketplace/pp/B0859NK4HC) +- Amazon EC2 instance type +- OS for your VPN server (Ubuntu 20.04/18.04/16.04, Debian 10/9) +> **Note:** Before using the Debian images on EC2, you need to first subscribe at the AWS Marketplace: [Debian 10](https://aws.amazon.com/marketplace/pp/B0859NK4HC), [Debian 9](https://aws.amazon.com/marketplace/pp/B073HW9SP3). - Your VPN username - Your VPN password -- IPSec PSK (pre-shared key) +- Your IPsec PSK (pre-shared key) -> When choosing your username and password, do not enter special characters like `" ' \`. +> **Note:** When choosing your VPN username, password and PSK, DO NOT use these special characters: `\ " '`. -Make sure to do this with an **AWS ROOT ACCOUNT** or an **IAM ACCOUNT** with **ANDMINISTRATOR ACCESS**. +Make sure to do this with an **AWS ROOT ACCOUNT** or an **IAM ACCOUNT** with **ADMINISTRATOR ACCESS**. -Right-click the [**template link**](https://raw.githubusercontent.com/hwdsl2/setup-ipsec-vpn/master/aws/cloudformation-template-ipsec) and save it as a file on your computer. Then upload it as the template source in the stack creation wizard. +Right-click this [**template link**](https://raw.githubusercontent.com/hwdsl2/setup-ipsec-vpn/master/aws/cloudformation-template-ipsec) and save as a file on your computer. Then upload it as the template source in the stack creation wizard. -![Upload the file](upload-the-template.png) +![Upload the template](upload-the-template.png) At step 4, make sure to confirm that this template may create IAM resources. ![Confirm IAM](confirm-iam.png) -Click the icon below to initiate the launching sequence. +Click the icon below to start: -Deploy to AWS +Deploy using CloudFormation -Make sure the deployment is successful before going to [Next Step: Configure VPN Clients](https://git.io/vpnclients). +Make sure the deployment is successful before continuing to [Next steps: Configure VPN Clients](../README.md#next-steps). -> **Note:** You need to wait for around 5 minutes after the stack is shown as **"CREATE_COMPLETE"**, before you can connect to the server with a VPN client. That's for the installation script to finish. +> **Note:** You will need to wait at least 5 minutes after the stack shows **CREATE_COMPLETE**, before you can connect to the server with a VPN client. This is to allow time for the VPN setup to complete. -# FAQs +## FAQs
-How to connect to the server via ssh after deployment? +How to connect to the server via SSH after deployment? -AWS does not allow users to access the instances with an SSH password. Instead, users are instructed to create "key pairs", which are used as credentials to access the instances via SSH. +Amazon EC2 does not allow users to access the instances with an SSH password. Instead, users are instructed to create "key pairs", which are used as credentials to access the instances via SSH. -The template here generates a key pair for you during the deployment, and that will be available as plain texts in the **"Output"** section after the stack is successfully created. +This template generates a key pair for you during deployment, which will be available as text in the **Outputs** section after the stack is successfully created. -You need to note down that key file if you want to later access the VPN server via SSH. +You will need to save the private key from the **Outputs** section to a file on your computer, if you want to later access the VPN server via SSH. -![](show-key.png) +![Show key](show-key.png)
@@ -58,4 +56,4 @@ Copyright (C) 2020 [S. X. Liang](https://github.com/scottpedia) ## Screenshots -Step 2 +![Specify parameters](specify-parameters.png) diff --git a/docs/images/cloudformation-launch-stack-button.png b/aws/cloudformation-launch-stack-button.png similarity index 100% rename from docs/images/cloudformation-launch-stack-button.png rename to aws/cloudformation-launch-stack-button.png