Marown/setup-ipsec-vpn
1
0
Fork 0
mirror of https://github.com/hwdsl2/setup-ipsec-vpn.git synced 2024-06-20 12:46:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
hwdsl2 2022-10-14 23:35:22 -05:00
parent ad2883fa74
commit 0d4934c439
6 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README-zh.md
View File

@ -226,18 +226,18 @@ sudo ikev2.sh
| VPN 用户名 | vpnuser | VPN_USER |
| VPN 密码 |自动生成 | VPN_PASSWORD |
|客户端的 DNS 服务器 |Google Public DNS | VPN_DNS_SRV1, VPN_DNS_SRV2 |
|跳过 IKEv2 安装 |否 | VPN_SKIP_IKEV2=yes |
|跳过 IKEv2 安装 |no | VPN_SKIP_IKEV2=yes |
\* 这些 IKEv1 参数适用于 IPsec/L2TP 和 IPsec/XAuth ("Cisco IPsec") 模式。
\*\* 在运行 vpn(setup).sh 时将这些定义为环境变量。
| IKEv2 参数\* |默认值 |自定义（环境变量）\*\* |自定义（安装时）\*\*\* |
| IKEv2 参数\* |默认值 |自定义（环境变量）\*\* |自定义（交互式）\*\*\* |
| ----------- | ---- | ------------------ | ----------------- |
|服务器地址（DNS域名）| - | VPN_DNS_NAME | ✅ |
|服务器地址（公网IP）|自动检测 | VPN_PUBLIC_IP | ✅ |
|第一个客户端的名称 | vpnclient | VPN_CLIENT_NAME | ✅ |
|客户端的 DNS 服务器 |Google Public DNS | VPN_DNS_SRV1, VPN_DNS_SRV2 | ✅ |
|保护客户端配置文件 |否 | VPN_PROTECT_CONFIG=yes | ✅ |
|保护客户端配置文件 |no | VPN_PROTECT_CONFIG=yes | ✅ |
|启用/禁用 MOBIKE |如果系统支持则启用 | ❌ | ✅ |
|客户端证书有效期 | 10 年（120 个月）| ❌ | ✅ |
| CA 和服务器证书有效期 | 10 年（120 个月）| ❌ | ❌ |
@ -355,7 +355,7 @@ https://gitlab.com/hwdsl2/setup-ipsec-vpn/-/raw/master/extras/vpnupgrade.sh
**警告：** 此辅助脚本将从你的服务器中删除 IPsec VPN。所有的 VPN 配置将被**永久删除**，并且 Libreswan 和 xl2tpd 将被移除。此操作**不可撤销**！
```bash
wget https://get.vpnsetup.net/unst -O vpnunst.sh && sudo bash vpnunst.sh
wget https://get.vpnsetup.net/unst -O unst.sh && sudo bash unst.sh
```
<details>
@ -366,7 +366,7 @@ wget https://get.vpnsetup.net/unst -O vpnunst.sh && sudo bash vpnunst.sh
你也可以使用 `curl` 下载：
```bash
curl -fsSL https://get.vpnsetup.net/unst -o vpnunst.sh && sudo bash vpnunst.sh
curl -fsSL https://get.vpnsetup.net/unst -o unst.sh && sudo bash unst.sh
```
或者，你也可以使用这些链接：

30
README.md
View File

