1
1
mirror of https://github.com/angristan/wireguard-install.git synced 2024-11-10 23:31:07 +00:00
wireguard-install/README.md
Vladislav Plikin 80e84cfd79 Some improvements:
- Kali Linux support
- Removed resolvconf installation
- Automatic PersistentKeepalive
- Config file output right after client creation under QR code
- Changed y/n  to yes/no to avoid accidental press
- Added confirmation for client removing
- Replaced way to detect machine IPv4/6
- Updated permissions for whole /etc/wireguard from 644 to 600
- Added IPv6 random generation

Used issues/PRs:
https://github.com/angristan/wireguard-install/issues/474
https://github.com/angristan/wireguard-install/issues/430
https://github.com/angristan/wireguard-install/pull/482 by bushwhackr
https://github.com/angristan/wireguard-install/pull/457 by dikeckaan
https://github.com/angristan/wireguard-install/pull/456 by turekt
2023-11-11 17:27:46 +03:00

37 lines
1.5 KiB
Markdown

# WireGuard installer
**This project is a bash script that aims to setup a [WireGuard](https://www.wireguard.com/) 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](https://github.com/angristan/wireguard-install/issues) for ongoing development, bugs and planned features! You might also want to check the [discussions](https://github.com/angristan/wireguard-install/discussions) for help.
WireGuard does not fit your environment? For example, you can't use UDP, only TCP? Check out [openvpn-install](https://github.com/angristan/openvpn-install).
## Requirements
Supported distributions:
- AlmaLinux >= 8
- Arch Linux
- CentOS Stream >= 8
- Debian >= 10
- Fedora >= 32
- Oracle Linux
- Rocky Linux >= 8
- Ubuntu >= 18.04
## Usage
Download and execute the script. Answer the questions asked by the script and it will take care of the rest.
```bash
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!