Update docs

This commit is contained in:
hwdsl2
2022-10-14 22:07:21 -05:00
parent 45b9732428
commit ccac14693c
4 changed files with 41 additions and 27 deletions

View File

@@ -8,23 +8,19 @@
该脚本可让你在几分钟内建立自己的 VPN 服务器,即使你以前没有使用过 OpenVPN。[OpenVPN](https://openvpn.net/community-resources/reference-manual-for-openvpn-2-4/) 是一种开源、强大且高度灵活的 VPN 协议。 该脚本可让你在几分钟内建立自己的 VPN 服务器,即使你以前没有使用过 OpenVPN。[OpenVPN](https://openvpn.net/community-resources/reference-manual-for-openvpn-2-4/) 是一种开源、强大且高度灵活的 VPN 协议。
<details>
<summary>
查看脚本的示例输出(终端记录)。
</summary>
**注:** 此终端记录仅用于演示目的。该记录中的 VPN 凭据 **无效**
<p align="center"><img src="docs/images/demo1.svg"></p>
</details>
[**&raquo; 另见WireGuard VPN 服务器一键安装脚本**](https://github.com/hwdsl2/wireguard-install/blob/master/README-zh.md) [**&raquo; 另见WireGuard VPN 服务器一键安装脚本**](https://github.com/hwdsl2/wireguard-install/blob/master/README-zh.md)
## 功能特性
- 全自动的 OpenVPN 服务器配置,无需用户输入
- 支持使用自定义选项进行交互式安装
- 生成 VPN 配置文件以自动配置 Windows, macOS, iOS 和 Android 设备
- 支持管理 OpenVPN 用户和证书
- 优化 `sysctl` 设置以提高 VPN 性能
## 安装说明 ## 安装说明
在你的 Linux 服务器\* 上运行脚本,并按提示操作。 首先在你的 Linux 服务器\* 上下载脚本:
首先下载脚本:
```bash ```bash
wget -O openvpn.sh https://get.vpnsetup.net/ovpn wget -O openvpn.sh https://get.vpnsetup.net/ovpn
@@ -48,6 +44,15 @@ sudo bash openvpn.sh --auto
客户端 DNS: Google Public DNS 客户端 DNS: Google Public DNS
``` ```
</details> </details>
<details>
<summary>
查看脚本的示例输出(终端记录)。
</summary>
**注:** 此终端记录仅用于演示目的。该记录中的 VPN 凭据 **无效**
<p align="center"><img src="docs/images/demo1.svg"></p>
</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。 对于有外部防火墙的服务器(比如 [EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html)/[GCE](https://cloud.google.com/vpc/docs/firewalls)),请为 VPN 打开 UDP 端口 1194。

View File

@@ -8,23 +8,19 @@ OpenVPN server installer for Ubuntu, Debian, AlmaLinux, Rocky Linux, CentOS, Fed
This script will let you set up your own VPN server in just a few minutes, even if you haven't used OpenVPN before. [OpenVPN](https://openvpn.net/community-resources/reference-manual-for-openvpn-2-4/) is an open-source, robust and highly flexible VPN protocol. This script will let you set up your own VPN server in just a few minutes, even if you haven't used OpenVPN before. [OpenVPN](https://openvpn.net/community-resources/reference-manual-for-openvpn-2-4/) is an open-source, robust and highly flexible VPN protocol.
<details>
<summary>
See the 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/demo1.svg"></p>
</details>
[**&raquo; See also: WireGuard VPN Server Auto Setup Script**](https://github.com/hwdsl2/wireguard-install) [**&raquo; See also: WireGuard VPN Server Auto Setup Script**](https://github.com/hwdsl2/wireguard-install)
## Features
- Fully automated OpenVPN server setup, no user input needed
- Supports interactive install using custom options
- Generates VPN profiles to auto-configure Windows, macOS, iOS and Android devices
- Supports managing OpenVPN users and certificates
- Optimizes `sysctl` settings for improved VPN performance
## Installation ## Installation
Run the script on your Linux server\* and follow the prompts. First, download the script on your Linux server\*:
First, download the script:
```bash ```bash
wget -O openvpn.sh https://get.vpnsetup.net/ovpn wget -O openvpn.sh https://get.vpnsetup.net/ovpn
@@ -48,6 +44,15 @@ Client name: client
Client DNS: Google Public DNS Client DNS: Google Public DNS
``` ```
</details> </details>
<details>
<summary>
See the 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/demo1.svg"></p>
</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. 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.
@@ -118,7 +123,7 @@ List of enhancements over Nyr/openvpn-install.
- Supports exporting configuration for an existing VPN client - Supports exporting configuration for an existing VPN client
- Supports listing existing VPN clients - Supports listing existing VPN clients
- Supports custom DNS server(s) for VPN clients - Supports custom DNS server(s) for VPN clients
- Optimized `sysctl` settings for improved VPN performance - Optimizes `sysctl` settings for improved VPN performance
- Improved creation of client config files when using `sudo` - Improved creation of client config files when using `sudo`
...and more! ...and more!

View File

@@ -7,3 +7,5 @@
要添加 VPN 连接,首先将生成的 `.ovpn` 文件安全地传送到你的设备,然后打开 OpenVPN 应用程序并导入 VPN 配置文件。 要添加 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 设置的信息。 iOS (iPhone & iPad) 用户可以参考 [此常见问题页面](https://openvpn.net/faq/what-is-the-meaning-of-the-various-openvpn-settings-in-the-ios-settings-app/) 以了解有关 OpenVPN 设置的信息。
要管理 OpenVPN 用户,请再次运行安装脚本:`sudo bash openvpn.sh`

View File

@@ -7,3 +7,5 @@
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. 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. 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.
To manage OpenVPN users, run the install script again: `sudo bash openvpn.sh`