Update docs to reflect new changes

2024-06-20 12:46:06 +02:00 · 2016-05-18 22:16:11 -05:00 · 2016-05-18 22:16:11 -05:00 · eddcd9ec3b
commit eddcd9ec3b
parent 5f63b2fee6
6 changed files with 40 additions and 40 deletions
--- a/README-zh.md
+++ b/README-zh.md
@ -24,7 +24,7 @@

 ## 功能特性

- :tada: **NEW：** 新增支持更高效的 `IPsec/XAUTH` （也称为 `Cisco IPsec`） 模式
+- :tada: **NEW：** 新增支持更高效的 `IPsec/XAUTH ("Cisco IPsec")` 模式
 - 全自动的 IPsec/L2TP VPN 服务器配置，无需用户输入
 - 封装所有的 VPN 流量在 UDP 协议，不需要 ESP 协议支持
 - 可直接作为 Amazon EC2 实例创建时的用户数据使用
@ -57,15 +57,15 @@
 **选项 1:** 使用脚本随机生成的 VPN 登录凭证 （在安装完成后显示）：

 ```bash
-wget https://git.io/vpnsetup -O vpnsetup.sh && sudo sh vpnsetup.sh
+wget 'https://git.io/vpnsetup' -O vpnsetup.sh && sudo sh vpnsetup.sh
 ```

-**选项 2:** 或者，在脚本中输入你自己的 VPN 登录凭证：
+**选项 2:** 在脚本中输入你自己的 VPN 登录凭证，或者将它们定义为环境变量：

 ```bash
-wget https://git.io/vpnsetup -O vpnsetup.sh
+wget 'https://git.io/vpnsetup' -O vpnsetup.sh
 nano -w vpnsetup.sh
-[修改为你自己的值： IPSEC_PSK, VPN_USER 和 VPN_PASSWORD]
+[修改为你自己的值： VPN_IPSEC_PSK, VPN_USER 和 VPN_PASSWORD]
 sudo sh vpnsetup.sh
 ```

@ -76,15 +76,15 @@ sudo sh vpnsetup.sh
 **选项 1:** 使用脚本随机生成的 VPN 登录凭证 （在安装完成后显示）：

 ```bash
-wget https://git.io/vpnsetup-centos -O vpnsetup_centos.sh && sudo sh vpnsetup_centos.sh
+wget 'https://git.io/vpnsetup-centos' -O vpnsetup_centos.sh && sudo sh vpnsetup_centos.sh
 ```

-**选项 2:** 或者，在脚本中输入你自己的 VPN 登录凭证：
+**选项 2:** 在脚本中输入你自己的 VPN 登录凭证，或者将它们定义为环境变量：

 ```bash
-wget https://git.io/vpnsetup-centos -O vpnsetup_centos.sh
+wget 'https://git.io/vpnsetup-centos' -O vpnsetup_centos.sh
 nano -w vpnsetup_centos.sh
-[修改为你自己的值： IPSEC_PSK, VPN_USER 和 VPN_PASSWORD]
+[修改为你自己的值： VPN_IPSEC_PSK, VPN_USER 和 VPN_PASSWORD]
 sudo sh vpnsetup_centos.sh
 ```

@ -94,7 +94,7 @@ sudo sh vpnsetup_centos.sh

 配置你的计算机或其它设备使用 VPN 。请参见： <a href="docs/clients-zh.md" target="_blank">配置 IPsec/L2TP VPN 客户端</a>。

-**NEW：** 新增支持更高效的 `IPsec/XAUTH` （也称为 `Cisco IPsec`） 模式。请参考 <a href="docs/clients-xauth-zh.md" target="_blank">配置 IPsec/XAUTH VPN 客户端</a>。
+**NEW：** 新增支持更高效的 `IPsec/XAUTH ("Cisco IPsec")` 模式。请参考 <a href="docs/clients-xauth-zh.md" target="_blank">配置 IPsec/XAUTH VPN 客户端</a>。

 开始使用自己的专属 VPN ! :sparkles::tada::rocket::sparkles:

@ -108,7 +108,7 @@ sudo sh vpnsetup_centos.sh

 在 VPN 已连接时，客户端配置为使用 <a href="https://developers.google.com/speed/public-dns/" target="_blank">Google Public DNS</a>。此设置可通过编辑文件 `options.xl2tpd` 和 `ipsec.conf` 来更改。

