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…

Что это такое?Bash-скрипт, который настраивает VPN на основе WireGuard на Linux-сервере: весь ваш трафик направляется через зашифрованный туннель и маскируется через 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 рекомендуются недорогие VPS-провайдеры, такие как Vultr, Hetzner или Digital Ocean, с ценой примерно от $4–5 в месяц.
Поддерживается ли IPv6, а не только IPv4?Да, скрипт поддерживает как IPv4, так и IPv6.
Мой трафик действительно скрывается за IP-адресом сервера?Да, сервер применяет NAT к трафику клиента, поэтому при просмотре сайтов клиент выглядит так, будто использует IP-адрес сервера.
Можно ли управлять несколькими клиентами с одним сервером?Да, повторный запуск скрипта позволяет в любое время добавлять или удалять конфигурации клиентов.
Есть ли для этого графический интерфейс?Нет, это консольный bash-скрипт; вся настройка выполняется через ответы на интерактивные вопросы в терминале.
Настраивает ли он за меня службу systemd?Да, скрипт автоматически создаёт и управляет службой systemd для WireGuard.
Creator
angristan
Size
0.2 MB
Stars
11.4K
Updated
CommitDec 25
Age
7y
Commits · 90 Days