1
0
mirror of synced 2024-11-28 23:56:04 +03:00

Update docs

This commit is contained in:
hwdsl2 2022-05-18 08:56:49 -05:00
parent 18089a3089
commit 6d6ed6916e
2 changed files with 70 additions and 70 deletions

View File

@ -43,35 +43,35 @@ curl -fsSL https://gitlab.com/hwdsl2/setup-ipsec-vpn/-/raw/master/vpnsetup.sh -o
</details>
<details>
<summary>
查看 VPN 脚本的示例输出(终端记录)。
</summary>
**注:** 此终端记录仅用于演示目的。该记录中的 VPN 凭据 **无效**
<p align="center"><img src="docs/images/script-demo.svg"></p>
</details>
<details>
<summary>
可选IPsec VPN + OpenVPN + WireGuard 服务器。
</summary>
成功安装 IPsec VPN 后,高级用户可以选择在同一台服务器上安装 [OpenVPN](https://openvpn.net) 和/或 [WireGuard](https://www.wireguard.com)。这是可选的。为确保兼容性,必须先安装 IPsec VPN。
要安装 OpenVPN ([Nyr/openvpn-install](https://github.com/Nyr/openvpn-install)):
要安装 OpenVPN:
```bash
wget https://get.vpnsetup.net/ovpn -nv -O openvpn.sh
sudo bash openvpn.sh
```
要安装 WireGuard ([Nyr/wireguard-install](https://github.com/Nyr/wireguard-install))
要安装 WireGuard
```bash
wget https://get.vpnsetup.net/wg -nv -O wireguard.sh
sudo bash wireguard.sh
```
这些脚本的任何问题都应该在上面链接的 GitHub 代码库中报告,而不是这里。
这些脚本分别来自 [Nyr/openvpn-install](https://github.com/Nyr/openvpn-install) 和 [Nyr/wireguard-install](https://github.com/Nyr/wireguard-install)。任何相关问题都应该在链接的 GitHub 代码库中报告,而不是这里。
</details>
<details>
<summary>
查看 VPN 脚本的示例输出(终端记录)。
</summary>
**注:** 此终端记录仅用于演示目的。该记录中的 VPN 凭据 **无效**
<p align="center"><img src="docs/images/script-demo.svg"></p>
</details>
另外,你也可以使用预构建的 [Docker 镜像](https://github.com/hwdsl2/docker-ipsec-vpn-server/blob/master/README-zh.md)。如需了解其它选项以及客户端配置,请继续阅读以下部分。
@ -180,6 +180,29 @@ sudo VPN_PROTECT_CONFIG=yes sh vpn.sh
</details>
<details>
<summary>
可选IPsec VPN + OpenVPN + WireGuard 服务器。
</summary>
成功安装 IPsec VPN 后,高级用户可以选择在同一台服务器上安装 [OpenVPN](https://openvpn.net) 和/或 [WireGuard](https://www.wireguard.com)。这是可选的。为确保兼容性,必须先安装 IPsec VPN。
要安装 OpenVPN:
```bash
wget https://get.vpnsetup.net/ovpn -nv -O openvpn.sh
sudo bash openvpn.sh
```
要安装 WireGuard
```bash
wget https://get.vpnsetup.net/wg -nv -O wireguard.sh
sudo bash wireguard.sh
```
这些脚本分别来自 [Nyr/openvpn-install](https://github.com/Nyr/openvpn-install) 和 [Nyr/wireguard-install](https://github.com/Nyr/wireguard-install)。任何相关问题都应该在链接的 GitHub 代码库中报告,而不是这里。
</details>
<details>
<summary>
如果无法下载,请点这里。
</summary>
@ -199,29 +222,6 @@ sudo sh vpn.sh
如果无法下载,打开 [vpnsetup.sh](vpnsetup.sh),然后点击右边的 `Raw` 按钮。按快捷键 `Ctrl/Cmd+A` 全选,`Ctrl/Cmd+C` 复制,然后粘贴到你喜欢的编辑器。
</details>
<details>
<summary>
可选IPsec VPN + OpenVPN + WireGuard 服务器。
</summary>
成功安装 IPsec VPN 后,高级用户可以选择在同一台服务器上安装 [OpenVPN](https://openvpn.net) 和/或 [WireGuard](https://www.wireguard.com)。这是可选的。为确保兼容性,必须先安装 IPsec VPN。
要安装 OpenVPN ([Nyr/openvpn-install](https://github.com/Nyr/openvpn-install)):
```bash
wget https://get.vpnsetup.net/ovpn -nv -O openvpn.sh
sudo bash openvpn.sh
```
要安装 WireGuard ([Nyr/wireguard-install](https://github.com/Nyr/wireguard-install))
```bash
wget https://get.vpnsetup.net/wg -nv -O wireguard.sh
sudo bash wireguard.sh
```
这些脚本的任何问题都应该在上面链接的 GitHub 代码库中报告,而不是这里。
</details>
## 下一步

View File

@ -43,35 +43,35 @@ If you are unable to download, open [vpnsetup.sh](vpnsetup.sh), then click the `
</details>
<details>
<summary>
See the VPN script in action (terminal recording).
</summary>
**Note:** This recording is for demo purposes only. VPN credentials in this recording are **NOT** valid.
<p align="center"><img src="docs/images/script-demo.svg"></p>
</details>
<details>
<summary>
Optional: IPsec VPN + OpenVPN + WireGuard server.
</summary>
After successful installation of the IPsec VPN, advanced users can optionally install [OpenVPN](https://openvpn.net) and/or [WireGuard](https://www.wireguard.com) on the same server. To ensure compatibility, the IPsec VPN must be installed first.
To install OpenVPN ([Nyr/openvpn-install](https://github.com/Nyr/openvpn-install)):
To install OpenVPN:
```bash
wget https://get.vpnsetup.net/ovpn -nv -O openvpn.sh
sudo bash openvpn.sh
```
To install WireGuard ([Nyr/wireguard-install](https://github.com/Nyr/wireguard-install)):
To install WireGuard:
```bash
wget https://get.vpnsetup.net/wg -nv -O wireguard.sh
sudo bash wireguard.sh
```
Report any issues with these scripts in the linked GitHub repos above, not in this repo.
These scripts are from [Nyr/openvpn-install](https://github.com/Nyr/openvpn-install) and [Nyr/wireguard-install](https://github.com/Nyr/wireguard-install), respectively. Report any related issues to the linked GitHub repos, not here.
</details>
<details>
<summary>
See the VPN script in action (terminal recording).
</summary>
**Note:** This recording is for demo purposes only. VPN credentials in this recording are **NOT** valid.
<p align="center"><img src="docs/images/script-demo.svg"></p>
</details>
A pre-built [Docker image](https://github.com/hwdsl2/docker-ipsec-vpn-server) is also available. For other options and client setup, read the sections below.
@ -180,6 +180,29 @@ sudo VPN_PROTECT_CONFIG=yes sh vpn.sh
</details>
<details>
<summary>
Optional: IPsec VPN + OpenVPN + WireGuard server.
</summary>
After successful installation of the IPsec VPN, advanced users can optionally install [OpenVPN](https://openvpn.net) and/or [WireGuard](https://www.wireguard.com) on the same server. To ensure compatibility, the IPsec VPN must be installed first.
To install OpenVPN:
```bash
wget https://get.vpnsetup.net/ovpn -nv -O openvpn.sh
sudo bash openvpn.sh
```
To install WireGuard:
```bash
wget https://get.vpnsetup.net/wg -nv -O wireguard.sh
sudo bash wireguard.sh
```
These scripts are from [Nyr/openvpn-install](https://github.com/Nyr/openvpn-install) and [Nyr/wireguard-install](https://github.com/Nyr/wireguard-install), respectively. Report any related issues to the linked GitHub repos, not here.
</details>
<details>
<summary>
Click here if you are unable to download.
</summary>
@ -199,29 +222,6 @@ sudo sh vpn.sh
If you are unable to download, open [vpnsetup.sh](vpnsetup.sh), then click the `Raw` button on the right. Press `Ctrl/Cmd+A` to select all, `Ctrl/Cmd+C` to copy, then paste into your favorite editor.
</details>
<details>
<summary>
Optional: IPsec VPN + OpenVPN + WireGuard server.
</summary>
After successful installation of the IPsec VPN, advanced users can optionally install [OpenVPN](https://openvpn.net) and/or [WireGuard](https://www.wireguard.com) on the same server. To ensure compatibility, the IPsec VPN must be installed first.
To install OpenVPN ([Nyr/openvpn-install](https://github.com/Nyr/openvpn-install)):
```bash
wget https://get.vpnsetup.net/ovpn -nv -O openvpn.sh
sudo bash openvpn.sh
```
To install WireGuard ([Nyr/wireguard-install](https://github.com/Nyr/wireguard-install)):
```bash
wget https://get.vpnsetup.net/wg -nv -O wireguard.sh
sudo bash wireguard.sh
```
Report any issues with these scripts in the linked GitHub repos above, not in this repo.
</details>
## Next steps