-如果服务器配置了自定义 SSH 端口（不是 22）或其他服务，请在运行脚本前编辑 <a href="vpnsetup.sh#L326" target="_blank">IPTables 防火墙规则</a>。
+如果服务器配置了自定义 SSH 端口（不是 22）或其他服务，请在运行脚本前编辑 <a href="vpnsetup.sh#L329" target="_blank">IPTables 防火墙规则</a>。

 这些脚本在更改现有的配置文件之前会先做备份，使用 `.old-日期-时间` 为文件名后缀。

--- a/README.md
+++ b/README.md
@ -24,7 +24,7 @@ We will use <a href="https://libreswan.org/" target="_blank">Libreswan</a> as th

 ## Features

- :tada: **NEW:** The faster `IPsec/XAUTH` (a.k.a. `Cisco IPsec`) mode is now supported
+- :tada: **NEW:** The faster `IPsec/XAUTH ("Cisco IPsec")` mode is now supported
 - Fully automated IPsec/L2TP 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
@ -57,15 +57,15 @@ First, update your system with `apt-get update && apt-get dist-upgrade` and rebo
 **Option 1:** Have the script generate random VPN credentials for you (will be displayed when done):

 ```bash
-wget https://git.io/vpnsetup -O vpnsetup.sh && sudo sh vpnsetup.sh
+wget 'https://git.io/vpnsetup' -O vpnsetup.sh && sudo sh vpnsetup.sh
 ```

-**Option 2:** Alternatively, enter your own VPN credentials in the script:
+**Option 2:** Enter your own VPN credentials, or define them as environment variables:

 ```bash
-wget https://git.io/vpnsetup -O vpnsetup.sh
+wget 'https://git.io/vpnsetup' -O vpnsetup.sh
 nano -w vpnsetup.sh
-[Replace with your own values: IPSEC_PSK, VPN_USER and VPN_PASSWORD]
+[Replace with your own values: VPN_IPSEC_PSK, VPN_USER and VPN_PASSWORD]
 sudo sh vpnsetup.sh
 ```

@ -76,15 +76,15 @@ First, update your system with `yum update` and reboot. This is optional, but re
 **Option 1:** Have the script generate random VPN credentials for you (will be displayed when done):

 ```bash
-wget https://git.io/vpnsetup-centos -O vpnsetup_centos.sh && sudo sh vpnsetup_centos.sh
+wget 'https://git.io/vpnsetup-centos' -O vpnsetup_centos.sh && sudo sh vpnsetup_centos.sh
 ```

-**Option 2:** Alternatively, enter your own VPN credentials in the script:
+**Option 2:** Enter your own VPN credentials, or define them as environment variables:

 ```bash
-wget https://git.io/vpnsetup-centos -O vpnsetup_centos.sh
+wget 'https://git.io/vpnsetup-centos' -O vpnsetup_centos.sh
 nano -w vpnsetup_centos.sh
-[Replace with your own values: IPSEC_PSK, VPN_USER and VPN_PASSWORD]
+[Replace with your own values: VPN_IPSEC_PSK, VPN_USER and VPN_PASSWORD]
 sudo sh vpnsetup_centos.sh
 ```

@ -94,7 +94,7 @@ If unable to download via `wget`, you may alternatively open <a href="vpnsetup.s

 Get your computer or device to use the VPN. Please see: <a href="docs/clients.md" target="_blank">Configure IPsec/L2TP VPN Clients</a>.

-**NEW:** The faster `IPsec/XAUTH` (a.k.a. `Cisco IPsec`) mode is now supported. See: <a href="docs/clients-xauth.md" target="_blank">Configure IPsec/XAUTH VPN Clients</a>.
+**NEW:** The faster `IPsec/XAUTH ("Cisco IPsec")` mode is now supported. See: <a href="docs/clients-xauth.md" target="_blank">Configure IPsec/XAUTH VPN Clients</a>.

 Enjoy your very own VPN! :sparkles::tada::rocket::sparkles:

@ -108,7 +108,7 @@ To create multiple VPN users with different credentials, just <a href="docs/enab

 Clients are set to use <a href="https://developers.google.com/speed/public-dns/" target="_blank">Google Public DNS</a> when the VPN is active. To change, edit `options.xl2tpd` and `ipsec.conf`.

