Contribution and Issues

• Open Issues Tracking: View and address current open issues:

• Contribution Opportunities: Dive into open pull requests and contribute:

Licensing

• Project License: Our work is under the Apache 2.0 License:

✊ Show Your Support

If you've found this project useful, please consider giving it a star and forking it. Your support is greatly appreciated!

🤷 What is VPN?

A Virtual Private Network (VPN) allows users to send and receive data through shared or public networks as if their computing devices were directly connected to the private network. Thus, applications running on an end-system (PC, smartphone, etc.) over a VPN may benefit from individual network features, protection, and management. Encryption is a standard aspect of a VPN connection but not an intrinsic one.

📶 What is WireGuard?

WireGuard is a straightforward yet fast and modern VPN that utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, and more useful than IPsec while avoiding the massive headache. It intends to be considerably more performant than OpenVPN. WireGuard is designed as a general-purpose VPN for running on embedded interfaces and super computers alike, fit for many circumstances. Initially released for the Linux kernel, it is now cross-platform (Windows, macOS, BSD, iOS, Android) and widely deployable. It is currently under a massive development, but it already might be regarded as the most secure, most comfortable to use, and the simplest VPN solution in the industry.

Why WireGuard-Manager?

• Security First: With top-notch encryption and privacy features.
• User-Friendly: Easy to install and manage, regardless of your tech-savviness.
• High Performance: Enjoy fast and reliable connections.
• Open Source: Built and improved by the community.

⛳ Goals

• Robust and modern security as a standard.
• Minimal configuration with essential management tools.
• Optimal performance for both low-latency and high-bandwidth operations.
• Simplified command-line interface for easy integration with system networking.

🌲 Prerequisite

• Supported on a variety of systems including Alma, Alpine, Arch, CentOS, Debian, Fedora, FreeBSD, Kali, Mint, Manjaro, Neon, Oracle, Pop, Raspbian, RHEL, Rocky, Ubuntu, and more.
• Requires Linux Kernel 3.1 or newer.
• Superuser access or a user account with sudo privileges is necessary.

🚦 Getting Started

1. Installation: Simple and quick installation process.
2. Configuration: Easy-to-follow configuration steps.
3. Management: User-friendly interface for managing your VPN.

Installation Guide

https://github.com/complexorganizations/wireguard-manager/assets/102563715/dd539835-2c30-4146-b4f8-940329aa6070

🐧 Installation

To ensure the successful installation of the WireGuard Manager script on various Linux systems, it's crucial to have curl and bash installed. Here's an expanded installation guide that includes instructions for installing curl and bash on different Linux distributions:

Installing curl & bash & resolvconf on Linux Systems

Debian/Ubuntu-based Systems (e.g., Ubuntu, Debian, Linux Mint):

sudo apt update
sudo apt install curl bash resolvconf

Red Hat-based Systems (e.g., CentOS, RHEL, Fedora):

sudo yum install curl bash resolvconf

or

sudo dnf install curl bash resolvconf

Arch-based Systems (e.g., Arch Linux, Manjaro):

sudo pacman -Sy curl bash resolvconf

Alpine Linux:

sudo apk update
sudo apk add curl bash resolvconf

Other Distributions:

For other Linux distributions, you can use the package manager specific to that distribution to install curl & bash & resolvconf. The package names may vary slightly.

Installing WireGuard Manager Script

Now that you have curl and bash installed, you can proceed with installing the WireGuard Manager script using the provided instructions:

1. First, use curl to download the script and save it in /usr/local/bin/:

   curl https://raw.githubusercontent.com/complexorganizations/wireguard-manager/main/wireguard-manager.sh --create-dirs -o /usr/local/bin/wireguard-manager.sh
   

2. Next, make the script user executable:

   chmod +x /usr/local/bin/wireguard-manager.sh
   

3. Finally, execute the script:

   bash /usr/local/bin/wireguard-manager.sh
   

