From 97624bf29208871bb9336b54182582a9c3737140 Mon Sep 17 00:00:00 2001 From: hwdsl2 Date: Thu, 4 Feb 2021 21:43:03 -0600 Subject: [PATCH] Update docs --- README-zh.md | 44 +++++++++++++++---------------- README.md | 44 +++++++++++++++---------------- aws/cloudformation-template-ipsec | 4 +-- azure/install.sh | 2 +- docs/ikev2-howto-zh.md | 2 ++ docs/ikev2-howto.md | 2 ++ 6 files changed, 51 insertions(+), 47 deletions(-) diff --git a/README-zh.md b/README-zh.md index d3b25fa..68033f8 100644 --- a/README-zh.md +++ b/README-zh.md @@ -2,7 +2,7 @@ [![Build Status](https://img.shields.io/github/workflow/status/hwdsl2/setup-ipsec-vpn/vpn%20test.svg?cacheSeconds=3600)](https://github.com/hwdsl2/setup-ipsec-vpn/actions) [![GitHub Stars](https://img.shields.io/github/stars/hwdsl2/setup-ipsec-vpn.svg?cacheSeconds=86400)](https://github.com/hwdsl2/setup-ipsec-vpn/stargazers) [![Docker Stars](https://img.shields.io/docker/stars/hwdsl2/ipsec-vpn-server.svg?cacheSeconds=86400)](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README-zh.md) [![Docker Pulls](https://img.shields.io/docker/pulls/hwdsl2/ipsec-vpn-server.svg?cacheSeconds=86400)](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README-zh.md) -使用 Linux 脚本一键快速搭建自己的 IPsec VPN 服务器。支持 IPsec/L2TP 和 Cisco IPsec 协议，可用于 Ubuntu/Debian/CentOS 系统。你只需提供自己的 VPN 登录凭证，然后运行脚本自动完成安装。 +使用 Linux 脚本一键快速搭建自己的 IPsec VPN 服务器。支持 IPsec/L2TP, Cisco IPsec 和 IKEv2 协议，可用于 Ubuntu, Debian 和 CentOS 系统。你只需提供自己的 VPN 登录凭证，然后运行脚本自动完成安装。 IPsec VPN 可以加密你的网络流量，以防止在通过因特网传送时，你和 VPN 服务器之间的任何人对你的数据的未经授权的访问。在使用不安全的网络时，这是特别有用的，例如在咖啡厅，机场或旅馆房间。 @@ -38,7 +38,7 @@ Ubuntu & Debian ```bash -wget https://git.io/vpnsetup -O vpnsetup.sh && sudo sh vpnsetup.sh +wget https://git.io/vpnsetup -O vpn.sh && sudo sh vpn.sh ``` @@ -48,7 +48,7 @@ CentOS & RHEL ```bash -wget https://git.io/vpnsetup-centos -O vpnsetup.sh && sudo sh vpnsetup.sh +wget https://git.io/vpnsetup-centos -O vpn.sh && sudo sh vpn.sh ``` @@ -58,7 +58,7 @@ Amazon Linux 2 ```bash -wget https://git.io/vpnsetup-amzn -O vpnsetup.sh && sudo sh vpnsetup.sh +wget https://git.io/vpnsetup-amzn -O vpn.sh && sudo sh vpn.sh ``` @@ -127,7 +127,7 @@ Ubuntu & Debian ```bash -wget https://git.io/vpnsetup -O vpnsetup.sh && sudo sh vpnsetup.sh +wget https://git.io/vpnsetup -O vpn.sh && sudo sh vpn.sh ``` @@ -138,7 +138,7 @@ CentOS & RHEL ```bash yum -y install wget -wget https://git.io/vpnsetup-centos -O vpnsetup.sh && sudo sh vpnsetup.sh +wget https://git.io/vpnsetup-centos -O vpn.sh && sudo sh vpn.sh ``` @@ -148,7 +148,7 @@ Amazon Linux 2 ```bash -wget https://git.io/vpnsetup-amzn -O vpnsetup.sh && sudo sh vpnsetup.sh +wget https://git.io/vpnsetup-amzn -O vpn.sh && sudo sh vpn.sh ``` @@ -160,10 +160,10 @@ Ubuntu & Debian ```bash -wget https://git.io/vpnsetup -O vpnsetup.sh -nano -w vpnsetup.sh +wget https://git.io/vpnsetup -O vpn.sh +nano -w vpn.sh [替换为你自己的值： YOUR_IPSEC_PSK, YOUR_USERNAME 和 YOUR_PASSWORD] -sudo sh vpnsetup.sh +sudo sh vpn.sh ``` @@ -174,10 +174,10 @@ CentOS & RHEL ```bash yum -y install wget nano -wget https://git.io/vpnsetup-centos -O vpnsetup.sh -nano -w vpnsetup.sh +wget https://git.io/vpnsetup-centos -O vpn.sh +nano -w vpn.sh [替换为你自己的值： YOUR_IPSEC_PSK, YOUR_USERNAME 和 YOUR_PASSWORD] -sudo sh vpnsetup.sh +sudo sh vpn.sh ``` @@ -187,10 +187,10 @@ Amazon Linux 2 ```bash -wget https://git.io/vpnsetup-amzn -O vpnsetup.sh -nano -w vpnsetup.sh +wget https://git.io/vpnsetup-amzn -O vpn.sh +nano -w vpn.sh [替换为你自己的值： YOUR_IPSEC_PSK, YOUR_USERNAME 和 YOUR_PASSWORD] -sudo sh vpnsetup.sh +sudo sh vpn.sh ``` @@ -206,11 +206,11 @@ Ubuntu & Debian ```bash # 所有变量值必须用 '单引号' 括起来 # *不要* 在值中使用这些字符： \ " ' -wget https://git.io/vpnsetup -O vpnsetup.sh +wget https://git.io/vpnsetup -O vpn.sh sudo VPN_IPSEC_PSK='你的IPsec预共享密钥' \ VPN_USER='你的VPN用户名' \ VPN_PASSWORD='你的VPN密码' \ -sh vpnsetup.sh +sh vpn.sh ``` @@ -223,11 +223,11 @@ CentOS & RHEL # 所有变量值必须用 '单引号' 括起来 # *不要* 在值中使用这些字符： \ " ' yum -y install wget -wget https://git.io/vpnsetup-centos -O vpnsetup.sh +wget https://git.io/vpnsetup-centos -O vpn.sh sudo VPN_IPSEC_PSK='你的IPsec预共享密钥' \ VPN_USER='你的VPN用户名' \ VPN_PASSWORD='你的VPN密码' \ -sh vpnsetup.sh +sh vpn.sh ``` @@ -239,11 +239,11 @@ Amazon Linux 2 ```bash # 所有变量值必须用 '单引号' 括起来 # *不要* 在值中使用这些字符： \ " ' -wget https://git.io/vpnsetup-amzn -O vpnsetup.sh +wget https://git.io/vpnsetup-amzn -O vpn.sh sudo VPN_IPSEC_PSK='你的IPsec预共享密钥' \ VPN_USER='你的VPN用户名' \ VPN_PASSWORD='你的VPN密码' \ -sh vpnsetup.sh +sh vpn.sh ``` diff --git a/README.md b/README.md index a4153ce..53a3eb9 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Build Status](https://img.shields.io/github/workflow/status/hwdsl2/setup-ipsec-vpn/vpn%20test.svg?cacheSeconds=3600)](https://github.com/hwdsl2/setup-ipsec-vpn/actions) [![GitHub Stars](https://img.shields.io/github/stars/hwdsl2/setup-ipsec-vpn.svg?cacheSeconds=86400)](https://github.com/hwdsl2/setup-ipsec-vpn/stargazers) [![Docker Stars](https://img.shields.io/docker/stars/hwdsl2/ipsec-vpn-server.svg?cacheSeconds=86400)](https://github.com/hwdsl2/docker-ipsec-vpn-server) [![Docker Pulls](https://img.shields.io/docker/pulls/hwdsl2/ipsec-vpn-server.svg?cacheSeconds=86400)](https://github.com/hwdsl2/docker-ipsec-vpn-server) -Set up your own IPsec VPN server in just a few minutes, with both IPsec/L2TP and Cisco IPsec on Ubuntu, Debian and CentOS. All you need to do is provide your own VPN credentials, and let the scripts handle the rest. +Set up your own IPsec VPN server in just a few minutes, with IPsec/L2TP, Cisco IPsec and IKEv2 on Ubuntu, Debian and CentOS. All you need to do is provide your own VPN credentials, and let the scripts handle the rest. An IPsec VPN encrypts your network traffic, so that nobody between you and the VPN server can eavesdrop on your data as it travels via the Internet. This is especially useful when using unsecured networks, e.g. at coffee shops, airports or hotel rooms. @@ -38,7 +38,7 @@ Ubuntu & Debian ```bash -wget https://git.io/vpnsetup -O vpnsetup.sh && sudo sh vpnsetup.sh +wget https://git.io/vpnsetup -O vpn.sh && sudo sh vpn.sh ``` @@ -48,7 +48,7 @@ CentOS & RHEL ```bash -wget https://git.io/vpnsetup-centos -O vpnsetup.sh && sudo sh vpnsetup.sh +wget https://git.io/vpnsetup-centos -O vpn.sh && sudo sh vpn.sh ``` @@ -58,7 +58,7 @@ Amazon Linux 2 ```bash -wget https://git.io/vpnsetup-amzn -O vpnsetup.sh && sudo sh vpnsetup.sh +wget https://git.io/vpnsetup-amzn -O vpn.sh && sudo sh vpn.sh ``` @@ -127,7 +127,7 @@ Ubuntu & Debian ```bash -wget https://git.io/vpnsetup -O vpnsetup.sh && sudo sh vpnsetup.sh +wget https://git.io/vpnsetup -O vpn.sh && sudo sh vpn.sh ``` @@ -138,7 +138,7 @@ CentOS & RHEL ```bash yum -y install wget -wget https://git.io/vpnsetup-centos -O vpnsetup.sh && sudo sh vpnsetup.sh +wget https://git.io/vpnsetup-centos -O vpn.sh && sudo sh vpn.sh ``` @@ -148,7 +148,7 @@ Amazon Linux 2 ```bash -wget https://git.io/vpnsetup-amzn -O vpnsetup.sh && sudo sh vpnsetup.sh +wget https://git.io/vpnsetup-amzn -O vpn.sh && sudo sh vpn.sh ``` @@ -160,10 +160,10 @@ Ubuntu & Debian ```bash -wget https://git.io/vpnsetup -O vpnsetup.sh -nano -w vpnsetup.sh +wget https://git.io/vpnsetup -O vpn.sh +nano -w vpn.sh [Replace with your own values: YOUR_IPSEC_PSK, YOUR_USERNAME and YOUR_PASSWORD] -sudo sh vpnsetup.sh +sudo sh vpn.sh ``` @@ -174,10 +174,10 @@ CentOS & RHEL ```bash yum -y install wget nano -wget https://git.io/vpnsetup-centos -O vpnsetup.sh -nano -w vpnsetup.sh +wget https://git.io/vpnsetup-centos -O vpn.sh +nano -w vpn.sh [Replace with your own values: YOUR_IPSEC_PSK, YOUR_USERNAME and YOUR_PASSWORD] -sudo sh vpnsetup.sh +sudo sh vpn.sh ``` @@ -187,10 +187,10 @@ Amazon Linux 2 ```bash -wget https://git.io/vpnsetup-amzn -O vpnsetup.sh -nano -w vpnsetup.sh +wget https://git.io/vpnsetup-amzn -O vpn.sh +nano -w vpn.sh [Replace with your own values: YOUR_IPSEC_PSK, YOUR_USERNAME and YOUR_PASSWORD] -sudo sh vpnsetup.sh +sudo sh vpn.sh ``` @@ -206,11 +206,11 @@ Ubuntu & Debian ```bash # All values MUST be placed inside 'single quotes' # DO NOT use these special characters within values: \ " ' -wget https://git.io/vpnsetup -O vpnsetup.sh +wget https://git.io/vpnsetup -O vpn.sh sudo VPN_IPSEC_PSK='your_ipsec_pre_shared_key' \ VPN_USER='your_vpn_username' \ VPN_PASSWORD='your_vpn_password' \ -sh vpnsetup.sh +sh vpn.sh ``` @@ -223,11 +223,11 @@ CentOS & RHEL # All values MUST be placed inside 'single quotes' # DO NOT use these special characters within values: \ " ' yum -y install wget -wget https://git.io/vpnsetup-centos -O vpnsetup.sh +wget https://git.io/vpnsetup-centos -O vpn.sh sudo VPN_IPSEC_PSK='your_ipsec_pre_shared_key' \ VPN_USER='your_vpn_username' \ VPN_PASSWORD='your_vpn_password' \ -sh vpnsetup.sh +sh vpn.sh ``` @@ -239,11 +239,11 @@ Amazon Linux 2 ```bash # All values MUST be placed inside 'single quotes' # DO NOT use these special characters within values: \ " ' -wget https://git.io/vpnsetup-amzn -O vpnsetup.sh +wget https://git.io/vpnsetup-amzn -O vpn.sh sudo VPN_IPSEC_PSK='your_ipsec_pre_shared_key' \ VPN_USER='your_vpn_username' \ VPN_PASSWORD='your_vpn_password' \ -sh vpnsetup.sh +sh vpn.sh ``` diff --git a/aws/cloudformation-template-ipsec b/aws/cloudformation-template-ipsec index 56775a6..5c1284e 100644 --- a/aws/cloudformation-template-ipsec +++ b/aws/cloudformation-template-ipsec @@ -392,7 +392,7 @@ "Ref": "VpnPassword" }, "'\n", - "wget -t 3 -T 30 -nv -O vpnsetup.sh ", + "wget -t 3 -T 30 -nv -O vpn.sh ", { "Fn::FindInMap": [ "OS", @@ -403,7 +403,7 @@ ] }, "\n", - "sh vpnsetup.sh\n", + "sh vpn.sh\n", "cfn-signal -e 0 ", " --stack ", { diff --git a/azure/install.sh b/azure/install.sh index 811f7c3..7a64340 100644 --- a/azure/install.sh +++ b/azure/install.sh @@ -7,4 +7,4 @@ export VPN_PASSWORD=$3 # Wait 60 seconds for apt/dpkg lock sleep 60 -wget https://git.io/vpnsetup -O vpnsetup.sh && sh vpnsetup.sh +wget https://git.io/vpnsetup -O vpn.sh && sh vpn.sh diff --git a/docs/ikev2-howto-zh.md b/docs/ikev2-howto-zh.md index f9eebe6..a616164 100644 --- a/docs/ikev2-howto-zh.md +++ b/docs/ikev2-howto-zh.md @@ -588,6 +588,8 @@ To customize IKEv2 or client options, run this script without arguments. ## 故障排除 +*其他语言版本: [English](ikev2-howto.md#troubleshooting), [简体中文](ikev2-howto-zh.md#故障排除).* + ### 在导入客户端配置文件时提示密码不正确 如果你忘记了客户端配置文件的密码，可以重新 [导出 IKEv2 客户端的配置](#导出一个已有的客户端的配置)。 diff --git a/docs/ikev2-howto.md b/docs/ikev2-howto.md index 40367f7..eac1364 100644 --- a/docs/ikev2-howto.md +++ b/docs/ikev2-howto.md @@ -588,6 +588,8 @@ Before continuing, you **must** restart the IPsec service. The IKEv2 setup on th ## Troubleshooting +*Read this in other languages: [English](ikev2-howto.md#troubleshooting), [简体中文](ikev2-howto-zh.md#故障排除).* + ### Incorrect password when trying to import client config files If you forgot the password for client config files, you may [export configuration for the IKEv2 client](#export-configuration-for-an-existing-client) again.