Skip to content

Commit 4c45d91

Browse files
hwdsl2hwdsl2
committed
Update docs
1 parent 1e29c64 commit 4c45d91

File tree

6 files changed

+26
-22
lines changed

6 files changed

+26
-22
lines changed

‎README-zh.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -133,28 +133,28 @@ sh vpn.sh
133133

134134
<details>
135135
<summary>
136-
高级用户可以自定义 IKEv2 选项。
136+
高级用户可以自定义 IKEv2 选项。这是可选的。
137137
</summary>
138138

139-
高级用户可以指定一个域名作为 IKEv2 模式下的 VPN 服务器地址。这是可选的。该域名必须是一个全称域名(FQDN)，它将被包含在生成的服务器证书中。示例如下：
139+
高级用户可以指定一个域名作为 IKEv2 服务器地址。这是可选的。该域名必须是一个全称域名(FQDN)。示例如下：
140140

141141
```bash
142142
sudo VPN_DNS_NAME='vpn.example.com' sh vpn.sh
143143
```
144144

145-
类似地，你可以指定第一个 IKEv2 客户端的名称。这是可选的。如果未指定，则使用默认值 `vpnclient`。
145+
类似地，你可以指定第一个 IKEv2 客户端的名称。如果未指定，则使用默认值 `vpnclient`。
146146

147147
```bash
148148
sudo VPN_CLIENT_NAME='your_client_name' sh vpn.sh
149149
```
150150

