From 215c9030badacb82ec43bc5f23bf070d2599e7f1 Mon Sep 17 00:00:00 2001 From: hwdsl2 Date: Mon, 18 Jan 2021 11:03:39 -0600 Subject: [PATCH] Update docs --- README-zh.md | 2 ++ README.md | 2 ++ docs/ikev2-howto-zh.md | 16 ++++++++-------- docs/ikev2-howto.md | 14 +++++++------- 4 files changed, 19 insertions(+), 15 deletions(-) diff --git a/README-zh.md b/README-zh.md index 943d00e..3400259 100644 --- a/README-zh.md +++ b/README-zh.md @@ -253,6 +253,8 @@ sh vpnsetup.sh wget https://git.io/ikev2setup -O ikev2.sh && sudo bash ikev2.sh --auto ``` +以上命令使用自动模式和默认选项运行 IKEv2 辅助脚本。如果你想要自定义 IKEv2 安装选项，请在运行脚本时去掉 `--auto` 参数。 + **注：** 如果无法通过 `wget` 下载，你也可以打开 vpnsetup.sh，vpnsetup_centos.sh 或者 vpnsetup_amzn.sh，然后点击右方的 **`Raw`** 按钮。按快捷键 `Ctrl-A` 全选， `Ctrl-C` 复制，然后粘贴到你喜欢的编辑器。 ## 下一步 diff --git a/README.md b/README.md index 520ce84..d4c100d 100644 --- a/README.md +++ b/README.md @@ -253,6 +253,8 @@ After successful installation, it is recommended to IKEv2 helper script in auto mode, using default options. Remove the `--auto` parameter if you want to customize IKEv2 setup options. + **Note:** If unable to download via `wget`, you may also open vpnsetup.sh, vpnsetup_centos.sh or vpnsetup_amzn.sh, and click the **`Raw`** button on the right. Press `Ctrl-A` to select all, `Ctrl-C` to copy, then paste into your favorite editor. ## Next steps diff --git a/docs/ikev2-howto-zh.md b/docs/ikev2-howto-zh.md index e788e6d..49a6fe8 100644 --- a/docs/ikev2-howto-zh.md +++ b/docs/ikev2-howto-zh.md @@ -2,6 +2,8 @@ *其他语言版本: [English](ikev2-howto.md), [简体中文](ikev2-howto-zh.md).* +**注：** 你也可以使用 [IPsec/L2TP](clients-zh.md) 或者 [IPsec/XAuth](clients-xauth-zh.md) 模式连接。 + * [导言](#导言) * [使用辅助脚本](#使用辅助脚本) * [配置 IKEv2 VPN 客户端](#配置-ikev2-vpn-客户端) @@ -13,7 +15,7 @@ ## 导言 -现代操作系统（比如 Windows 7 和更新版本）支持 IKEv2 协议标准。因特网密钥交换 （英语：Internet Key Exchange，简称 IKE 或 IKEv2）是一种网络协议，归属于 IPsec 协议族之下，用以创建安全关联 (Security Association, SA)。与 IKE 版本 1 相比较，IKEv2 的 功能改进 包括比如通过 MOBIKE 实现 Standard Mobility 支持，以及更高的可靠性。 +现代操作系统（比如 Windows 7 和更新版本）支持 IKEv2 协议标准。因特网密钥交换（英语：Internet Key Exchange，简称 IKE 或 IKEv2）是一种网络协议，归属于 IPsec 协议族之下，用以创建安全关联 (Security Association, SA)。与 IKE 版本 1 相比较，IKEv2 的 功能改进 包括比如通过 MOBIKE 实现 Standard Mobility 支持，以及更高的可靠性。 Libreswan 支持通过使用 RSA 签名算法的 X.509 Machine Certificates 来对 IKEv2 客户端进行身份验证。该方法无需 IPsec PSK, 用户名或密码。它可以用于以下系统： @@ -28,23 +30,21 @@ Libreswan 支持通过使用 RSA 签名算法的 X.509 Machine Certificates 来 **新：** 辅助脚本现在可以为 macOS 和 iOS 客户端创建 .mobileconfig 文件，以简化客户端设置并提高 VPN 性能。 -**重要：** 作为使用本指南的先决条件，在继续之前，你必须确保你已经成功地 搭建自己的 VPN 服务器，并且（可选但推荐）将 Libreswan 升级 到最新版本。**Docker 用户请看 这里**。 +**重要：** 在继续之前，你应该已经成功地 搭建自己的 VPN 服务器，并且（可选但推荐）升级 Libreswan。**Docker 用户请看 这里**。 -你可以使用这个辅助脚本来自动地在 VPN 服务器上配置 IKEv2： +使用这个辅助脚本来自动地在 VPN 服务器上配置 IKEv2： ``` wget https://git.io/ikev2setup -O ikev2.sh && sudo bash ikev2.sh --auto ``` -该 脚本 必须使用 `bash` 而不是 `sh` 运行。以上命令使用自动模式和默认选项运行辅助脚本。如果你想要自定义 IKEv2 安装选项，请在运行脚本时去掉 `--auto` 参数。 - -在完成之后，请转到 [配置 IKEv2 VPN 客户端](#配置-ikev2-vpn-客户端)。如果要为更多的客户端生成证书，只需重新运行脚本。 +该 脚本 必须使用 `bash` 而不是 `sh` 运行。以上命令使用自动模式和默认选项运行辅助脚本。如果你想要自定义 IKEv2 安装选项，请在运行脚本时去掉 `--auto` 参数。在完成之后，请转到 [配置 IKEv2 VPN 客户端](#配置-ikev2-vpn-客户端)。 ## 配置 IKEv2 VPN 客户端 *其他语言版本: [English](ikev2-howto.md#configure-ikev2-vpn-clients), [简体中文](ikev2-howto-zh.md#配置-ikev2-vpn-客户端).* -**注：** 如果你在配置 IKEv2 时指定了服务器的域名（而不是 IP 地址），则必须在 **服务器地址** 和 **远程 ID** 字段中输入该域名。如果要为更多的客户端生成证书，只需重新运行[辅助脚本](#使用辅助脚本)。或者你可以看 [这一小节](#手动在-vpn-服务器上配置-ikev2) 的第 4 步。 +**注：** 如果你在配置 IKEv2 时指定了服务器的域名（而不是 IP 地址），则必须在 **服务器地址** 和 **远程 ID** 字段中输入该域名（如果适用）。如果要为更多的客户端生成证书，只需重新运行[辅助脚本](#使用辅助脚本)。或者你可以看 [这一小节](#手动在-vpn-服务器上配置-ikev2) 的第 4 步。 * [Windows 7, 8.x 和 10](#windows-7-8x-和-10) * [OS X (macOS)](#os-x-macos) @@ -203,7 +203,7 @@ wget https://git.io/ikev2setup -O ikev2.sh && sudo bash ikev2.sh --auto ### 导出一个客户端证书 -在默认情况下，IKEv2 [辅助脚本](#使用辅助脚本) 在运行后会导出客户端证书。如果你想要手动导出一个客户端证书，首先检查证书数据库：`certutil -L -d sql:/etc/ipsec.d`，然后参见 [这一小节](#手动在-vpn-服务器上配置-ikev2) 第 4 步中的 "导出 `.p12` 文件"。 +在默认情况下，[IKEv2 辅助脚本](#使用辅助脚本) 在运行后会导出客户端证书。如果你想要手动导出一个客户端证书，首先检查证书数据库：`certutil -L -d sql:/etc/ipsec.d`，然后参见 [这一小节](#手动在-vpn-服务器上配置-ikev2) 第 4 步中的 "导出 `.p12` 文件"。 ### 吊销一个客户端证书 diff --git a/docs/ikev2-howto.md b/docs/ikev2-howto.md index 178cd16..b8d154c 100644 --- a/docs/ikev2-howto.md +++ b/docs/ikev2-howto.md @@ -2,6 +2,8 @@ *Read this in other languages: [English](ikev2-howto.md), [简体中文](ikev2-howto-zh.md).* +**Note:** You may also connect using [IPsec/L2TP](clients.md) or [IPsec/XAuth](clients-xauth.md) mode. + * [Introduction](#introduction) * [Using helper scripts](#using-helper-scripts) * [Configure IKEv2 VPN clients](#configure-ikev2-vpn-clients) @@ -28,23 +30,21 @@ After following this guide, you will be able to connect to the VPN using IKEv2 i **New:** For macOS and iOS clients, the helper script can now create .mobileconfig files to simplify client setup and improve VPN performance. -**Important:** As a prerequisite to using this guide, and before continuing, you must make sure that you have successfully set up your own VPN server, and (optional but recommended) upgraded Libreswan to the latest version. **Docker users, see here**. +**Important:** Before continuing, you should have successfully set up your own VPN server, and (optional but recommended) updated Libreswan. **Docker users, see here**. -You may use this helper script to automatically set up IKEv2 on the VPN server: +Use this helper script to automatically set up IKEv2 on the VPN server: ``` wget https://git.io/ikev2setup -O ikev2.sh && sudo bash ikev2.sh --auto ``` -The script must be run using `bash`, not `sh`. The command above runs the helper script in auto mode, using default options. Remove the `--auto` parameter if you want to customize IKEv2 setup options. - -When finished, continue to [configure IKEv2 VPN clients](#configure-ikev2-vpn-clients). If you want to generate certificates for additional VPN clients, just run the script again. +The script must be run using `bash`, not `sh`. The command above runs the helper script in auto mode, using default options. Remove the `--auto` parameter if you want to customize IKEv2 setup options. When finished, continue to [configure IKEv2 VPN clients](#configure-ikev2-vpn-clients). ## Configure IKEv2 VPN clients *Read this in other languages: [English](ikev2-howto.md#configure-ikev2-vpn-clients), [简体中文](ikev2-howto-zh.md#配置-ikev2-vpn-客户端).* -**Note:** If you specified the server's DNS name (instead of its IP address) during IKEv2 setup, you must enter the DNS name in the **Server** and **Remote ID** fields. If you want to generate certificates for additional VPN clients, just run the [helper script](#using-helper-scripts) again. Or you may refer to step 4 in [this section](#manually-set-up-ikev2-on-the-vpn-server). +**Note:** If you specified the server's DNS name (instead of its IP address) during IKEv2 setup, you must enter the DNS name in the **Server** and **Remote ID** fields (if applicable). If you want to generate certificates for additional VPN clients, just run the [helper script](#using-helper-scripts) again. Or you may refer to step 4 in [this section](#manually-set-up-ikev2-on-the-vpn-server). * [Windows 7, 8.x and 10](#windows-7-8x-and-10) * [OS X (macOS)](#os-x-macos) @@ -203,7 +203,7 @@ If you want to generate certificates for additional VPN clients, just run the [h ### Export a client certificate -By default, the IKEv2 [helper script](#using-helper-scripts) exports client certificates after running. If you want to manually export a client certificate, first check the database with `certutil -L -d sql:/etc/ipsec.d`, then refer to "export `.p12` file" in step 4 of [this section](#manually-set-up-ikev2-on-the-vpn-server). +By default, the [IKEv2 helper script](#using-helper-scripts) exports client certificates after running. If you want to manually export a client certificate, first check the database with `certutil -L -d sql:/etc/ipsec.d`, then refer to "export `.p12` file" in step 4 of [this section](#manually-set-up-ikev2-on-the-vpn-server). ### Revoke a client certificate