Update docs

This commit is contained in:
hwdsl2
2022-10-02 23:18:07 -05:00
parent 20e9a5af75
commit 32a3c5bf06
4 changed files with 60 additions and 8 deletions

View File

@@ -17,14 +17,29 @@
**选项 1:** 使用默认选项自动安装 OpenVPN。 **选项 1:** 使用默认选项自动安装 OpenVPN。
```bash ```bash
wget https://get.vpnsetup.net/ovpn -O openvpn.sh wget -O openvpn.sh https://get.vpnsetup.net/ovpn
sudo bash openvpn.sh --auto sudo bash openvpn.sh --auto
``` ```
<details>
<summary>
默认选项列表。
</summary>
```
网络协议: UDP
端口: UDP/1194
客户端名称: client
客户端 DNS: Google Public DNS
```
</details>
对于有外部防火墙的服务器(比如 [EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html)/[GCE](https://cloud.google.com/vpc/docs/firewalls)),请为 VPN 打开 UDP 端口 1194。
**选项 2:** 使用自定义选项进行交互式安装。 **选项 2:** 使用自定义选项进行交互式安装。
```bash ```bash
wget https://get.vpnsetup.net/ovpn -O openvpn.sh wget -O openvpn.sh https://get.vpnsetup.net/ovpn
sudo bash openvpn.sh sudo bash openvpn.sh
``` ```
@@ -37,7 +52,7 @@ sudo bash openvpn.sh
```bash ```bash
# 下载脚本 # 下载脚本
curl -fL https://get.vpnsetup.net/ovpn -o openvpn.sh curl -fL -o openvpn.sh https://get.vpnsetup.net/ovpn
# 选项 1: 使用默认选项自动安装 OpenVPN # 选项 1: 使用默认选项自动安装 OpenVPN
sudo bash openvpn.sh --auto sudo bash openvpn.sh --auto
# 选项 2: 使用自定义选项进行交互式安装 # 选项 2: 使用自定义选项进行交互式安装
@@ -60,7 +75,9 @@ https://gitlab.com/hwdsl2/openvpn-install/-/raw/master/openvpn-install.sh
安装完成后,你可以再次运行脚本来管理用户或者卸载 OpenVPN。 安装完成后,你可以再次运行脚本来管理用户或者卸载 OpenVPN。
[OpenVPN 客户端](https://openvpn.net/vpn-client/) 在 Windows, macOS, iOS, Android 和 Linux 上可用。macOS 用户也可以使用 [Tunnelblick](https://tunnelblick.net)。要添加 VPN 连接,首先将生成的 `.ovpn` 文件安全地传送到你的设备,然后打开 OpenVPN 应用程序并导入 VPN 配置文件。 配置你的计算机或其它设备使用 VPN。请参见
**[配置 OpenVPN 客户端](docs/clients-zh.md)**
开始使用自己的专属 VPN! :sparkles::tada::rocket::sparkles: 开始使用自己的专属 VPN! :sparkles::tada::rocket::sparkles:

View File

@@ -17,14 +17,29 @@ Run the script on your Linux server\* and follow the prompts.
**Option 1:** Auto install OpenVPN using default options. **Option 1:** Auto install OpenVPN using default options.
```bash ```bash
wget https://get.vpnsetup.net/ovpn -O openvpn.sh wget -O openvpn.sh https://get.vpnsetup.net/ovpn
sudo bash openvpn.sh --auto sudo bash openvpn.sh --auto
``` ```
<details>
<summary>
List of default options.
</summary>
```
Protocol: UDP
Port: UDP/1194
Client name: client
Client DNS: Google Public DNS
```
</details>
For servers with an external firewall (e.g. [EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html)/[GCE](https://cloud.google.com/vpc/docs/firewalls)), open UDP port 1194 for the VPN.
**Option 2:** Interactive install using custom options. **Option 2:** Interactive install using custom options.
```bash ```bash
wget https://get.vpnsetup.net/ovpn -O openvpn.sh wget -O openvpn.sh https://get.vpnsetup.net/ovpn
sudo bash openvpn.sh sudo bash openvpn.sh
``` ```
@@ -37,7 +52,7 @@ You may also use `curl` to download:
```bash ```bash
# Download the script # Download the script
curl -fL https://get.vpnsetup.net/ovpn -o openvpn.sh curl -fL -o openvpn.sh https://get.vpnsetup.net/ovpn
# Option 1: Auto install OpenVPN using default options # Option 1: Auto install OpenVPN using default options
sudo bash openvpn.sh --auto sudo bash openvpn.sh --auto
# Option 2: Interactive install using custom options # Option 2: Interactive install using custom options
@@ -60,7 +75,9 @@ If you are unable to download, open [openvpn-install.sh](openvpn-install.sh), th
After setup, you can run the script again to manage users or uninstall OpenVPN. After setup, you can run the script again to manage users or uninstall OpenVPN.
[OpenVPN clients](https://openvpn.net/vpn-client/) are available for Windows, macOS, iOS, Android and Linux. macOS users can also use [Tunnelblick](https://tunnelblick.net). To add a VPN connection, first securely transfer the generated `.ovpn` file to your device, then open the OpenVPN App and import the VPN profile. Get your computer or device to use the VPN. Please refer to:
**[Configure OpenVPN Clients](docs/clients.md)**
Enjoy your very own VPN! :sparkles::tada::rocket::sparkles: Enjoy your very own VPN! :sparkles::tada::rocket::sparkles:

9
docs/clients-zh.md Normal file
View File

@@ -0,0 +1,9 @@
[English](clients.md) | [中文](clients-zh.md)
# 配置 OpenVPN 客户端
[OpenVPN 客户端](https://openvpn.net/vpn-client/) 在 Windows, macOS, iOS, Android 和 Linux 上可用。macOS 用户也可以使用 [Tunnelblick](https://tunnelblick.net)。
要添加 VPN 连接,首先将生成的 `.ovpn` 文件安全地传送到你的设备,然后打开 OpenVPN 应用程序并导入 VPN 配置文件。
iOS (iPhone & iPad) 用户可以参考 [此常见问题页面](https://openvpn.net/faq/what-is-the-meaning-of-the-various-openvpn-settings-in-the-ios-settings-app/) 以了解有关 OpenVPN 设置的信息。

9
docs/clients.md Normal file
View File

@@ -0,0 +1,9 @@
[English](clients.md) | [中文](clients-zh.md)
# Configure OpenVPN Clients
[OpenVPN clients](https://openvpn.net/vpn-client/) are available for Windows, macOS, iOS, Android and Linux. macOS users can also use [Tunnelblick](https://tunnelblick.net).
To add a VPN connection, first securely transfer the generated `.ovpn` file to your device, then open the OpenVPN App and import the VPN profile.
iOS (iPhone & iPad) users can refer to [this FAQ page](https://openvpn.net/faq/what-is-the-meaning-of-the-various-openvpn-settings-in-the-ios-settings-app/) to learn more about OpenVPN settings.