Update docs
This commit is contained in:
hwdsl2
parent
557f13f661
commit
b062dbac1a
@ -92,6 +92,8 @@ https://gitlab.com/hwdsl2/setup-ipsec-vpn/-/raw/master/vpnsetup.sh
|
||||
|
||||
这也包括公共云服务中的 Linux 虚拟机，例如 [DigitalOcean](https://blog.ls20.com/digitalocean), [Vultr](https://blog.ls20.com/vultr), [Linode](https://blog.ls20.com/linode), [OVH](https://www.ovhcloud.com/en/vps/) 和 [Microsoft Azure](https://azure.microsoft.com)。公共云用户也可以使用[用户数据](https://blog.ls20.com/ipsec-l2tp-vpn-auto-setup-for-ubuntu-12-04-on-amazon-ec2/#vpnsetup)部署。
|
||||
|
||||
使用以下按钮快速部署：
|
||||
|
||||
[](http://dovpn.carlfriess.com) [](https://cloud.linode.com/stackscripts/37239) [](aws/README-zh.md) [](azure/README-zh.md)
|
||||
|
||||
[**» 我想建立并使用自己的 VPN，但是没有可用的服务器**](https://blog.ls20.com/ipsec-l2tp-vpn-auto-setup-for-ubuntu-12-04-on-amazon-ec2/#gettingavps)
|
||||
|
||||
@ -92,6 +92,8 @@ Other supported Linux distributions.
|
||||
|
||||
This also includes Linux VMs in public clouds, such as [DigitalOcean](https://blog.ls20.com/digitalocean), [Vultr](https://blog.ls20.com/vultr), [Linode](https://blog.ls20.com/linode), [OVH](https://www.ovhcloud.com/en/vps/) and [Microsoft Azure](https://azure.microsoft.com). Public cloud users can also deploy using [user data](https://blog.ls20.com/ipsec-l2tp-vpn-auto-setup-for-ubuntu-12-04-on-amazon-ec2/#vpnsetup).
|
||||
|
||||
Quick deploy to:
|
||||
|
||||
[](http://dovpn.carlfriess.com) [](https://cloud.linode.com/stackscripts/37239) [](aws/README.md) [](azure/README.md)
|
||||
|
||||
[**» I want to run my own VPN but don't have a server for that**](https://blog.ls20.com/ipsec-l2tp-vpn-auto-setup-for-ubuntu-12-04-on-amazon-ec2/#gettingavps)
|
||||
|
||||
@ -17,29 +17,30 @@
|
||||
- 你的 VPN 密码
|
||||
- 你的 VPN IPsec PSK（预共享密钥）
|
||||
|
||||
> **注：** \*不要\* 在值中使用这些字符： `\ " '`
|
||||
> **注：** 一个安全的 IPsec PSK 应该至少包含 20 个随机字符。\*不要\* 在值中使用这些字符： `\ " '`
|
||||
|
||||
确保使用 **AWS 账户根用户** 或者有 **管理员权限** 的 **IAM 用户** 部署此模板。
|
||||
|
||||
右键单击这个 [**模板链接**](https://raw.githubusercontent.com/hwdsl2/setup-ipsec-vpn/master/aws/cloudformation-template-ipsec.json)，并将它保存到你的计算机上的一个新文件。然后在 ["创建堆栈" 向导](https://console.aws.amazon.com/cloudformation/home#/stacks/new)中将其作为模板源上传。继续创建堆栈，在最后一步你需要确认（选择）此模板可以创建 IAM 资源。
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
点这里查看屏幕截图
|
||||
</summary>
|
||||
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
要指定一个 AWS 区域，你可以使用导航栏上你的帐户信息右侧的选择器。当你在最后一步中点击 "create stack" 之后，请等待堆栈创建和 VPN 安装完成，可能需要最多 15 分钟。一旦堆栈的部署状态变成 **"CREATE_COMPLETE"** ，你就可以连接到 VPN 服务器了。单击 **Outputs** 选项卡以查看你的 VPN 登录信息，然后继续下一步：[配置 VPN 客户端](../README-zh.md#下一步)。
|
||||
|
||||
点击下面的图标开始：
|
||||
|
||||
[](https://console.aws.amazon.com/cloudformation/home#/stacks/new)
|
||||
|
||||
要指定一个 AWS 区域，你可以使用导航栏上你的帐户信息右侧的选择器。当你在最后一步中点击 "create stack" 之后，请等待堆栈创建和 VPN 安装完成，可能需要最多 15 分钟。一旦堆栈的部署状态变成 **"CREATE_COMPLETE"** ，你就可以连接到 VPN 服务器了。单击 **Outputs** 选项卡以查看你的 VPN 登录信息，然后继续下一步：[配置 VPN 客户端](../README-zh.md#下一步)。
|
||||
## 屏幕截图
|
||||
|
||||
> **注：** 如果你删除使用此模板部署的 CloudFormation 堆栈，在部署期间添加的密钥对将不会自动被清理。要管理你的密钥对，请转到 EC2 控制台 -> 密钥对。
|
||||
<details>
|
||||
<summary>
|
||||
点这里查看屏幕截图。
|
||||
</summary>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
## 常见问题
|
||||
|
||||
@ -48,7 +49,7 @@
|
||||
如何在部署结束后提取 IKEv2 连接配置文件？
|
||||
</summary>
|
||||
|
||||
部署结束以后，生成的 IKEv2 配置文件已经被上传到了一个预先创建好的 AWS Simple Storage Service(S3) 储存桶。下载配置文件的链接可以在 **Outputs** 页面下找到。
|
||||
部署结束以后，生成的 IKEv2 配置文件已经被上传到了一个新创建的 AWS Simple Storage Service(S3) 储存桶。下载配置文件的链接可以在 **Outputs** 页面下找到。
|
||||
|
||||
点击下载链接下载名为 `profiles.zip` 的压缩包文件。解压密码为**你之前配置好的 VPN 连接密码。**
|
||||
|
||||
@ -98,6 +99,17 @@ $ ssh -i path/to/your/key-file.pem instance-username@instance-ip-address
|
||||
```
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
如何删除 CloudFormation 堆栈？
|
||||
</summary>
|
||||
|
||||
你可以使用 CloudFormation 堆栈页面上的 "Delete" 按钮删除你创建的 CloudFormation 堆栈和它相关的资源。请注意，删除堆栈时以下资源不会被自动删除，你可以手动删除：
|
||||
|
||||
1. 在部署期间添加的 EC2 密钥对。要管理你的密钥对，请转到 EC2 控制台 -> 密钥对。
|
||||
1. 存放生成的 IKEv2 配置文件的 S3 储存桶。参见上面的 "如何在部署结束后提取 IKEv2 连接配置文件"。
|
||||
</details>
|
||||
|
||||
## 作者
|
||||
|
||||
版权所有 (C) 2020-2023 [Scott X. L.](https://github.com/scottpedia) <[wtanglef@pm.me](mailto:wtanglef@pm.me)>
|
||||
|
||||
@ -17,29 +17,30 @@ Available customization parameters:
|
||||
- Your VPN password
|
||||
- Your VPN IPsec PSK (pre-shared key)
|
||||
|
||||
> **Note:** DO NOT use these special characters within values: `\ " '`
|
||||
> **Note:** A secure IPsec PSK should consist of at least 20 random characters. DO NOT use these special characters within values: `\ " '`
|
||||
|
||||
Make sure to deploy this template with an **AWS Account Root User** or an **IAM Account** with **Administrator Access**.
|
||||
|
||||
Right-click this [**template link**](https://raw.githubusercontent.com/hwdsl2/setup-ipsec-vpn/master/aws/cloudformation-template-ipsec.json) and save as a file on your computer. Then upload it as the template source in the [stack creation wizard](https://console.aws.amazon.com/cloudformation/home#/stacks/new). Continue creating the stack, and in the final step make sure to confirm that this template may create IAM resources.
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Click here to view screenshots
|
||||
</summary>
|
||||
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
You may choose an AWS region using the selector to the right of your account information on the navigation bar. After you click "create stack" in the final step, please wait for the stack creation and VPN setup to complete, which may take up to 15 minutes. As soon as the stack's status changes to **"CREATE_COMPLETE"**, you are ready to connect to the VPN server. Click the **Outputs** tab to view your VPN login details. Then continue to [Next steps: Configure VPN Clients](../README.md#next-steps).
|
||||
|
||||
Click the icon below to start:
|
||||
|
||||
[](https://console.aws.amazon.com/cloudformation/home#/stacks/new)
|
||||
|
||||
You may choose an AWS region using the selector to the right of your account information on the navigation bar. After you click "create stack" in the final step, please wait for the stack creation and VPN setup to complete, which may take up to 15 minutes. As soon as the stack's status changes to **"CREATE_COMPLETE"**, you are ready to connect to the VPN server. Click the **Outputs** tab to view your VPN login details. Then continue to [Next steps: Configure VPN Clients](../README.md#next-steps).
|
||||
## Screenshots
|
||||
|
||||
> **Note:** If you delete a CloudFormation stack deployed using this template, the key pair that was added during deployment won't be automatically cleaned up. To manage your key pairs, go to EC2 console -> Key Pairs.
|
||||
<details>
|
||||
<summary>
|
||||
Click here to view screenshots.
|
||||
</summary>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
## FAQs
|
||||
|
||||
@ -48,7 +49,7 @@ You may choose an AWS region using the selector to the right of your account inf
|
||||
How to retrieve the IKEv2 credentials following the deployment?
|
||||
</summary>
|
||||
|
||||
After the deployment completes, connection credentials generated for IKEv2 mode are uploaded to a specific AWS Simple Storage Service(S3) Bucket. The download link is then provided under the **Outputs** tab.
|
||||
After the deployment completes, connection credentials generated for IKEv2 mode are uploaded to a newly created AWS Simple Storage Service (S3) Bucket. The download link is then provided under the **Outputs** tab.
|
||||
|
||||
Simply click on the link to download a compressed package named `profiles.zip`. To extract the content from the file, you will be prompted to enter a password. And that password is the **same one used to connect to your VPN server.**
|
||||
|
||||
@ -98,6 +99,17 @@ $ ssh -i path/to/your/key-file.pem instance-username@instance-ip-address
|
||||
```
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
How to delete the CloudFormation stack?
|
||||
</summary>
|
||||
|
||||
You may use the "Delete" button on the CloudFormation stack page to delete the CloudFormation stack you created and its associated resources. Note that when deleting the stack, the following resources will not be automatically deleted, you may manually delete them:
|
||||
|
||||
1. The EC2 key pair that was added during deployment. To manage your key pairs, go to EC2 console -> Key Pairs.
|
||||
1. The S3 bucket that stores the generated IKEv2 credentials. Refer to "How to retrieve the IKEv2 credentials following the deployment" above.
|
||||
</details>
|
||||
|
||||
## Author
|
||||
|
||||
Copyright (C) 2020-2023 [Scott X. L.](https://github.com/scottpedia) <[wtanglef@pm.me](mailto:wtanglef@pm.me)>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user