-For servers with a custom SSH port (not 22) or other services, edit the <a href="vpnsetup.sh#L326" target="_blank">IPTables rules</a> before using.
+For servers with a custom SSH port (not 22) or other services, edit the <a href="vpnsetup.sh#L329" target="_blank">IPTables rules</a> before using.

 The scripts will backup existing config files before making changes, with `.old-date-time` suffix.

--- a/docs/clients-xauth-zh.md
+++ b/docs/clients-xauth-zh.md
@ -24,7 +24,7 @@
 1. 单击工具栏中的 **Add (+)** 按钮。
 1. 在 **Host Name or IP Address** 字段中输入`你的 VPN 服务器 IP`。
 1. 单击 **Authentication** 选项卡，从 **Authentication Method** 下拉菜单中选择 **Mutual PSK + XAuth**。
-1. 单击 **Credentials** 子选项卡，并在 **Pre Shared Key** 字段中输入`你的 IPsec PSK`。
+1. 单击 **Credentials** 子选项卡，并在 **Pre Shared Key** 字段中输入`你的 VPN IPsec PSK`。
 1. 单击 **Phase 1** 选项卡，从 **Exchange Type** 下拉菜单中选择 **main**。
 1. 单击 **Save** 保存 VPN 连接的详细信息。
 1. 选择新添加的 VPN 连接。单击工具栏中的 **Connect** 按钮。
@ -47,7 +47,7 @@ VPN 连接成功后，会在 VPN Connect 状态窗口中显示 **tunnel enabled*
 1. 在 **帐户名称** 字段中输入`你的 VPN 用户名`。
 1. 在 **密码** 字段中输入`你的 VPN 密码`。
 1. 单击 **鉴定设置** 按钮。
-1. 在 **机器鉴定** 部分，选择 **共享的密钥** 单选按钮，然后输入`你的 IPsec PSK`。
+1. 在 **机器鉴定** 部分，选择 **共享的密钥** 单选按钮，然后输入`你的 VPN IPsec PSK`。
 1. 保持 **群组名称** 字段空白。
 1. 单击 **好**。
 1. 选中 **在菜单栏中显示 VPN 状态** 复选框。
@ -64,7 +64,7 @@ VPN 连接成功后，会在 VPN Connect 状态窗口中显示 **tunnel enabled*
 1. 在 **类型** 下拉菜单选择 **IPSec Xauth PSK**。
 1. 在 **服务器地址** 字段中输入`你的 VPN 服务器 IP`。
 1. 保持 **IPSec 标识符** 字段空白。
-1. 在 **IPSec 预共享密钥** 字段中输入`你的 IPsec PSK`。
+1. 在 **IPSec 预共享密钥** 字段中输入`你的 VPN IPsec PSK`。
 1. 单击 **保存**。
 1. 单击新的VPN连接。
 1. 在 **用户名** 字段中输入`你的 VPN 用户名`。
@ -85,7 +85,7 @@ VPN 连接成功后，会在通知栏显示图标。最后你可以到<a href="h
 1. 在 **帐户** 字段中输入`你的 VPN 用户名`。
 1. 在 **密码** 字段中输入`你的 VPN 密码`。
 1. 保持 **群组名称** 字段空白。
-1. 在 **密钥** 字段中输入`你的 IPsec PSK`。
+1. 在 **密钥** 字段中输入`你的 VPN IPsec PSK`。
 1. 单击右上角的 **存储**。
 1. 启用 **VPN** 连接。

--- a/docs/clients-xauth.md
+++ b/docs/clients-xauth.md
@ -24,7 +24,7 @@ Note: You may also connect using [IPsec/L2TP mode](clients.md). No additional so
 1. Click the **Add (+)** button on toolbar.
 1. Enter `Your VPN Server IP` in the **Host Name or IP Address** field.
 1. Click the **Authentication** tab. Select **Mutual PSK + XAuth** from the **Authentication Method** drop-down menu.
-1. Click the **Credentials** tab below. Enter `Your IPsec PSK` in the **Pre Shared Key** field.
+1. Click the **Credentials** tab below. Enter `Your VPN IPsec PSK` in the **Pre Shared Key** field.
 1. Click the **Phase 1** tab. Select **main** from the **Exchange Type** drop-down menu.
 1. Click **Save** to save the VPN connection details.
 1. Select the new VPN connection. Click the **Connect** button on toolbar.
@ -47,7 +47,7 @@ Once connected, you will see **tunnel enabled** in the VPN Connect status window
 1. Enter `Your VPN Username` for the **Account Name**.
 1. Enter `Your VPN Password` for the **Password**.
 1. Click the **Authentication Settings** button.
