Skip to content

Commit 56a9660

Browse files
committed
Update docs
[ci skip]
1 parent 7937a74 commit 56a9660

12 files changed

+133
-87
lines changed

README-zh.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,7 @@ DigitalOcean 用户可以参考这个<a href="https://usefulpcguide.com/17318/cr
121121

122122
## 重要提示
123123

124-
**Windows 用户** 如果在连接过程中遇到错误,请参见 <a href="docs/clients-zh.md#故障排除" target="_blank">故障排除</a>。
125-
126-
**Android 6 (Marshmallow) 用户** 请参考此文档中的注释: <a href="docs/clients-zh.md#android" target="_blank">配置 IPsec/L2TP VPN 客户端</a>。
124+
**Windows 和 Android 6.0/7.0 用户**: 如果在连接过程中遇到错误,请参见 <a href="docs/clients-zh.md#故障排除" target="_blank">故障排除</a>。
127125

128126
如果需要添加,修改或者删除 VPN 用户账户,请参见 <a href="docs/manage-users-zh.md" target="_blank">管理 VPN 用户</a>。
129127

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,7 @@ Enjoy your very own VPN! :sparkles::tada::rocket::sparkles:
121121

122122
## Important Notes
123123

124-
**Windows users**: If you get an error when trying to connect, see <a href="docs/clients.md#troubleshooting" target="_blank">Troubleshooting</a>.
125-
126-
**Android 6 (Marshmallow) users**: Please see notes in <a href="docs/clients.md#android" target="_blank">Configure IPsec/L2TP VPN Clients</a>.
124+
**Windows and Android 6.0/7.0 users**: If you get an error when trying to connect, see <a href="docs/clients.md#troubleshooting" target="_blank">Troubleshooting</a>.
127125

128126
If you wish to add, edit or remove VPN user accounts, refer to <a href="docs/manage-users.md" target="_blank">Manage VPN Users</a>.
129127

azure/README-zh.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66

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

9-
- Username for VPN and SSH (VPN 和 SSH 用户名)
10-
- Password for VPN and SSH (VPN 和 SSH 密码)
9+
- Username for VPN and SSH (用户名)
10+
- Password for VPN and SSH (密码)
1111
- IPsec Pre-Shared Key (IPsec 预共享密钥)
1212
- Operating System Image (操作系统镜像,Debian 8 或 Ubuntu 16.04 LTS)
1313
- Virtual Machine Size (虚拟机大小,默认值: Standard_A0)
1414

15-
请点击以下按钮开始
15+
请单击以下按钮开始
1616

1717
<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">
1818
<img src="../docs/images/azure-deploy-button.png" alt="Deploy to Azure" />
@@ -24,4 +24,4 @@
2424

2525
## 作者
2626

