Wireguard-manager

This is a simple, stupid waybar extension for toggling wireguard. It uses rofi for password prompting, but you could use anything you like.

Screenshots

VPN switched off, as seen in Waybar.

Password prompt with Rofi.

VPN switched on, as seen in Waybar.

Prerequisites

You need to be able to manage Wireguard using systemd, even though it should not be too difficult to change the script to use wg directly.

If your Wireguard interface is wg0, enable the service using:

sudo systemctl enable wg-quick@wg0.service
sudo systemctl daemon-reload

You also need rofi.

Installation Guide

Follow these steps to install the Wireguard-manager module for Waybar:

1. Clone the Repository

   git clone https://github.com/yourusername/wireguard-manager.git /path/to/clone
   cd /path/to/clone

2. Ensure Required Files Exist

   Make sure wireguard-manager.sh and install.sh are in the same directory.

3. Run the Install Script as Root

   sudo bash install.sh

4. Follow the Prompts

   • Enter your WireGuard service name (e.g., wg0).
   • Choose the module position in Waybar (left, right, or center).
   • Select your preferred rofi theme (light or dark).

5. Restart Waybar

   After installation, restart Waybar to see the new module.

If you encounter errors, check permissions and file locations. If you can't get it to work, please open an issue on our GitHub page.

Usage

With the given configuration, the status of the connection will be updated every 3 seconds. You can switch on/off the connection to your peer by clicking on the icon in Waybar.

Customization

This module is simple enough for anyone to customize it. You can change the way the rofi prompt looks by editing rofi.rasi, or you can use any other way to prompt the password. You can also change the way things look in Waybar by editing the sample configuration.

Manual Installation (Alternative)

If you prefer to add the module manually, add the following to your waybar config file:

"custom/wireguard-manager": {
     "exec": "exec ~/.config/waybar/wireguard-manager/wireguard-manager.sh -s",
     "format": "{icon}",
     "format-icons": {
          "connected": "<span color=\"#50fa7b\">VPN: 🔒</span>",
          "disconnected": "<span color=\"#ff5555\">VPN: 🔓</span>"
     },
     "interval": "once",
     "on-click": "~/.config/waybar/wireguard-manager/wireguard-manager.sh -t && pkill -SIGRTMIN+1 waybar",
     "return-type": "json",
     "signal": 1
}

See Waybar's wiki for more information on how to customize this.

Toggling WireGuard "manually"

If you intend on turning your Wireguard tunnel on and off through other means other than clicking on this waybar module, it can be useful to set the module itself in a different fashion:

"custom/wireguard-manager": {
     "interval": 3,
     "return-type": "json",
     "format-icons": {
          "connected": "<span color=\"#50fa7b\">VPN: 🔒</span>",
          "disconnected": "<span color=\"#ff5555\">VPN: 🔓</span>"
     },
     "on-click": "exec ~/.config/waybar/wireguard-manager/wireguard-manager.sh -t",
     "exec": "exec ~/.config/waybar/wireguard-manager/wireguard-manager.sh -s",
     "format": "{icon}"
}

This is because the version of the module presented first updates itself only when clicked on, to avoid constant polling of the status of the systemd service for Wireguard. If you do use other means to set your tunnel up or down (such as sudo systemctl stop wg-quick@wg0.service), it is recommended to use this other version of the module, as it polls the current status of the systemd service every 3 seconds, updating the status of the module without requiring the user to click on it.

Contributions

Contributions are most welcome, feel free to submit any idea or improvement you can think of.

See also

If you are a NetworkManager user, maybe you should rather use wireguard-rofi-waybar , which seems to offer way more functionalities!