151-
在 VPN 已连接时，客户端默认配置为使用 [Google Public DNS](https://developers.google.com/speed/public-dns/)。高级用户可以为所有的 VPN 模式指定另外的 DNS 服务器。这是可选的。示例如下：
151+
在 VPN 已连接时，客户端默认配置为使用 [Google Public DNS](https://developers.google.com/speed/public-dns/)。高级用户可以为所有的 VPN 模式指定另外的 DNS 服务器。示例如下：
152152

153153
```bash
154154
sudo VPN_DNS_SRV1=1.1.1.1 VPN_DNS_SRV2=1.0.0.1 sh vpn.sh
155155
```
156156

157-
默认情况下，导入 IKEv2 客户端配置时不需要密码。你可以选择使用随机密码保护客户端配置文件。这是可选的。示例如下：
157+
默认情况下，导入 IKEv2 客户端配置时不需要密码。你可以选择使用随机密码保护客户端配置文件。示例如下：
158158

159159
```bash
160160
sudo VPN_PROTECT_CONFIG=yes sh vpn.sh

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -133,28 +133,28 @@ sh vpn.sh
133133

134134
<details>
135135
<summary>
136-
Advanced users can customize IKEv2 options.
136+
Advanced users can optionally customize IKEv2 options.
137137
</summary>
138138

139-
Advanced users can optionally specify a DNS name to be used as the VPN server address for IKEv2 mode. The DNS name must be a fully qualified domain name (FQDN). It will be included in the generated server certificate. Example:
139+
Advanced users can optionally specify a DNS name for the IKEv2 server address. The DNS name must be a fully qualified domain name (FQDN). Example:
140140

141141
```bash
142142
sudo VPN_DNS_NAME='vpn.example.com' sh vpn.sh
143143
```
144144

145-
Similarly, you may optionally specify a name for the first IKEv2 client. The default is `vpnclient` if not specified.
145+
Similarly, you may specify a name for the first IKEv2 client. The default is `vpnclient` if not specified.
146146

147147
```bash
148148
sudo VPN_CLIENT_NAME='your_client_name' sh vpn.sh
149149
```
150150

151-
By default, clients are set to use [Google Public DNS](https://developers.google.com/speed/public-dns/) when the VPN is active. Advanced users may optionally specify custom DNS server(s) for all VPN modes. Example:
151+
By default, clients are set to use [Google Public DNS](https://developers.google.com/speed/public-dns/) when the VPN is active. You may specify custom DNS server(s) for all VPN modes. Example:
152152

153153
```bash
154154
sudo VPN_DNS_SRV1=1.1.1.1 VPN_DNS_SRV2=1.0.0.1 sh vpn.sh
155155
```
156156

157-
By default, no password is required when importing IKEv2 client configuration. You may optionally choose to protect client config files using a random password. Example:
157+
By default, no password is required when importing IKEv2 client configuration. You can choose to protect client config files using a random password. Example:
158158

159159
```bash
160160
sudo VPN_PROTECT_CONFIG=yes sh vpn.sh

‎docs/advanced-usage-zh.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ sudo VPN_DNS_SRV1=1.1.1.1 VPN_DNS_SRV2=1.0.0.1 sh vpn.sh
2828

2929
对于 [IPsec/L2TP](clients-zh.md) 和 [IPsec/XAuth ("Cisco IPsec")](clients-xauth-zh.md) 模式，你可以在不需要额外配置的情况下使用一个域名（比如 `vpn.example.com`）而不是 IP 地址连接到 VPN 服务器。另外，一般来说，在服务器的 IP 更改后，比如在恢复一个映像到具有不同 IP 的新服务器后，VPN 会继续正常工作，虽然可能需要重启服务器。
3030

31-
对于 [IKEv2](ikev2-howto-zh.md) 模式，如果你想要 VPN 在服务器的 IP 更改后继续正常工作，参见 [这一小节](ikev2-howto-zh.md#更改-ikev2-服务器地址)。或者，你也可以在 [配置 IKEv2](ikev2-howto-zh.md#使用辅助脚本配置-ikev2) 时指定一个域名作为 VPN 服务器的地址。该域名必须是一个全称域名(FQDN)，它将被包含在生成的服务器证书中。示例如下：
31+
对于 [IKEv2](ikev2-howto-zh.md) 模式，如果你想要 VPN 在服务器的 IP 更改后继续正常工作，参见 [这一小节](ikev2-howto-zh.md#更改-ikev2-服务器地址)。或者，你也可以在 [配置 IKEv2](ikev2-howto-zh.md#使用辅助脚本配置-ikev2) 时指定一个域名作为 IKEv2 服务器地址。该域名必须是一个全称域名(FQDN)。示例如下：
3232

3333
```
3434
sudo VPN_DNS_NAME='vpn.example.com' ikev2.sh --auto
3535
```
3636

37-
另外，你也可以自定义 IKEv2 安装选项，通过在运行 [辅助脚本](ikev2-howto-zh.md#使用辅助脚本配置-ikev2) 时去掉 `--auto` 参数来实现。
37+
另外，你也可以自定义 IKEv2 选项，通过在运行 [辅助脚本](ikev2-howto-zh.md#使用辅助脚本配置-ikev2) 时去掉 `--auto` 参数来实现。
3838

3939
## 仅限 IKEv2 的 VPN
4040

‎docs/advanced-usage.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ In certain circumstances, you may want VPN clients to use the specified DNS serv
2828

2929
For [IPsec/L2TP](clients.md) and [IPsec/XAuth ("Cisco IPsec")](clients-xauth.md) modes, you may use a DNS name (e.g. `vpn.example.com`) instead of an IP address to connect to the VPN server, without additional configuration. In addition, the VPN should generally continue to work after server IP changes, such as after restoring a snapshot to a new server with a different IP, although a reboot may be required.
3030

31-
For [IKEv2](ikev2-howto.md) mode, if you want the VPN to continue to work after server IP changes, read [this section](ikev2-howto.md#change-ikev2-server-address). Alternatively, you may specify a DNS name to be used as the VPN server's address when [setting up IKEv2](ikev2-howto.md#set-up-ikev2-using-helper-script). The DNS name must be a fully qualified domain name (FQDN). It will be included in the generated server certificate. Example:
31+
For [IKEv2](ikev2-howto.md) mode, if you want the VPN to continue to work after server IP changes, read [this section](ikev2-howto.md#change-ikev2-server-address). Alternatively, you may specify a DNS name for the IKEv2 server address when [setting up IKEv2](ikev2-howto.md#set-up-ikev2-using-helper-script). The DNS name must be a fully qualified domain name (FQDN). Example:
3232

3333
```
3434
sudo VPN_DNS_NAME='vpn.example.com' ikev2.sh --auto
3535
```
3636

37-
Alternatively, you may customize IKEv2 setup options by running the [helper script](ikev2-howto.md#set-up-ikev2-using-helper-script) without the `--auto` parameter.
37+
Alternatively, you may customize IKEv2 options by running the [helper script](ikev2-howto.md#set-up-ikev2-using-helper-script) without the `--auto` parameter.
3838

3939
## IKEv2-only VPN
4040

‎docs/ikev2-howto-zh.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,25 +66,25 @@ chmod +x /opt/src/ikev2.sh && ln -s /opt/src/ikev2.sh /usr/bin
6666
你可以指定一个域名，客户端名称和/或另外的 DNS 服务器。这是可选的。
6767
</summary>
6868

69-
在使用自动模式安装 IKEv2 时，高级用户可以指定一个域名作为 VPN 服务器的地址。这是可选的。该域名必须是一个全称域名(FQDN)，它将被包含在生成的服务器证书中。示例如下：
69+
在使用自动模式安装 IKEv2 时，高级用户可以指定一个域名作为 IKEv2 服务器地址。这是可选的。该域名必须是一个全称域名(FQDN)。示例如下：
7070

7171
```bash
7272
sudo VPN_DNS_NAME='vpn.example.com' ikev2.sh --auto
7373
```
7474

75-
类似地，你可以指定第一个 IKEv2 客户端的名称。这是可选的。如果未指定，则使用默认值 `vpnclient`。
75+
类似地，你可以指定第一个 IKEv2 客户端的名称。如果未指定，则使用默认值 `vpnclient`。
7676

7777
```bash
7878
sudo VPN_CLIENT_NAME='your_client_name' ikev2.sh --auto
7979
```
8080

81-
在 VPN 已连接时，IKEv2 客户端默认配置为使用 [Google Public DNS](https://developers.google.com/speed/public-dns/)。在使用自动模式安装 IKEv2 时，你可以指定另外的 DNS 服务器。这是可选的。示例如下：
81+
在 VPN 已连接时，IKEv2 客户端默认配置为使用 [Google Public DNS](https://developers.google.com/speed/public-dns/)。你可以为 IKEv2 指定另外的 DNS 服务器。示例如下：
8282

8383
```bash
8484
sudo VPN_DNS_SRV1=1.1.1.1 VPN_DNS_SRV2=1.0.0.1 ikev2.sh --auto
8585
```
8686

87-
默认情况下，导入 IKEv2 客户端配置时不需要密码。你可以选择使用随机密码保护客户端配置文件。这是可选的。示例如下：
87+
默认情况下，导入 IKEv2 客户端配置时不需要密码。你可以选择使用随机密码保护客户端配置文件。示例如下：
8888

8989
```bash
9090
sudo VPN_PROTECT_CONFIG=yes ikev2.sh --auto
@@ -919,6 +919,8 @@ chmod +x /opt/src/ikev2.sh && ln -s /opt/src/ikev2.sh /usr/bin 2>/dev/null
919919
sudo ikev2.sh --removeikev2
920920
```
921921
922+
在移除 IKEv2 之后，如果你想要重新配置 IKEv2，参见 [这一小节](#使用辅助脚本配置-ikev2)。
923+
922924
<details>
923925
<summary>
924926
另外，你也可以手动移除 IKEv2。点这里查看步骤。

‎docs/ikev2-howto.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,25 +66,25 @@ Then run the script using the instructions above.
6666
You may optionally specify a DNS name, client name and/or custom DNS servers.
6767
</summary>
6868

69-
When running IKEv2 setup in auto mode, advanced users can optionally specify a DNS name to be used as the VPN server's address. The DNS name must be a fully qualified domain name (FQDN). It will be included in the generated server certificate. Example:
69+
When running IKEv2 setup in auto mode, advanced users can optionally specify a DNS name for the IKEv2 server address. The DNS name must be a fully qualified domain name (FQDN). Example:
7070

7171
```bash
7272
sudo VPN_DNS_NAME='vpn.example.com' ikev2.sh --auto
7373
```
7474

75-
Similarly, you may optionally specify a name for the first IKEv2 client. The default is `vpnclient` if not specified.
75+
Similarly, you may specify a name for the first IKEv2 client. The default is `vpnclient` if not specified.
7676

7777
```bash
7878
sudo VPN_CLIENT_NAME='your_client_name' ikev2.sh --auto
7979
```
8080

81-
By default, IKEv2 clients are set to use [Google Public DNS](https://developers.google.com/speed/public-dns/) when the VPN is active. When running IKEv2 setup in auto mode, you may optionally specify custom DNS server(s). Example:
81+
By default, IKEv2 clients are set to use [Google Public DNS](https://developers.google.com/speed/public-dns/) when the VPN is active. You may specify custom DNS server(s) for IKEv2. Example:
8282

8383
```bash
8484
sudo VPN_DNS_SRV1=1.1.1.1 VPN_DNS_SRV2=1.0.0.1 ikev2.sh --auto
8585
```
8686

87-
By default, no password is required when importing IKEv2 client configuration. You may optionally choose to protect client config files using a random password. Example:
87+
By default, no password is required when importing IKEv2 client configuration. You can choose to protect client config files using a random password. Example:
8888

8989
```bash
9090
sudo VPN_PROTECT_CONFIG=yes ikev2.sh --auto
@@ -921,6 +921,8 @@ If you want to remove IKEv2 from the VPN server, but keep the [IPsec/L2TP](clien
921921
sudo ikev2.sh --removeikev2
922922
```
923923
924+
After removing IKEv2, if you want to set it up again, refer to [this section](#set-up-ikev2-using-helper-script).
925+
924926
<details>
925927
<summary>
926928
Alternatively, you can manually remove IKEv2. Click here for instructions.

0 commit comments

Comments
 (0)