/wireguard-indicator

An Indicator for WireGuard

Primary LanguageJavaScriptMIT LicenseMIT

License MIT Contributors Last commit CodeFactor

Welcome to WireGuard Indicator 👋

🏠 Homepage

WireGuard Indicator is a GNOME Shell indicator that shows the status of your WireGuard VPN.

WireGuard Indicator can enable or disable the WireGuard VPN by clicking on it.

You need superuser privileges (i.e. root access).

Prerequisites

You need WireGuard. To install it, simply type in the terminal:

sudo apt install wireguard

Of course, you need to configure your beloved WireGuard first.

Installing the WireGuard Indicator

To install the WireGuard Indicator, follow these steps:

Go to the GNOME Extensions page and search for "WireGuard Indicator".

Enable the extension by clicking the switch.

Setting Up

WireGuard Indicator provide two ways to connect to your wireguard vpn:

  • nmcli
    With nmcli we need to add our wg.conf file connection first by sudo nmcli connection import type wireguard file /path/to/your/your-wg-file.conf, since WireGuard Indicator pick up the connection of type=wireguard they'll show up on the drop down and toggled right away after import (note: you may want to disable the auto connect via nm-connection-editor or your distro network setting).

  • systemd
    Add wireguard to systemd by running sudo systemctl enable wg-quick@yourconfig.service, make sure you have your /etc/wireguard/config.conf in place.

Using WireGuard Indicator

When you start WireGuard Indicator it appears in the Indicator Area, as you can see in the next screenshot:

WireGuard Indicator

In this screenshot, the language is in Spanish. If there is no translation for your language, you can have the app in English.

If you enable on one of the WireGuard connections, a dialog will appear and ask you for your password to gain root privileges.

WireGuard Indicator

You can set additional options as you can see in next screenshot:

WireGuard Indicator

  • Enable the dark theme for the WireGuard Indicator icon:

WireGuard Indicator

  • Set the systemd service name
  • Set the check time

Contributing to WireGuard Indicator

To contribute to WireGuard Indicator, please follow these steps:

  1. Fork this repository.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make your changes and commit them: git commit -m '<commit_message>'
  4. Push to the original branch: git push origin atareao/readmemaker
  5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

👤 Contributors ✨

Thanks goes to these wonderful people (emoji key):

Lorenzo Carbonell dtalens
💻 🌍