-1. In the **Machine Authentication** section, select the **Shared Secret** radio button and enter `Your IPsec PSK` as its value.
+1. In the **Machine Authentication** section, select the **Shared Secret** radio button and enter `Your VPN IPsec PSK` as its value.
 1. Leave the **Group Name** field blank.
 1. Click **OK**.
 1. Check the **Show VPN status in menu bar** checkbox.
@ -64,7 +64,7 @@ You can connect to the VPN using the VPN icon in the menu bar, or by selecting t
 1. Select **IPSec Xauth PSK** in the **Type** drop-down menu.
 1. Enter `Your VPN Server IP` in the **Server address** field.
 1. Leave the **IPSec identifier** field blank.
-1. Enter `Your IPsec PSK` in the **IPSec pre-shared key** field.
+1. Enter `Your VPN IPsec PSK` in the **IPSec pre-shared key** field.
 1. Tap **Save**.
 1. Tap the new VPN connection.
 1. Enter `Your VPN Username` in the **Username** field.
@ -85,7 +85,7 @@ Once connected, you will see a VPN icon in the notification bar. You can verify
 1. Tap **Account** and enter `Your VPN Username`.
 1. Tap **Password** and enter `Your VPN Password`.
 1. Leave the **Group Name** field blank.
-1. Tap **Secret** and enter `Your IPsec PSK`.
+1. Tap **Secret** and enter `Your VPN IPsec PSK`.
 1. Tap **Done**.
 1. Slide the **VPN** switch ON.

--- a/docs/clients-zh.md
+++ b/docs/clients-zh.md
@ -34,7 +34,7 @@
 1. 单击 **选项** 选项卡，取消选中 **包含Windows登录域** 复选框。
 1. 单击 **安全** 选项卡，从 **VPN 类型** 下拉菜单中选择 **使用 IPsec 的第 2 层隧道协议 (L2TP/IPSec)**。在 **允许使用这些协议** 下，选中 `CHAP` 复选框，并且取消选中 `MS-CHAP v2`。
 1. 单击 **高级设置** 按钮。
-1. 单击 **使用预共享密钥作身份验证** 并在 **密钥** 字段中输入`你的 IPsec PSK`。
+1. 单击 **使用预共享密钥作身份验证** 并在 **密钥** 字段中输入`你的 VPN IPsec PSK`。
 1. 单击 **确定** 关闭 **高级设置**。
 1. 单击 **确定** 保存 VPN 连接的详细信息。

@ -53,7 +53,7 @@
 1. 在 **帐户名称** 字段中输入`你的 VPN 用户名`。
 1. 单击 **鉴定设置** 按钮。
 1. 在 **用户鉴定** 部分，选择 **密码** 单选按钮，然后输入`你的 VPN 密码`。
-1. 在 **机器鉴定** 部分，选择 **共享的密钥** 单选按钮，然后输入`你的 IPsec PSK`。
+1. 在 **机器鉴定** 部分，选择 **共享的密钥** 单选按钮，然后输入`你的 VPN IPsec PSK`。
 1. 单击 **好**。
 1. 选中 **在菜单栏中显示 VPN 状态** 复选框。
 1. 单击 **高级** 按钮，并选中 **通过VPN连接发送所有通信** 复选框。
@ -70,7 +70,7 @@
 1. 在 **名称** 字段中输入任意内容。
 1. 在 **类型** 下拉菜单选择 **L2TP/IPSec PSK**。
 1. 在 **服务器地址** 字段中输入`你的 VPN 服务器 IP`。
-1. 在 **IPSec 预共享密钥** 字段中输入`你的 IPsec PSK`。
+1. 在 **IPSec 预共享密钥** 字段中输入`你的 VPN IPsec PSK`。
 1. 单击 **保存**。
 1. 单击新的VPN连接。
 1. 在 **用户名** 字段中输入`你的 VPN 用户名`。
@ -90,7 +90,7 @@ VPN 连接成功后，会在通知栏显示图标。最后你可以到<a href="h
 1. 在 **服务器** 字段中输入`你的 VPN 服务器 IP`。
 1. 在 **帐户** 字段中输入`你的 VPN 用户名`。
 1. 在 **密码** 字段中输入`你的 VPN 密码`。
