From 6d3b7239de48166dfed4d3f3bc1a4d2a9dda92d3 Mon Sep 17 00:00:00 2001 From: hwdsl2 Date: Mon, 26 Sep 2016 01:08:02 -0500 Subject: [PATCH] Update docs [ci skip] --- README-zh.md | 10 ++++++---- README.md | 20 +++++++++++--------- docs/manage-users-zh.md | 2 ++ docs/manage-users.md | 2 ++ 4 files changed, 21 insertions(+), 13 deletions(-) diff --git a/README-zh.md b/README-zh.md index 47f339c..2fc9547 100644 --- a/README-zh.md +++ b/README-zh.md @@ -1,7 +1,7 @@ # IPsec VPN 服务器一键安装脚本 [![Build Status](https://static.ls20.com/travis-ci/setup-ipsec-vpn.svg)](https://travis-ci.org/hwdsl2/setup-ipsec-vpn) -[![Author](https://img.shields.io/badge/author-Lin%20Song-blue.svg?maxAge=2592000)](#作者) +[![Author](https://static.ls20.com/travis-ci/author.svg)](#作者) [![GitHub stars](https://img.shields.io/github/stars/hwdsl2/setup-ipsec-vpn.svg?maxAge=3600)](https://github.com/hwdsl2/setup-ipsec-vpn/stargazers) [![Docker Pulls](https://img.shields.io/docker/pulls/hwdsl2/ipsec-vpn-server.svg?maxAge=3600)](https://github.com/hwdsl2/docker-ipsec-vpn-server) @@ -34,7 +34,7 @@ IPsec VPN 可以加密你的网络流量，以防止在通过因特网传送时 ## 功能特性 - **新:** 增加支持更高效的 `IPsec/XAuth ("Cisco IPsec")` 模式 -- **新:** 现在可以下载 VPN 服务器的预构建 [Docker 镜像](#另见) +- **新:** 现在可以下载 VPN 服务器的预构建 Docker 镜像 - 全自动的 IPsec VPN 服务器配置，无需用户输入 - 封装所有的 VPN 流量在 UDP 协议，不需要 ESP 协议支持 - 可直接作为 Amazon EC2 实例创建时的用户数据使用 @@ -54,7 +54,7 @@ IPsec VPN 可以加密你的网络流量，以防止在通过因特网传送时 **-或者-** -一个专用服务器或者虚拟专用服务器 (VPS)，全新安装以上操作系统之一。另外也可使用 Debian 7 (Wheezy)，但是必须首先运行另一个脚本。 OpenVZ VPS 不受支持，用户可以尝试使用 Shadowsocks/ShadowsocksR 或者 OpenVPN。 +一个专用服务器或者虚拟专用服务器 (VPS)，全新安装以上操作系统之一。另外也可使用 Debian 7 (Wheezy)，但是必须首先运行另一个脚本。 OpenVZ VPS 不受支持，用户可以尝试使用 Shadowsocks / ShadowsocksR 或者 OpenVPN。 这也包括各种云计算服务中的 Linux 虚拟机，比如 Google Compute Engine, Amazon EC2, Microsoft Azure, IBM SoftLayer, VMware vCloud Air, Rackspace, DigitalOcean, Vultr 和 Linode。 @@ -125,6 +125,8 @@ DigitalOcean 用户可以参考这个管理 VPN 用户。 +同一个 VPN 账户可以在你的多个设备上使用。但是由于 IPsec 协议的局限性，如果上述设备属于同一个 NAT 网络（比如家用路由器），它们无法同时连接到 VPN 服务器。 + 在 VPN 已连接时，客户端配置为使用 Google Public DNS。如果偏好其它的域名解析服务，请编辑 `/etc/ppp/options.xl2tpd` 和 `/etc/ipsec.conf` 并替换 `8.8.8.8` 和 `8.8.4.4`。然后重启服务器。 对于有外部防火墙的服务器（比如 EC2/GCE），请打开 UDP 端口 500 和 4500，以及 TCP 端口 22 （用于 SSH）。 @@ -162,7 +164,7 @@ wget https://git.io/vpnupgrade-centos -O vpnupgrade.sh - IKEv2 VPN Server on Docker - Streisand - SoftEther VPN -- Shadowsocks/ShadowsocksR +- Shadowsocks / ShadowsocksR - OpenVPN Install - Setup strongSwan diff --git a/README.md b/README.md index 744630f..ddd036d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # IPsec VPN Server Auto Setup Scripts [![Build Status](https://static.ls20.com/travis-ci/setup-ipsec-vpn.svg)](https://travis-ci.org/hwdsl2/setup-ipsec-vpn) -[![Author](https://img.shields.io/badge/author-Lin%20Song-blue.svg?maxAge=2592000)](#author) +[![Author](https://static.ls20.com/travis-ci/author.svg)](#author) [![GitHub stars](https://img.shields.io/github/stars/hwdsl2/setup-ipsec-vpn.svg?maxAge=3600)](https://github.com/hwdsl2/setup-ipsec-vpn/stargazers) [![Docker Pulls](https://img.shields.io/docker/pulls/hwdsl2/ipsec-vpn-server.svg?maxAge=3600)](https://github.com/hwdsl2/docker-ipsec-vpn-server) @@ -22,19 +22,19 @@ We will use Libreswan as th - [Installation](#installation) - [Ubuntu & Debian](#ubuntu--debian) - [CentOS & RHEL](#centos--rhel) -- [Next Steps](#next-steps) -- [Important Notes](#important-notes) +- [Next steps](#next-steps) +- [Important notes](#important-notes) - [Upgrade Libreswan](#upgrade-libreswan) - [Bugs & Questions](#bugs--questions) - [Uninstallation](#uninstallation) -- [See Also](#see-also) +- [See also](#see-also) - [Author](#author) - [License](#license) ## Features - **New:** The faster `IPsec/XAuth ("Cisco IPsec")` mode is supported -- **New:** A pre-built [Docker image](#see-also) of the VPN server is now available +- **New:** A pre-built Docker image of the VPN server is now available - Fully automated IPsec VPN server setup, no user input needed - Encapsulates all VPN traffic in UDP - does not need ESP protocol - Can be directly used as "user-data" for a new Amazon EC2 instance @@ -108,7 +108,7 @@ First, update your system with `yum update` and reboot. This is optional, but re Follow the same steps as above, but replace `https://git.io/vpnsetup` with `https://git.io/vpnsetup-centos`. -## Next Steps +## Next steps Get your computer or device to use the VPN. Please refer to: @@ -119,12 +119,14 @@ Get your computer or device to use the VPN. Please refer to: Enjoy your very own VPN! :sparkles::tada::rocket::sparkles: -## Important Notes +## Important notes **Windows and Android 6.0/7.0 users**: If you get an error when trying to connect, see Troubleshooting. If you wish to add, edit or remove VPN user accounts, refer to Manage VPN Users. +The same VPN account can be used by your multiple devices. However, due to a limitation of the IPsec protocol, if these devices are behind the same NAT (e.g. home router), they cannot simultaneously connect to the VPN server. + Clients are set to use Google Public DNS when the VPN is active. If another DNS provider is preferred, replace `8.8.8.8` and `8.8.4.4` in both `/etc/ppp/options.xl2tpd` and `/etc/ipsec.conf`. Then reboot your server. For servers with an external firewall (e.g. EC2/GCE), open UDP ports 500 & 4500, and TCP port 22 (for SSH). @@ -156,13 +158,13 @@ wget https://git.io/vpnupgrade-centos -O vpnupgrade.sh Please refer to Uninstall the VPN. -## See Also +## See also - IPsec VPN Server on Docker - IKEv2 VPN Server on Docker - Streisand - SoftEther VPN -- Shadowsocks/ShadowsocksR +- Shadowsocks / ShadowsocksR - OpenVPN Install - Setup strongSwan diff --git a/docs/manage-users-zh.md b/docs/manage-users-zh.md index 57aa64f..2ebcdd4 100644 --- a/docs/manage-users-zh.md +++ b/docs/manage-users-zh.md @@ -4,6 +4,8 @@ 在默认情况下，将只创建一个用于 VPN 登录的用户账户。如果你需要添加，修改或者删除用户，请阅读本文档。 +**注：** 同一个 VPN 账户可以在你的多个设备上使用。但是由于 IPsec 协议的局限性，如果上述设备属于同一个 NAT 网络（比如家用路由器），它们无法同时连接到 VPN 服务器。即使你创建多个用户也是如此。 + 首先，IPsec PSK (预共享密钥) 保存在文件 `/etc/ipsec.secrets`。如果要更换一个新的 PSK，可以编辑此文件。 ```bash diff --git a/docs/manage-users.md b/docs/manage-users.md index 3a2e2e6..67d1593 100644 --- a/docs/manage-users.md +++ b/docs/manage-users.md @@ -4,6 +4,8 @@ By default, a single user account for VPN login is created. If you wish to add, edit or remove users, read this document. +**Note:** The same VPN account can be used by your multiple devices. However, due to a limitation of the IPsec protocol, if these devices are behind the same NAT (e.g. home router), they cannot simultaneously connect to the VPN server. This applies even if you create multiple users. + First, the IPsec PSK (pre-shared key) is stored in `/etc/ipsec.secrets`. To change to a new PSK, just edit this file. ```bash