@ -226,23 +226,23 @@ For reference: List of IKEv1 and IKEv2 parameters.
| VPN username | vpnuser | VPN_USER |
| VPN password | Auto generate | VPN_PASSWORD |
| DNS servers for clients | Google Public DNS | VPN_DNS_SRV1, VPN_DNS_SRV2 |
| Skip IKEv2 setup | No | VPN_SKIP_IKEV2=yes |
| Skip IKEv2 setup | no | VPN_SKIP_IKEV2=yes |
\* These IKEv1 parameters are for IPsec/L2TP and IPsec/XAuth ("Cisco IPsec") modes.
\*\* Define these as environment variables when running vpn(setup).sh.
| IKEv2 parameter\* | Default value | Customize (env variable)\*\* | Customize (setup)\*\*\* |
| --------------------------- | --------------------- | ---------------------------- | ----------------------- |
| Server address (DNS name) | - | VPN_DNS_NAME | ✅ |
| Server address (public IP) | Auto detect | VPN_PUBLIC_IP | ✅ |
| Name of first client | vpnclient | VPN_CLIENT_NAME | ✅ |
| DNS servers for clients | Google Public DNS | VPN_DNS_SRV1, VPN_DNS_SRV2 | ✅ |
| Protect client config files | No | VPN_PROTECT_CONFIG=yes | ✅ |
| Enable/Disable MOBIKE | Enable if supported | ❌ | ✅ |
| Client cert validity | 10 years (120 months) | ❌ | ✅ |
| CA & server cert validity | 10 years (120 months) | ❌ | ❌ |
| CA certificate name | IKEv2 VPN CA | ❌ | ❌ |
| Certificate key size | 3072 bits | ❌ | ❌ |
| IKEv2 parameter\* | Default value | Customize (env variable)\*\* | Customize (interactive)\*\*\* |
| --------------------------- | --------------------- | ---------------------------- | ----------------------------- |
| Server address (DNS name) | - | VPN_DNS_NAME | ✅ |
| Server address (public IP) | Auto detect | VPN_PUBLIC_IP | ✅ |
| Name of first client | vpnclient | VPN_CLIENT_NAME | ✅ |
| DNS servers for clients | Google Public DNS | VPN_DNS_SRV1, VPN_DNS_SRV2 | ✅ |
| Protect client config files | no | VPN_PROTECT_CONFIG=yes | ✅ |
| Enable/Disable MOBIKE | Enable if supported | ❌ | ✅ |
| Client cert validity | 10 years (120 months) | ❌ | ✅ |
| CA & server cert validity | 10 years (120 months) | ❌ | ❌ |
| CA certificate name | IKEv2 VPN CA | ❌ | ❌ |
| Certificate key size | 3072 bits | ❌ | ❌ |
\* These IKEv2 parameters are for IKEv2 mode.
\*\* Define these as environment variables when running vpn(setup).sh, or when setting up IKEv2 in auto mode (`sudo ikev2.sh --auto`).
@ -355,7 +355,7 @@ To uninstall IPsec VPN, run the [helper script](extras/vpnuninstall.sh):
**Warning:** This helper script will remove IPsec VPN from your server. All VPN configuration will be **permanently deleted**, and Libreswan and xl2tpd will be removed. This **cannot be undone**!
```bash
wget https://get.vpnsetup.net/unst -O vpnunst.sh && sudo bash vpnunst.sh
wget https://get.vpnsetup.net/unst -O unst.sh && sudo bash unst.sh
```
<details>
@ -366,7 +366,7 @@ Alternative commands.
You may also use `curl` to download:
```bash
curl -fsSL https://get.vpnsetup.net/unst -o vpnunst.sh && sudo bash vpnunst.sh
curl -fsSL https://get.vpnsetup.net/unst -o unst.sh && sudo bash unst.sh
```
Alternative script URLs:

8
docs/manage-users-zh.md
View File

