UniqueSoft/WGDashboard
2
0
Fork 0
mirror of https://github.com/donaldzou/WGDashboard synced 2025-02-26 05:58:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Donald Zou 2024-08-16 23:01:58 -04:00
parent 59f7200512
commit 4fe70a4c46
1 changed files with 33 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -88,11 +88,16 @@
- Testing tool: Ping and Traceroute to your peer - Testing tool: Ping and Traceroute to your peer
## 📝 Requirement ## 📝 Requirements
- Tested on the following Operating Systems 1. Supported operating systems. Please view the list below.
2. WireGuard & WireGuard-Tools (`wg-quick`)
3. Python 3.10 / 3.11 / 3.12
4. `git`, `net-tools`, `sudo` (_This should only apply to RHEL 9 & 8, interestingly it doesn't have it preinstalled)_
### Supported Operating Systems
> [!NOTE] > [!NOTE]
> All operating systems I tested are ARM64 ran in UTM Virtual Machine. > All operating systems below are tested by myself. All are ARM64 ran in UTM Virtual Machine.
| Ubuntu | Debian | Red Hat Enterprise Linux | CentOS | Fedora | | Ubuntu | Debian | Red Hat Enterprise Linux | CentOS | Fedora |
|-----------|--------|--------------------------|----------|--------| |-----------|--------|--------------------------|----------|--------|
@ -103,23 +108,10 @@
> ![!TIP] > ![!TIP]
> **If you have tested on other operating systems and it works perfectly please provide it to me. Thank you!** > **If you have tested on other operating systems and it works perfectly please provide it to me. Thank you!**
- **WireGuard** and **WireGuard-Tools (`wg-quick`)** are installed. ### Existing WireGuard Configurations
> [!TIP] > ![!NOTE]
> Don't know how? Check this <a href="https://www.wireguard.com/install/">official documentation</a> > This only applies to existing WireGuard Configuration under `/etc/wireguard`
- `git`, `net-tools`， `sudo` (_This only apply to RHEL 9 & 8, can't believe it doesn't come with `sudo` installed lol)_
- Python 3.10 / 3.11 / 3.12
> [!TIP]
> Check your Python version with
> ```shell
> $ python3 --version
> Python 3.12.0
> ```
- Configuration files under **`/etc/wireguard`**, but please note the following sample
```ini ```ini
[Interface] [Interface]
@ -134,7 +126,7 @@
PublicKey = abcd1234 PublicKey = abcd1234
AllowedIPs = 1.2.3.4/32 AllowedIPs = 1.2.3.4/32
``` ```
> ![!TIP]
> With `v4`, WGDashboard will look for entry with `#Name# = abc...` in each peer and use that for the name. > With `v4`, WGDashboard will look for entry with `#Name# = abc...` in each peer and use that for the name.
@ -146,7 +138,7 @@
These commands are tested by myself in each OS. It contains commands to install WireGuard, Git, Net Tools, and even Python on some OS. These commands are tested by myself in each OS. It contains commands to install WireGuard, Git, Net Tools, and even Python on some OS.
> [!WARNING] > [!WARNING]
> Please makesure you understand these commands before you run them > Please make sure you understand these commands before you run them.
#### Ubuntu 20.04 LTS #### Ubuntu 20.04 LTS