Skip to content

Commit 7376fc0

Browse files
committed
Update docs
1 parent e05cdb4 commit 7376fc0

22 files changed

+309
-313
lines changed

Diff for: LICENSE.md

+1-1
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.

Diff for: README-zh.md

+53-53
Large diffs are not rendered by default.

Diff for: README.md

+53-53
Large diffs are not rendered by default.

Diff for: aws/README-zh.md

+11-11
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)

Diff for: aws/README.md

+11-11
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.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Diff for: azure/README-zh.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
*其他语言版本: [English](README.md), [简体中文](README-zh.md).*
44

5-
使用这个模板,你可以在 Microsoft Azure Cloud 上快速搭建一个 VPN 服务器 (<a href="https://azure.microsoft.com/zh-cn/pricing/details/virtual-machines/" target="_blank">定价细节</a>)。
5+
使用这个模板,你可以在 Microsoft Azure Cloud 上快速搭建一个 VPN 服务器 ([定价细节](https://azure.microsoft.com/zh-cn/pricing/details/virtual-machines/))。
66

77
可根据偏好设置以下选项:
88

@@ -16,16 +16,14 @@
1616

1717
请单击以下按钮开始:
1818

19-
<a href="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fhwdsl2%2Fsetup-ipsec-vpn%2Fmaster%2Fazure%2Fazuredeploy.json" target="_blank">
20-
<img src="../docs/images/azure-deploy-button.png" alt="Deploy to Azure" />
21-
</a><br><br>
19+
[![Deploy to Azure](../docs/images/azure-deploy-button.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fhwdsl2%2Fsetup-ipsec-vpn%2Fmaster%2Fazure%2Fazuredeploy.json)
2220

2321
在完成部署之后,Azure 会有提示。下一步:[配置 VPN 客户端](../README-zh.md#下一步)
2422

2523
## 作者
2624

2725
版权所有 (C) 2016 [Daniel Falkner](https://github.com/derdanu)
28-
版权所有 (C) 2017-2021 [Lin Song](https://www.linkedin.com/in/linsongui)
26+
版权所有 (C) 2017-2021 [Lin Song](https://github.com/hwdsl2)
2927

3028
## 屏幕截图
3129

Diff for: azure/README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
*Read this in other languages: [English](README.md), [简体中文](README-zh.md).*
44

5-
This template will create a fully working VPN server on the Microsoft Azure Cloud (<a href="https://azure.microsoft.com/en-us/pricing/details/virtual-machines/" target="_blank">pricing details</a>).
5+
This template will create a fully working VPN server on the Microsoft Azure Cloud ([pricing details](https://azure.microsoft.com/en-us/pricing/details/virtual-machines/)).
66

77
Customizable with the following options:
88

@@ -16,16 +16,14 @@ Customizable with the following options:
1616

1717
Press this button to start:
1818

19-
<a href="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fhwdsl2%2Fsetup-ipsec-vpn%2Fmaster%2Fazure%2Fazuredeploy.json" target="_blank">
20-
<img src="../docs/images/azure-deploy-button.png" alt="Deploy to Azure" />
21-
</a><br><br>
19+
[![Deploy to Azure](../docs/images/azure-deploy-button.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fhwdsl2%2Fsetup-ipsec-vpn%2Fmaster%2Fazure%2Fazuredeploy.json)
2220

2321
When the deployment finishes, Azure displays a notification. Next steps: [Configure VPN Clients](../README.md#next-steps).
2422

2523
## Authors
2624

2725
Copyright (C) 2016 [Daniel Falkner](https://github.com/derdanu)
28-
Copyright (C) 2017-2021 [Lin Song](https://www.linkedin.com/in/linsongui)
26+
Copyright (C) 2017-2021 [Lin Song](https://github.com/hwdsl2)
2927

3028
## Screenshot
3129

Diff for: docs/clients-xauth-zh.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**注:** 你也可以使用 [IKEv2](ikev2-howto-zh.md)(推荐)或者 [IPsec/L2TP](clients-zh.md) 模式连接。
66

7-
在成功 <a href="../README-zh.md" target="_blank">搭建自己的 VPN 服务器</a> 之后,按照下面的步骤来配置你的设备。IPsec/XAuth ("Cisco IPsec") 在 Android, iOS 和 OS X 上均受支持,无需安装额外的软件。Windows 用户可以使用免费的 <a href="https://www.shrew.net/download/vpn" target="_blank">Shrew Soft 客户端</a>。如果无法连接,请首先检查是否输入了正确的 VPN 登录凭证。
7+
在成功 [搭建自己的 VPN 服务器](../README-zh.md) 之后,按照下面的步骤来配置你的设备。IPsec/XAuth ("Cisco IPsec") 在 Android, iOS 和 OS X 上均受支持,无需安装额外的软件。Windows 用户可以使用免费的 [Shrew Soft 客户端](https://www.shrew.net/download/vpn)。如果无法连接,请首先检查是否输入了正确的 VPN 登录凭证。
88

99
IPsec/XAuth 模式也称为 "Cisco IPsec"。该模式通常能够比 IPsec/L2TP **更高效**地传输数据(较低的额外开销)。
1010

@@ -20,7 +20,7 @@ IPsec/XAuth 模式也称为 "Cisco IPsec"。该模式通常能够比 IPsec/L2TP
2020

2121
**注:** 你也可以使用 [IKEv2](ikev2-howto-zh.md)(推荐)或者 [IPsec/L2TP](clients-zh.md) 模式连接。无需安装额外的软件。
2222

23-
1. 下载并安装免费的 <a href="https://www.shrew.net/download/vpn" target="_blank">Shrew Soft VPN 客户端</a>。在安装时请选择 **Standard Edition**
23+
1. 下载并安装免费的 [Shrew Soft VPN 客户端](https://www.shrew.net/download/vpn)。在安装时请选择 **Standard Edition**
2424
**注:** 该 VPN 客户端 **不支持** Windows 10。
2525
1. 单击开始菜单 -> 所有程序 -> ShrewSoft VPN Client -> VPN Access Manager
2626
1. 单击工具栏中的 **Add (+)** 按钮。
@@ -36,9 +36,9 @@ IPsec/XAuth 模式也称为 "Cisco IPsec"。该模式通常能够比 IPsec/L2TP
3636
1.**Password** 字段中输入`你的 VPN 密码`
3737
1. 单击 **Connect**
3838

39-
VPN 连接成功后,你会在 VPN Connect 状态窗口中看到 **tunnel enabled** 字样。单击 "Network" 选项卡,并确认 **Established - 1** 显示在 "Security Associations" 下面。最后你可以到 <a href="https://www.ipchicken.com" target="_blank">这里</a> 检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
39+
VPN 连接成功后,你会在 VPN Connect 状态窗口中看到 **tunnel enabled** 字样。单击 "Network" 选项卡,并确认 **Established - 1** 显示在 "Security Associations" 下面。最后你可以到 [这里](https://www.ipchicken.com) 检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
4040

41-
如果在连接过程中遇到错误,请参见 <a href="clients-zh.md#故障排除" target="_blank">故障排除</a>
41+
如果在连接过程中遇到错误,请参见 [故障排除](clients-zh.md#故障排除)
4242

4343
## OS X
4444

@@ -58,9 +58,9 @@ VPN 连接成功后,你会在 VPN Connect 状态窗口中看到 **tunnel enabl
5858
1. 选中 **在菜单栏中显示 VPN 状态** 复选框。
5959
1. 单击 **应用** 保存VPN连接信息。
6060

61-
要连接到 VPN:使用菜单栏中的图标,或者打开系统偏好设置的网络部分,选择 VPN 并单击 **连接**。最后你可以到 <a href="https://www.ipchicken.com" target="_blank">这里</a> 检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
61+
要连接到 VPN:使用菜单栏中的图标,或者打开系统偏好设置的网络部分,选择 VPN 并单击 **连接**。最后你可以到 [这里](https://www.ipchicken.com) 检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
6262

63-
如果在连接过程中遇到错误,请参见 <a href="clients-zh.md#故障排除" target="_blank">故障排除</a>
63+
如果在连接过程中遇到错误,请参见 [故障排除](clients-zh.md#故障排除)
6464

6565
## Android
6666

@@ -80,9 +80,9 @@ VPN 连接成功后,你会在 VPN Connect 状态窗口中看到 **tunnel enabl
8080
1. 选中 **保存帐户信息** 复选框。
8181
1. 单击 **连接**
8282

83-
VPN 连接成功后,会在通知栏显示图标。最后你可以到 <a href="https://www.ipchicken.com" target="_blank">这里</a> 检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
83+
VPN 连接成功后,会在通知栏显示图标。最后你可以到 [这里](https://www.ipchicken.com) 检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
8484

85-
如果在连接过程中遇到错误,请参见 <a href="clients-zh.md#故障排除" target="_blank">故障排除</a>
85+
如果在连接过程中遇到错误,请参见 [故障排除](clients-zh.md#故障排除)
8686

8787
## iOS
8888

@@ -98,9 +98,9 @@ VPN 连接成功后,会在通知栏显示图标。最后你可以到 <a href="
9898
1. 单击右上角的 **完成**
9999
1. 启用 **VPN** 连接。
100100

101-
VPN 连接成功后,会在通知栏显示图标。最后你可以到 <a href="https://www.ipchicken.com" target="_blank">这里</a> 检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
101+
VPN 连接成功后,会在通知栏显示图标。最后你可以到 [这里](https://www.ipchicken.com) 检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
102102

103-
如果在连接过程中遇到错误,请参见 <a href="clients-zh.md#故障排除" target="_blank">故障排除</a>
103+
如果在连接过程中遇到错误,请参见 [故障排除](clients-zh.md#故障排除)
104104

105105
## Linux
106106

@@ -123,23 +123,23 @@ Fedora 28 (和更新版本)和 CentOS 8/7 用户可以使用 `yum` 安装 `N
123123
1. 单击 **Add** 保存 VPN 连接信息。
124124
1. 启用 **VPN** 连接。
125125

126-
VPN 连接成功后,你可以到 <a href="https://www.ipchicken.com" target="_blank">这里</a> 检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
126+
VPN 连接成功后,你可以到 [这里](https://www.ipchicken.com) 检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
127127

128128
### 其它 Linux
129129

130130
其它 Linux 版本用户可以使用 [IPsec/L2TP](clients-zh.md#linux) 模式连接。
131131

132132
## 致谢
133133

134-
本文档是在 <a href="https://github.com/StreisandEffect/streisand" target="_blank">Streisand</a> 项目文档基础上翻译和修改。该项目由 Joshua Lund 和其他开发者维护。
134+
本文档是在 [Streisand](https://github.com/StreisandEffect/streisand) 项目文档基础上翻译和修改。该项目由 Joshua Lund 和其他开发者维护。
135135

136136
## 授权协议
137137

138138
注: 这个协议仅适用于本文档。
139139

140-
版权所有 (C) 2016-2021 <a href="https://www.linkedin.com/in/linsongui" target="_blank">Lin Song</a>
141-
基于 <a href="https://github.com/StreisandEffect/streisand/blob/6aa6b6b2735dd829ca8c417d72eb2768a89b6639/playbooks/roles/l2tp-ipsec/templates/instructions.md.j2" target="_blank">Joshua Lund 的工作</a> (版权所有 2014-2016)
140+
版权所有 (C) 2016-2021 [Lin Song](https://github.com/hwdsl2) [![View my profile on LinkedIn](https://static.licdn.com/scds/common/u/img/webpromo/btn_viewmy_160x25.png)](https://www.linkedin.com/in/linsongui)
141+
基于 [Joshua Lund 的工作](https://github.com/StreisandEffect/streisand/blob/6aa6b6b2735dd829ca8c417d72eb2768a89b6639/playbooks/roles/l2tp-ipsec/templates/instructions.md.j2) (版权所有 2014-2016)
142142

143-
本程序为自由软件,在自由软件联盟发布的<a href="https://www.gnu.org/licenses/gpl.html" target="_blank"> GNU 通用公共许可协议</a>的约束下,你可以对其进行再发布及修改。协议版本为第三版或(随你)更新的版本。
143+
本程序为自由软件,在自由软件联盟发布的[ GNU 通用公共许可协议](https://www.gnu.org/licenses/gpl.html)的约束下,你可以对其进行再发布及修改。协议版本为第三版或(随你)更新的版本。
144144

145145
我们希望发布的这款程序有用,但不保证,甚至不保证它有经济价值和适合特定用途。详情参见GNU通用公共许可协议。

0 commit comments

Comments
 (0)