Connecting to WireGuard Interface

In your /etc/wireguard/clients directory, you will find .conf files. These are the peer configuration files. Download them from your WireGuard Interface and connect using your favorite WireGuard Peer.

🔑 Usage

usage: bash /usr/local/bin/wireguard-manager.sh # --install
  --install     Installs the WireGuard interface on your system
  --start       Starts the WireGuard interface if it's not already running
  --stop        Stops the WireGuard interface if it's currently running
  --restart     Restarts the WireGuard interface
  --list        Lists all the peers currently connected to the WireGuard interface
  --add         Adds a new peer to the WireGuard interface
  --remove      Removes a specified peer from the WireGuard interface
  --reinstall   Reinstalls the WireGuard interface, keeping the current configuration
  --uninstall   Uninstalls the WireGuard interface from your system
  --update      Updates the WireGuard Manager to the latest version
  --ddns        Updates the IP address of the WireGuard interface using Dynamic DNS
  --backup      Creates a backup of your current WireGuard configuration
  --restore     Restores the WireGuard configuration from a previous backup
  --purge       Removes all peers from the WireGuard interface
  --help        Displays this usage guide

🥰 Features

• Seamless installation and configuration of WireGuard Interface
• Convenient backup and restoration of WireGuard
• Automatic expiration of peer configurations
• Support for both IPv4 and IPv6, with leak protection
• Variety of public DNS options available for peers
• Option to use a self-hosted resolver with Unbound for DNS leak prevention and DNSSEC support
• Effortless management of Nftables rules and forwarding
• Easy removal and uninstallation of WireGuard Interface
• Mandatory preshared-key for an additional layer of security
• Numerous other minor features for enhanced user experience

💡 Configuration Options

• PRIVATE_SUBNET_V4_SETTINGS: This defines the private IPv4 subnet used within the VPN. The default is 10.0.0.0/8, a standard private IP range.
• PRIVATE_SUBNET_V6_SETTINGS: This sets the private IPv6 subnet. The default fd00:00:00::0/8 is a typical private IPv6 range.
• SERVER_HOST_V4_SETTINGS: This is used to detect the public IPv4 address of the server, crucial for establishing connections from outside the local network.
• SERVER_HOST_V6_SETTINGS: This is the IPv6 counterpart to the previous setting, used for detecting the server's public IPv6 address.
• SERVER_PUB_NIC_SETTINGS: This determines the local public network interface using the ip command, essential for server communication on the public network.
• SERVER_PORT_SETTINGS: This specifies the default public port (51820) for the WireGuard interface, the port through which VPN traffic will pass.
• NAT_CHOICE_SETTINGS: This configures the use of the VPN tunnel's keep-alive feature, which helps keep the connection active.
• MTU_CHOICE_SETTINGS: This sets the Maximum Transmission Unit (MTU) for WireGuard peers, impacting the size of packets transmitted over the network.
• SERVER_HOST_SETTINGS: This is a general setting for defining server-specific configurations.
• CLIENT_ALLOWED_IP_SETTINGS: This defines the IP range allowed for clients connecting to the VPN, restricting which devices can connect.
• AUTOMATIC_UPDATES_SETTINGS: This likely relates to whether the system will automatically update software or configurations.
• AUTOMATIC_BACKUP_SETTINGS: This pertains to the automatic backup of system configurations or data.
• DNS_PROVIDER_SETTINGS: This involves setting up a DNS provider for the network. If you're not using Unbound, you'll need to specify another DNS service.
• CONTENT_BLOCKER_SETTINGS: This might relate to settings for blocking certain types of content through the network.
• CLIENT_NAME: This is the name assigned to a WireGuard peer (client) in the VPN.
• AUTOMATIC_CONFIG_REMOVER: This is possibly a setting to automatically remove certain configurations after they are no longer needed or after a set period.

👉👈 Compatibility with Linux Distributions