Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atareao/wireguard-indicator
An Indicator for WireGuard
https://github.com/atareao/wireguard-indicator
Last synced: 9 days ago
JSON representation
An Indicator for WireGuard
- Host: GitHub
- URL: https://github.com/atareao/wireguard-indicator
- Owner: atareao
- License: mit
- Created: 2020-09-19T07:07:03.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-06-12T18:09:24.000Z (over 1 year ago)
- Last Synced: 2024-08-01T19:45:54.311Z (3 months ago)
- Language: JavaScript
- Size: 382 KB
- Stars: 172
- Watchers: 5
- Forks: 23
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - atareao/wireguard-indicator - An Indicator for WireGuard (others)
README
[](https://www.codefactor.io/repository/github/atareao/wireguard-indicator)
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](https://www.wireguard.com/quickstart/).
## Installing the WireGuard Indicator
To install the WireGuard Indicator, follow these steps:
Go to the [GNOME Extensions page](https://extensions.gnome.org/) and search for "[WireGuard Indicator](https://extensions.gnome.org/extension/3612/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 [email protected]`, 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:
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.
You can set additional options as you can see in next screenshot:
* Enable the dark theme for the WireGuard Indicator icon:
* 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 `.
3. Make your changes and commit them: `git commit -m ''`
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](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
## 👤 Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