27-
- Daniel Falkner (https://github.com/derdanu)
27+
版权所有 (C) 2016 [Daniel Falkner](https://github.com/derdanu)

azure/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ Screenshot:
2424

2525
## Author
2626

27-
- Daniel Falkner (https://github.com/derdanu)
27+
Copyright (C) 2016 [Daniel Falkner](https://github.com/derdanu)

docs/clients-xauth-zh.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
## 配置 IPsec/XAuth VPN 客户端
1+
# 配置 IPsec/XAuth VPN 客户端
22

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

5-
*如需使用 IPsec/L2TP 模式连接,请参见: [配置 IPsec/L2TP VPN 客户端](clients-zh.md)*
5+
*注: 你也可以使用 [IPsec/L2TP 模式](clients-zh.md) 连接,或者配置 [IKEv2](ikev2-howto-zh.md)*
66

77
在成功<a href="https://github.com/hwdsl2/setup-ipsec-vpn" 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 登录凭证。
88

9-
`IPsec/XAuth` 模式也称为 "Cisco IPsec"。和 `IPsec/L2TP` 相比较,它通常能够更高效地传输数据
9+
IPsec/XAuth 模式也称为 "Cisco IPsec",它通常能够比 IPsec/L2TP 更高效地传输数据
1010

1111
---
1212
* 平台名称
@@ -15,7 +15,7 @@
1515
* [Android](#android)
1616
* [iOS (iPhone/iPad)](#ios)
1717

18-
### Windows ###
18+
## Windows
1919

2020
**注:** 你也可以使用 [IPsec/L2TP 模式](clients-zh.md) 连接,无需安装额外的软件。
2121

@@ -33,9 +33,12 @@
3333
1.**Password** 字段中输入`你的 VPN 密码`
3434
1. 单击 **Connect**
3535

36-
VPN 连接成功后,你会在 VPN Connect 状态窗口中看到 **tunnel enabled** 字样。单击 "Network" 选项卡,并确认 **Established - 1** 显示在 "Security Associations" 下面。最后你可以到<a href="https://www.whatismyip.com" target="_blank">这里</a>检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
36+
VPN 连接成功后,你会在 VPN Connect 状态窗口中看到 **tunnel enabled** 字样。单击 "Network" 选项卡,并确认 **Established - 1** 显示在 "Security Associations" 下面。最后你可以到 <a href="https://www.ipchicken.com" target="_blank">这里</a> 检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
37+
38+
如果在连接过程中遇到错误,请参见 <a href="clients-zh.md#故障排除" target="_blank">故障排除</a>。
39+
40+
## OS X
3741

38-
### OS X ###
3942
1. 打开系统偏好设置并转到网络部分。
4043
1. 在窗口左下角单击 **+** 按钮。
4144
1.**接口** 下拉菜单选择 **VPN**
@@ -52,9 +55,10 @@ VPN 连接成功后,你会在 VPN Connect 状态窗口中看到 **tunnel enabl
5255
1. 选中 **在菜单栏中显示 VPN 状态** 复选框。
5356
1. 单击 **应用** 保存VPN连接信息。
5457

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

57-
### Android ###
5862
1. 启动 **设置** 应用程序。
5963
1.**无线和网络** 部分单击 **更多...**
6064
1. 单击 **VPN**
@@ -71,14 +75,12 @@ VPN 连接成功后,你会在 VPN Connect 状态窗口中看到 **tunnel enabl
7175
1. 选中 **保存帐户信息** 复选框。
7276
1. 单击 **连接**
7377

74-
**注:** 如果无法使用 Android 6 (Marshmallow) 连接,请尝试以下解决方案:
78+
VPN 连接成功后,会在通知栏显示图标。最后你可以到 <a href="https://www.ipchicken.com" target="_blank">这里</a> 检测你的 IP 地址,应该显示为`你的 VPN 服务器 IP`
7579

76-
1. 单击 VPN 连接右边的设置按钮,选择 "显示高级选项" 并且滚动到底部。如果选项 "兼容模式" 存在,请启用它并重试连接。如果不存在,请跳到第二步。
77-
1. (注:最新版本的 VPN 脚本已经包含这些更改)编辑 VPN 服务器上的 `/etc/ipsec.conf`,并在 `ike=``phase2alg=` 两行结尾添加 `,aes256-sha2_256` 字样。然后在它们下面添加一行 `sha2-truncbug=yes`。每行开头必须空两格。保存修改并运行 `service ipsec restart`。(<a href="https://libreswan.org/wiki/FAQ#Android_6.0_connection_comes_up_but_no_packet_flow" target="_blank">参考链接</a>)
80+
如果在连接过程中遇到错误,请参见 <a href="clients-zh.md#故障排除" target="_blank">故障排除</a>。
7881

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

81-
### iOS ###
8284
1. 进入设置 -> 通用 -> VPN。
8385
1. 单击 **添加VPN配置...**
8486
1. 单击 **类型** 。选择 **IPSec** 并返回。
@@ -91,14 +93,16 @@ VPN 连接成功后,会在通知栏显示图标。最后你可以到<a href="h
9193
1. 单击右上角的 **存储**
9294
1. 启用 **VPN** 连接。
9395

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

9698
## 致谢
9799

98100
本文档是在 <a href="https://github.com/jlund/streisand" target="_blank">Streisand</a> 项目文档基础上翻译和修改。该项目由 Joshua Lund 和其他开发者维护。
99101

100102
## 授权协议
101103

104+
注: 这个协议仅适用于本文档。
105+
102106
版权所有 (C) 2016 Lin Song
103107
基于 <a href="https://github.com/jlund/streisand/blob/master/playbooks/roles/l2tp-ipsec/templates/instructions.md.j2" target="_blank">Joshua Lund 的工作</a> (版权所有 2014-2016)
104108

docs/clients-xauth.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
## Configure IPsec/XAuth VPN Clients
1+
# Configure IPsec/XAuth VPN Clients
22

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

5-
*To connect using IPsec/L2TP mode, see: [Configure IPsec/L2TP VPN Clients](clients.md)*
5+
*Note: You may also connect using [IPsec/L2TP mode](clients.md), or set up [IKEv2](ikev2-howto.md).*
66

77
After <a href="https://github.com/hwdsl2/setup-ipsec-vpn" target="_blank">setting up your own VPN server</a>, follow these steps to configure your devices. IPsec/XAuth ("Cisco IPsec") is natively supported by Android, iOS and OS X. There is no additional software to install. Windows users can use the free <a href="https://www.shrew.net/download/vpn" target="_blank">Shrew Soft client</a>. In case you are unable to connect, first check to make sure the VPN credentials were entered correctly.
88

9-
`IPsec/XAuth` mode is also called "Cisco IPsec". Compared to `IPsec/L2TP`, it is generally faster with less overhead.
9+
IPsec/XAuth mode is also called "Cisco IPsec". It is generally faster than IPsec/L2TP with less overhead.
1010

1111
---
1212
* Platforms
@@ -15,9 +15,9 @@ After <a href="https://github.com/hwdsl2/setup-ipsec-vpn" target="_blank">settin
1515
* [Android](#android)
1616
* [iOS (iPhone/iPad)](#ios)
1717

18-
### Windows ###
18+
## Windows
1919

20-
**Note:** You can also connect using [IPsec/L2TP mode](clients.md). No additional software is required.
20+
**Note:** You may also connect using [IPsec/L2TP mode](clients.md). No additional software is required.
2121

2222
1. Download and install the free <a href="https://www.shrew.net/download/vpn" target="_blank">Shrew Soft VPN client</a>.
2323
1. Click Start Menu -> All Programs -> ShrewSoft VPN Client -> VPN Access Manager
@@ -35,7 +35,10 @@ After <a href="https://github.com/hwdsl2/setup-ipsec-vpn" target="_blank">settin
3535

3636
Once connected, you will see **tunnel enabled** in the VPN Connect status window. Click the "Network" tab, and confirm that **Established - 1** is displayed under "Security Associations". You can verify that your traffic is being routed properly by <a href="https://encrypted.google.com/search?q=my+ip" target="_blank">looking up your IP address on Google</a>. It should say "Your public IP address is `Your VPN Server IP`".
3737

38-
### OS X ###
38+
If you get an error when trying to connect, see <a href="clients.md#troubleshooting" target="_blank">Troubleshooting</a>.
39+
40+
## OS X
41+
3942
1. Open System Preferences and go to the Network section.
4043
1. Click the **+** button in the lower-left corner of the window.
4144
1. Select **VPN** from the **Interface** drop-down menu.
@@ -54,7 +57,8 @@ Once connected, you will see **tunnel enabled** in the VPN Connect status window
5457

5558
To connect to the VPN: Use the menu bar icon, or go to the Network section of System Preferences, select the VPN and choose **Connect**. You can verify that your traffic is being routed properly by <a href="https://encrypted.google.com/search?q=my+ip" target="_blank">looking up your IP address on Google</a>. It should say "Your public IP address is `Your VPN Server IP`".
5659

57-
### Android ###
60+
## Android
61+
5862
1. Launch the **Settings** application.
5963
1. Tap **More...** in the **Wireless & Networks** section.
6064
1. Tap **VPN**.
@@ -71,14 +75,12 @@ To connect to the VPN: Use the menu bar icon, or go to the Network section of Sy
7175
1. Check the **Save account information** checkbox.
7276
1. Tap **Connect**.
7377

74-
**Note:** If unable to connect using Android 6 (Marshmallow), try these workarounds:
78+
Once connected, you will see a VPN icon in the notification bar. You can verify that your traffic is being routed properly by <a href="https://encrypted.google.com/search?q=my+ip" target="_blank">looking up your IP address on Google</a>. It should say "Your public IP address is `Your VPN Server IP`".
7579

76-
1. Tap the settings icon next to your VPN profile. Select "Show Advanced Options" and scroll down to the bottom. If the option "Backwards-compatible mode" exists, enable it and reconnect the VPN. If not, skip to step 2.
77-
1. (Note: Latest version of the VPN scripts already include these changes) Edit `/etc/ipsec.conf` on the VPN server and append `,aes256-sha2_256` to both `ike=` and `phase2alg=` lines. Then add a new line `sha2-truncbug=yes` immediately after those. Indent lines with two spaces. Save the file and run `service ipsec restart`. (<a href="https://libreswan.org/wiki/FAQ#Android_6.0_connection_comes_up_but_no_packet_flow" target="_blank">Reference</a>)
80+
If you get an error when trying to connect, see <a href="clients.md#troubleshooting" target="_blank">Troubleshooting</a>.
7881

79-
Once connected, you will see a VPN icon in the notification bar. You can verify that your traffic is being routed properly by <a href="https://encrypted.google.com/search?q=my+ip" target="_blank">looking up your IP address on Google</a>. It should say "Your public IP address is `Your VPN Server IP`".
82+
## iOS
8083

81-
### iOS ###
8284
1. Go to Settings -> General -> VPN.
8385
1. Tap **Add VPN Configuration...**.
8486
1. Tap **Type**. Select **IPSec** and go back.
@@ -99,6 +101,8 @@ This document was adapted from the <a href="https://github.com/jlund/streisand"
99101

100102
## License
101103

104+
Note: This license applies to this document only.
105+
102106
Copyright (C) 2016 Lin Song
103107
Based on <a href="https://github.com/jlund/streisand/blob/master/playbooks/roles/l2tp-ipsec/templates/instructions.md.j2" target="_blank">the work of Joshua Lund</a> (Copyright 2014-2016)
104108

0 commit comments

Comments
 (0)