Skip to content

Commit 7376fc0

Browse files
committed
Update docs
1 parent e05cdb4 commit 7376fc0

22 files changed

Lines changed: 309 additions & 313 deletions

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### Creative Commons Attribution-ShareAlike 3.0 Unported License
22
Link to license summary: https://creativecommons.org/licenses/by-sa/3.0/
33

4-
Copyright (C) 2014-2021 [Lin Song](https://www.linkedin.com/in/linsongui)
4+
Copyright (C) 2014-2021 [Lin Song](https://github.com/hwdsl2)
55
Based on [the work of Thomas Sarlandie](https://github.com/sarfata/voodooprivacy) (Copyright 2012)
66

77
See the [aws/](aws/) and [azure/](azure/) subfolders for their respective authors.

README-zh.md

Lines changed: 53 additions & 53 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 53 additions & 53 deletions
Large diffs are not rendered by default.

aws/README-zh.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,21 @@
1818
1919
确保使用 **AWS 账户根用户** 或者有 **管理员权限****IAM 用户** 部署此模板。
2020

21-
右键单击这个 [**模板链接**](https://raw.githubusercontent.com/hwdsl2/setup-ipsec-vpn/master/aws/cloudformation-template-ipsec.json),并将它保存到你的计算机上的一个新文件。然后在 ["创建堆栈" 向导](https://console.aws.amazon.com/cloudformation/home#/stacks/new)中将其作为模板源上传。
21+
右键单击这个 [**模板链接**](https://raw.githubusercontent.com/hwdsl2/setup-ipsec-vpn/master/aws/cloudformation-template-ipsec.json),并将它保存到你的计算机上的一个新文件。然后在 ["创建堆栈" 向导](https://console.aws.amazon.com/cloudformation/home#/stacks/new)中将其作为模板源上传。继续创建堆栈,在最后一步你需要确认(选择)此模板可以创建 IAM 资源。
2222

23-
![上传模板](upload-the-template.png)
24-
25-
在步骤 4,你需要确认(选择)此模板可以创建 IAM 资源。
23+
<details>
24+
<summary>
25+
点这里查看屏幕截图
26+
</summary>
2627

27-
![确认 IAM](confirm-iam.png)
28+
![上传模板](images/upload-the-template.png)
29+
![指定参数](images/specify-parameters.png)
30+
![确认 IAM](images/confirm-iam.png)
31+
</details>
2832

2933
点击下面的图标开始:
3034

31-
<a href="https://console.aws.amazon.com/cloudformation/home#/stacks/new" target="_blank"><img src="cloudformation-launch-stack-button.png" alt="Launch stack" height="34px"></a>
35+
[![Launch stack](images/cloudformation-launch-stack-button.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/new)
3236

3337
要指定一个 AWS 区域,你可以使用导航栏上你的帐户信息右侧的选择器。当你在最后一步中点击 "create stack" 之后,请等待堆栈创建和 VPN 安装完成,可能需要最多 15 分钟。一旦堆栈的部署状态变成 **"CREATE_COMPLETE"** ,你就可以连接到 VPN 服务器了。单击 **Outputs** 选项卡以查看你的 VPN 登录信息,然后继续下一步:[配置 VPN 客户端](../README-zh.md#下一步)
3438

@@ -61,7 +65,7 @@ EC2 上的每个 Linux 服务器发行版本都有它自己的默认登录用户
6165

6266
> **注:** 在保存到你的计算机之前,你可能需要修改私钥的格式,比如用换行符替换所有的空格。在保存后,需要为该私钥文件设置[适当的权限](https://docs.aws.amazon.com/zh_cn/AWSEC2/latest/UserGuide/connection-prereqs.html#connection-prereqs-private-key)才能使用。
6367
64-
![显示密钥](show-key.png)
68+
![显示密钥](images/show-key.png)
6569

6670
要为私钥文件设置适当的权限,请在该文件所在的目录下运行以下命令:
6771
```bash
@@ -77,7 +81,3 @@ $ ssh -i path/to/your/key-file.pem instance-username@instance-ip-address
7781
## 作者
7882

7983
版权所有 (C) 2020-2021 [S. X. Liang](https://github.com/scottpedia)
80-
81-
## 屏幕截图
82-
83-
![指定参数](specify-parameters.png)

aws/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,21 @@ Available customization parameters:
1818
1919
Make sure to deploy this template with an **AWS Account Root User** or an **IAM Account** with **Administrator Access**.
2020

21-
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).
21+
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.
2222

23-
![Upload the template](upload-the-template.png)
24-
25-
At step 4, make sure to confirm that this template may create IAM resources.
23+
<details>
24+
<summary>
25+
Click here to view screenshots
26+
</summary>
2627

27-
![Confirm IAM](confirm-iam.png)
28+
![Upload the template](images/upload-the-template.png)
29+
![Specify parameters](images/specify-parameters.png)
30+
![Confirm IAM](images/confirm-iam.png)
31+
</details>
2832

2933
Click the icon below to start:
3034

31-
<a href="https://console.aws.amazon.com/cloudformation/home#/stacks/new" target="_blank"><img src="cloudformation-launch-stack-button.png" alt="Launch stack" height="34px"></a>
35+
[![Launch stack](images/cloudformation-launch-stack-button.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/new)
3236

3337
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).
3438

@@ -61,7 +65,7 @@ You will need to save the private key from the **Outputs** tab to a file on your
6165

6266
> **Note:** You may need to format the private key by replacing all spaces with newlines, before saving to a file. The file will need to be set with [proper permissions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/connection-prereqs.html#connection-prereqs-private-key) before using.
6367
64-
![Show key](show-key.png)
68+
![Show key](images/show-key.png)
6569

6670
To apply proper permissions to your private key file, run the following command under the directory where the file is located:
6771
```bash
@@ -77,7 +81,3 @@ $ ssh -i path/to/your/key-file.pem instance-username@instance-ip-address
7781
## Author
7882

7983
Copyright (C) 2020-2021 [S. X. Liang](https://github.com/scottpedia)
80-
81-
## Screenshots
82-
83-
![Specify parameters](specify-parameters.png)
File renamed without changes.

0 commit comments

Comments
 (0)