-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
419e5a8
commit d361592
Showing
15 changed files
with
64 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,15 +15,6 @@ jobs: | |
run: sudo apt-get update && sudo apt-get install -y make zip jq | ||
- name: Build extension | ||
run: make | ||
- name: Locate built ZIP file | ||
id: find_zip | ||
run: | | ||
ZIP_FILE=$(ls *.zip | head -n 1) | ||
if [ -z "$ZIP_FILE" ]; then | ||
echo "No ZIP file found!" | ||
exit 1 | ||
fi | ||
echo "ZIP_FILE=$ZIP_FILE" >> $GITHUB_ENV | ||
- name: Create GitHub Release | ||
id: create_release | ||
uses: actions/create-release@v1 | ||
|
@@ -40,6 +31,6 @@ jobs: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
with: | ||
upload_url: ${{ steps.create_release.outputs.upload_url }} | ||
asset_path: ${{ env.ZIP_FILE }} | ||
asset_name: ${{ env.ZIP_FILE }} | ||
asset_path: [email protected] | ||
asset_name: [email protected] | ||
asset_content_type: application/zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,19 @@ | ||
![License](https://img.shields.io/github/license/amnezia-vpn/toggle-awg-gnome-shell) | ||
![License](https://img.shields.io/github/license/amnezia-vpn/amneziawg-gnome-extension?labelColor=303030&color=2dba4e) | ||
[![GitHub release (latest)](https://img.shields.io/github/v/release/amnezia-vpn/amneziawg-gnome-extension?display_name=release&labelColor=303030&color=2dba4e)](https://github.com/amnezia-vpn/amneziawg-gnome-extension/releases/latest) | ||
[![Download extension](https://img.shields.io/badge/Download-extensions.gnome.org-4a86cf?logo=gnome&logoColor=lightgrey&labelColor=303030)](https://extensions.gnome.org/extension/7586/amneziawg-toggle-button/) | ||
[<img src="https://github.com/amnezia-vpn/amneziawg-gnome-extension/raw/master/images/get_it_on_gnome_extensions.png" height="100" align="right">](https://extensions.gnome.org/extension/7586/amneziawg-toggle-button/) | ||
# AmneziaWG Gnome Shell Extension | ||
|
||
# Toggle AWG Extension | ||
<div align="center"> | ||
<a href="https://docs.amnezia.org/documentation/amnezia-wg/"> | ||
<img src="https://github.com/amnezia-vpn/amneziawg-gnome-extension/raw/master/icons/active-light.png" height="100"> | ||
</a> | ||
</div> | ||
|
||
A GNOME Shell extension that allows you to toggle the **AWG Quick Service** conveniently from the system status bar. The extension supports custom icons for light and dark themes, which can be manually configured through the preferences. | ||
A GNOME Shell extension that allows you to toggle the **AmneziaWG** (via [email protected]) conveniently from the system status bar. The extension supports custom icons for light and dark themes, which can be manually configured through the preferences. | ||
|
||
> [!IMPORTANT] | ||
> Extension requires [AmneziaWG Kernel Module](https://github.com/amnezia-vpn/amneziawg-linux-kernel-module) and [AmneziaWG Tools](https://github.com/amnezia-vpn/amneziawg-tools) to be installed | ||
## Features | ||
|
||
|
@@ -12,6 +23,16 @@ A GNOME Shell extension that allows you to toggle the **AWG Quick Service** conv | |
- Manual theme selection for icons (dark or light). | ||
- Adjustable icon size. | ||
|
||
## Screenshots | ||
|
||
### Panel buton | ||
|
||
![Screenshot](images/screenshot-panel.png) | ||
|
||
### Settings window | ||
|
||
![Screenshot](images/screenshot-prefs.png) | ||
|
||
## Gnome Versions Support | ||
|
||
- 43 - `master` branch, `v1` tag | ||
|
@@ -21,31 +42,31 @@ A GNOME Shell extension that allows you to toggle the **AWG Quick Service** conv | |
### Get extension from GIT: | ||
|
||
```bash | ||
git clone https://github.com/amnezia-vpn/toggle-awg-gnome-shell.git ~/.local/share/gnome-shell/extensions/toggle-awg@amnezia-vpn | ||
git clone https://github.com/amnezia-vpn/amneziawg-gnome-extension.git ~/.local/share/gnome-shell/extensions/amneziawg@amnezia-vpn | ||
``` | ||
> add `--branch v<version tag>` if you need exact version | ||
### Get extension from ZIP: | ||
```bash | ||
wget https://github.com/amnezia-vpn/toggle-awg-gnome-shell/releases/download/latest/toggle-awg@amnezia-vpn.shell-extension.zip | ||
gnome-extensions install toggle-awg@amnezia-vpn.shell-extension.zip --force | ||
wget https://github.com/amnezia-vpn/amneziawg-gnome-extension/releases/download/v1/amneziawg@amnezia-vpn.shell-extension.zip | ||
gnome-extensions install amneziawg@amnezia-vpn.shell-extension.zip --force | ||
``` | ||
|
||
> Replace `latest` in url with `v<version tag>` if you need exact version | ||
> Replace `v1` in url with `v<version tag>` if you need exact version | ||
### Apply extension | ||
|
||
1. Restart GNOME Shell | ||
- *For X11*: press `Alt + F2`, type `r`, and hit `Enter`. | ||
- *For Wayland*: logout and login again | ||
|
||
2. Enable the extension using GNOME Extensions app or with `gnome-extensions enable toggle-awg@amnezia-vpn` command | ||
2. Enable the extension using GNOME Extensions app or with `gnome-extensions enable amneziawg@amnezia-vpn` command | ||
|
||
## Configuration | ||
|
||
Open the extension preferences through the GNOME Extensions app to configure the following: | ||
|
||
- *Interface Name*: Specify the system interface name (default is awg1). | ||
- *Interface Name*: Specify the system interface name (default is awg0). | ||
- *Icon Size*: Adjust the size of the icons displayed in the system panel. | ||
- *Icon Theme*: Choose between dark or light theme icons. | ||
|
||
|
@@ -60,7 +81,26 @@ Ensure that the awg-quick service is properly configured on your system. | |
|
||
## AmneziaWG client setup | ||
|
||
TODO | ||
### Install AmneziaWG | ||
|
||
You can use [this instructions](https://github.com/amnezia-vpn/amneziawg-linux-kernel-module/blob/master/README.md#installation) to install **AmneziaWG** | ||
|
||
### Install configuration file | ||
|
||
- Configuration Directory: `/etc/amnezia/amneziawg/` | ||
- Configuration File Name Format: `*.conf` | ||
- Configuration File Permissions: Any 'root' readable | ||
|
||
> [!TIP] | ||
> While the configuration file can have any name, it is recommended to name it `awg0.conf`, as this name is used by default by the application. However, you can choose any name and update the configuration in the extension settings accordingly. | ||
### Sudoers | ||
|
||
The command triggered by the extension button requires `sudo` permissions. To avoid entering your password each time you toggle the button, add a sudoers file with the following content: | ||
|
||
``` | ||
io ALL=(ALL:ALL) NOPASSWD: /usr/bin/systemctl | ||
``` | ||
|
||
## License | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
{ | ||
"uuid": "toggle-awg@amnezia-vpn", | ||
"uuid": "amneziawg@amnezia-vpn", | ||
"name": "AmneziaWG Toggle Button", | ||
"description": "A button to toggle AmneziaWG service on/off", | ||
"shell-version": ["43"], | ||
"url": "https://github.com/amnezia-vpn/toggle-awg-gnome-shell", | ||
"settings-schema": "org.gnome.shell.extensions.toggle-awg", | ||
"version": 1 | ||
"url": "https://github.com/amnezia-vpn/amneziawg-gnome-extension", | ||
"settings-schema": "org.gnome.shell.extensions.amneziawg", | ||
"version": 2 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
6 changes: 3 additions & 3 deletions
6
...e.shell.extensions.toggle-awg.gschema.xml → ...me.shell.extensions.amneziawg.gschema.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters