mirror of
https://github.com/hwdsl2/wireguard-install.git
synced 2024-06-30 06:15:38 +02:00
Update docs
This commit is contained in:
parent
3572d2812e
commit
1541927625
31
README-zh.md
31
README-zh.md
|
@ -8,23 +8,19 @@
|
|||
|
||||
该脚本可让你在几分钟内建立自己的 VPN 服务器,即使你以前没有使用过 WireGuard。[WireGuard](https://www.wireguard.com) 是一种快速且现代的 VPN,其设计目标是易于使用和高性能。
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
查看脚本的示例输出(终端记录)。
|
||||
</summary>
|
||||
|
||||
**注:** 此终端记录仅用于演示目的。该记录中的 VPN 凭据 **无效**。
|
||||
|
||||
<p align="center"><img src="docs/images/demo1.svg"></p>
|
||||
</details>
|
||||
|
||||
[**» 另见:OpenVPN 服务器一键安装脚本**](https://github.com/hwdsl2/openvpn-install/blob/master/README-zh.md)
|
||||
|
||||
## 功能特性
|
||||
|
||||
- 全自动的 WireGuard VPN 服务器配置,无需用户输入
|
||||
- 支持使用自定义选项进行交互式安装
|
||||
- 生成 VPN 配置文件以自动配置 Windows, macOS, iOS 和 Android 设备
|
||||
- 支持管理 WireGuard VPN 用户
|
||||
- 优化 `sysctl` 设置以提高 VPN 性能
|
||||
|
||||
## 安装说明
|
||||
|
||||
在你的 Linux 服务器\* 上运行脚本,并按提示操作。
|
||||
|
||||
首先下载脚本:
|
||||
首先在你的 Linux 服务器\* 上下载脚本:
|
||||
|
||||
```bash
|
||||
wget -O wireguard.sh https://get.vpnsetup.net/wg
|
||||
|
@ -47,6 +43,15 @@ sudo bash wireguard.sh --auto
|
|||
客户端 DNS: Google Public DNS
|
||||
```
|
||||
</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 端口 51820。
|
||||
|
||||
|
|
33
README.md
33
README.md
|
@ -8,23 +8,19 @@ WireGuard VPN server installer for Ubuntu, Debian, AlmaLinux, Rocky Linux, CentO
|
|||
|
||||
This script will let you set up your own VPN server in just a few minutes, even if you haven't used WireGuard before. [WireGuard](https://www.wireguard.com) is a fast and modern VPN designed with the goals of ease of use and high performance.
|
||||
|
||||
<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>
|
||||
|
||||
[**» See also: OpenVPN Server Auto Setup Script**](https://github.com/hwdsl2/openvpn-install)
|
||||
|
||||
## Features
|
||||
|
||||
- Fully automated WireGuard VPN 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 WireGuard VPN users
|
||||
- Optimizes `sysctl` settings for improved VPN performance
|
||||
|
||||
## Installation
|
||||
|
||||
Run the script on your Linux server\* and follow the prompts.
|
||||
|
||||
First, download the script:
|
||||
First, download the script on your Linux server\*:
|
||||
|
||||
```bash
|
||||
wget -O wireguard.sh https://get.vpnsetup.net/wg
|
||||
|
@ -47,6 +43,15 @@ Client name: client
|
|||
Client DNS: Google Public DNS
|
||||
```
|
||||
</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 51820 for the VPN.
|
||||
|
||||
|
@ -115,7 +120,7 @@ List of enhancements over Nyr/wireguard-install.
|
|||
- Supports auto install using default options
|
||||
- Supports listing existing 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`
|
||||
|
||||
...and more!
|
||||
|
|
|
@ -7,3 +7,5 @@
|
|||
要添加 VPN 连接,请在你的移动设备上打开 WireGuard 应用程序,单击 "添加" 按钮,然后扫描脚本输出中生成的二维码。
|
||||
|
||||
对于 Windows 和 macOS,首先将生成的 `.conf` 文件安全地传送到你的计算机,然后打开 WireGuard 并导入文件。
|
||||
|
||||
要管理 WireGuard VPN 用户,请再次运行安装脚本:`sudo bash wireguard.sh`
|
||||
|
|
|
@ -7,3 +7,5 @@
|
|||
To add a VPN connection, open the WireGuard App on your mobile device, tap the "Add" button, then scan the generated QR code in the script output.
|
||||
|
||||
For Windows and macOS, first securely transfer the generated `.conf` file to your computer, then open WireGuard and import the file.
|
||||
|
||||
To manage WireGuard VPN users, run the install script again: `sudo bash wireguard.sh`
|
||||
|
|
Loading…
Reference in New Issue
Block a user