wireguard-install README

The project's README from github.com/angristan/wireguard-install. As one markdown file: README.md.

WireGuard installer

Lint Say Thanks!

This project is a bash script that aims to setup a WireGuard VPN on a Linux server, as easily as possible!

WireGuard is a point-to-point VPN that can be used in different ways. Here, we mean a VPN as in: the client will forward all its traffic through an encrypted tunnel to the server. The server will apply NAT to the client's traffic so it will appear as if the client is browsing the web with the server's IP.

The script supports both IPv4 and IPv6. Please check the issues for ongoing development, bugs and planned features! You might also want to check the discussions for help.

WireGuard does not fit your environment? Check out openvpn-install.

Requirements

Supported distributions:

Usage

Download and execute the script. Answer the questions asked by the script and it will take care of the rest.

curl -O https://raw.githubusercontent.com/angristan/wireguard-install/master/wireguard-install.sh
chmod +x wireguard-install.sh
./wireguard-install.sh

It will install WireGuard (kernel module and tools) on the server, configure it, create a systemd service and a client configuration file.

Run the script again to add or remove clients!

Providers

I recommend these cheap cloud providers for your VPN server:

Contributing

Contributions are welcome! Here's how you can help:

Discuss changes

Please open an issue before submitting a PR if you want to discuss a change, especially if it's a big one.

Code formatting

We use shellcheck and shfmt to enforce bash styling guidelines and good practices. They are executed for each commit / PR with GitHub Actions, so you can check the configuration here.

Say thanks

You can say thanks if you want!

Credits & Licence

This project is under the MIT Licence

Star History

Star History Chart

wireguard-install (angristan/wireguard-install)

Searching Database…

11.4K ·GitHub
Wireguard-install
这是什么？一个 bash 脚本，用于在 Linux 服务器上搭建 WireGuard VPN，把你的所有流量通过加密隧道转发，并进行 NAT 转换，使你的访问看起来是使用服务器的 IP。
这是服务端应用还是客户端应用？这是一个服务端安装脚本：它负责配置 VPN 服务器，并另外生成一个客户端配置文件，你可以将其导入任意 WireGuard 客户端应用。
我该怎么让它运行起来？下载并执行脚本，然后回答它提出的设置问题；再次运行脚本可以添加或删除客户端。
运行这个需要什么样的服务器？只需要一个受支持的 Linux 发行版：AlmaLinux 8+、Alpine、Arch、CentOS Stream 8+、Debian 10+、Fedora 32+、Oracle Linux、Rocky Linux 8+ 或 Ubuntu 18.04+。
如果 WireGuard 不适合我的环境怎么办？作者推荐了姊妹项目 openvpn-install，适用于 WireGuard 不太合适的情况。
运行这个需要租用 VPS 吗？需要，你要在自己的 Linux 服务器上运行它；README 推荐 Vultr、Hetzner、Digital Ocean 等廉价 VPS 服务商，价格约为每月 4-5 美元起。
它同时支持 IPv6 和 IPv4 吗？支持，该脚本同时支持 IPv4 和 IPv6。
我的流量真的会隐藏在服务器的 IP 后面吗？会的，服务器会对客户端流量应用 NAT，因此客户端看起来是使用服务器的 IP 在访问网络。
一台服务器能管理多个客户端吗？可以，随时重新运行脚本即可添加或删除客户端配置。
有图形界面吗？没有，它是一个命令行 bash 脚本，所有设置都通过在终端中回答交互式提示完成。
它会自动帮我设置 systemd 服务吗？会的，脚本会自动为 WireGuard 创建并管理一个 systemd 服务。
What are similar projects?openvpn-install, openvpn-install, wireguard-install, SoftEtherVPN, streisand, rathole, p2wlan, setup-ipsec-vpn
Which topics is it in?nat, wireguard-vpn, vpn-server, wireguard, vps, homelab, infrastructure, vpn, sysadmin, encryption, shell, networking
Creator
angristan
Size
0.2 MB
Stars
11.4K
Updated
CommitDec 25
Age
7y
Commits · 90 Days