-1. 在 **密钥** 字段中输入`你的 IPsec PSK`。
+1. 在 **密钥** 字段中输入`你的 VPN IPsec PSK`。
 1. 启用 **发送所有流量** 选项。
 1. 单击右上角的 **存储**。
 1. 启用 **VPN** 连接。
@ -106,7 +106,7 @@ VPN 连接成功后，会在通知栏显示图标。最后你可以到<a href="h
 1. 在 **服务器主机名** 字段中输入`你的 VPN 服务器 IP`。
 1. 在 **服务名称** 字段中输入任意内容。
 1. 在 **供应商类型** 下拉菜单选择 **L2TP/IPsec + 预共享密钥**。
-1. 在 **预共享密钥** 字段中输入`你的 IPsec PSK`。
+1. 在 **预共享密钥** 字段中输入`你的 VPN IPsec PSK`。
 1. 在 **用户名** 字段中输入`你的 VPN 用户名`。
 1. 在 **密码** 字段中输入`你的 VPN 密码`。
 1. 单击 **连接**。
--- a/docs/clients.md
+++ b/docs/clients.md
@ -34,7 +34,7 @@ After <a href="https://github.com/hwdsl2/setup-ipsec-vpn" target="_blank">settin
 1. Click the **Options** tab and uncheck **Include Windows logon domain**.
 1. Click the **Security** tab and select **Layer 2 Tunneling Protocol with IPsec (L2TP/IPSec)** from the **Type of VPN** drop-down menu. Under "Allow these protocols", select the `CHAP` checkbox, and de-select `MS-CHAP v2`.
 1. Click the **Advanced settings** button.
-1. Select **Use preshared key for authentication** and enter `Your IPsec PSK` for the **Key**.
+1. Select **Use preshared key for authentication** and enter `Your VPN IPsec PSK` for the **Key**.
 1. Click **OK** to close the **Advanced settings**.
 1. Click **OK** to save the VPN connection details.

@ -53,7 +53,7 @@ To connect to the VPN, simply right-click on the wireless/network icon in your s
 1. Enter `Your VPN Username` for the **Account Name**.
 1. Click the **Authentication Settings** button.
 1. In the **User Authentication** section, select the **Password** radio button and enter `Your VPN Password` as its value.
-1. In the **Machine Authentication** section, select the **Shared Secret** radio button and enter `Your IPsec PSK` as its value.
+1. In the **Machine Authentication** section, select the **Shared Secret** radio button and enter `Your VPN IPsec PSK` as its value.
 1. Click **OK**.
 1. Check the **Show VPN status in menu bar** checkbox.
 1. Click the **Advanced** button and make sure the **Send all traffic over VPN connection** checkbox is selected.
@ -70,7 +70,7 @@ You can connect to the VPN using the VPN icon in the menu bar, or by selecting t
 1. Enter anything you like in the **Name** field.
 1. Select **L2TP/IPSec PSK** in the **Type** drop-down menu.
 1. Enter `Your VPN Server IP` in the **Server address** field.
-1. Enter `Your IPsec PSK` in the **IPSec pre-shared key** field.
+1. Enter `Your VPN IPsec PSK` in the **IPSec pre-shared key** field.
 1. Tap **Save**.
 1. Tap the new VPN connection.
 1. Enter `Your VPN Username` in the **Username** field.
@ -90,7 +90,7 @@ Once connected, you will see a VPN icon in the notification bar. You can verify
 1. Tap **Server** and enter `Your VPN Server IP`.
 1. Tap **Account** and enter `Your VPN Username`.
 1. Tap **Password** and enter `Your VPN Password`.
-1. Tap **Secret** and enter `Your IPsec PSK`.
+1. Tap **Secret** and enter `Your VPN IPsec PSK`.
 1. Make sure the **Send All Traffic** switch is ON.
 1. Tap **Done**.
 1. Slide the **VPN** switch ON.
@ -106,7 +106,7 @@ Once connected, you will see a VPN icon in the status bar. You can verify that y
 1. Enter `Your VPN Server IP` for the **Server hostname**.
 1. Enter anything you like for the **Service name**.
 1. Make sure **Provider type** is **L2TP/IPSec + pre-shared key**.
-1. Enter `Your IPsec PSK` for the **Pre-shared key**.
+1. Enter `Your VPN IPsec PSK` for the **Pre-shared key**.
 1. Enter `Your VPN Username` for the **Username**.
 1. Enter `Your VPN Password` for the **Password**.
 1. Click **Connect**.