@ -90,7 +90,7 @@ sudo delvpnuser.sh '要删除的用户名'
首先下载[辅助脚本](../extras/update_vpn_users.sh)：
```bash
wget https://get.vpnsetup.net/updateusers -O updatevpnusers.sh
wget https://get.vpnsetup.net/updateusers -O updateusers.sh
```
**重要：** 这个脚本会将你当前 **所有的 VPN 用户** 移除并替换为你指定的列表中的用户。如果你需要保留已有的 VPN 用户，则必须将它们包含在下面的变量中。
@ -100,9 +100,9 @@ wget https://get.vpnsetup.net/updateusers -O updatevpnusers.sh
**选项 1:** 编辑脚本并输入 VPN 用户信息：
```bash
nano -w updatevpnusers.sh
nano -w updateusers.sh
[替换为你自己的值： YOUR_USERNAMES 和 YOUR_PASSWORDS]
sudo bash updatevpnusers.sh
sudo bash updateusers.sh
```
**选项 2:** 将 VPN 用户信息定义为环境变量：
@ -114,7 +114,7 @@ sudo bash updatevpnusers.sh
sudo \
VPN_USERS='用户名1 用户名2 ...' \
VPN_PASSWORDS='密码1 密码2 ...' \
bash updatevpnusers.sh
bash updateusers.sh
```
## 查看 VPN 用户

8
docs/manage-users.md
View File

@ -90,7 +90,7 @@ Remove **all existing VPN users** and replace with the list of users you specify
First, download the [helper script](../extras/update_vpn_users.sh):
```bash
wget https://get.vpnsetup.net/updateusers -O updatevpnusers.sh
wget https://get.vpnsetup.net/updateusers -O updateusers.sh
```
**Important:** This script will remove **all existing VPN users** and replace with the list of users you specify. Therefore, you must include any existing user(s) you want to keep in the variables below.
@ -100,9 +100,9 @@ To use this script, choose one of the following options:
**Option 1:** Edit the script and enter VPN user details:
```bash
nano -w updatevpnusers.sh
nano -w updateusers.sh
[Replace with your own values: YOUR_USERNAMES and YOUR_PASSWORDS]
sudo bash updatevpnusers.sh
sudo bash updateusers.sh
```
**Option 2:** Define VPN user details as environment variables:
@ -114,7 +114,7 @@ sudo bash updatevpnusers.sh
sudo \
VPN_USERS='username1 username2 ...' \
VPN_PASSWORDS='password1 password2 ...' \
bash updatevpnusers.sh
bash updateusers.sh
```
## View VPN users

4
docs/uninstall-zh.md
View File

@ -12,7 +12,7 @@
**警告：** 此辅助脚本将从你的服务器中删除 IPsec VPN。所有的 VPN 配置将被**永久删除**，并且 Libreswan 和 xl2tpd 将被移除。此操作**不可撤销**！
```bash
wget https://get.vpnsetup.net/unst -O vpnunst.sh && sudo bash vpnunst.sh
wget https://get.vpnsetup.net/unst -O unst.sh && sudo bash unst.sh
```
<details>
@ -23,7 +23,7 @@ wget https://get.vpnsetup.net/unst -O vpnunst.sh && sudo bash vpnunst.sh
你也可以使用 `curl` 下载：
```bash
curl -fsSL https://get.vpnsetup.net/unst -o vpnunst.sh && sudo bash vpnunst.sh
curl -fsSL https://get.vpnsetup.net/unst -o unst.sh && sudo bash unst.sh
```
或者，你也可以使用这些链接：

4
docs/uninstall.md
View File

@ -12,7 +12,7 @@ To uninstall IPsec VPN, run the [helper script](../extras/vpnuninstall.sh):
**Warning:** This helper script will remove IPsec VPN from your server. All VPN configuration will be **permanently deleted**, and Libreswan and xl2tpd will be removed. This **cannot be undone**!
```bash
wget https://get.vpnsetup.net/unst -O vpnunst.sh && sudo bash vpnunst.sh
wget https://get.vpnsetup.net/unst -O unst.sh && sudo bash unst.sh
```
<details>
@ -23,7 +23,7 @@ Alternative commands.
You may also use `curl` to download:
```bash
curl -fsSL https://get.vpnsetup.net/unst -o vpnunst.sh && sudo bash vpnunst.sh
curl -fsSL https://get.vpnsetup.net/unst -o unst.sh && sudo bash unst.sh
```
Alternative script URLs: