mirror of
https://github.com/donaldzou/WGDashboard.git
synced 2024-11-06 16:00:28 +01:00
Update README.md
This commit is contained in:
parent
59f7200512
commit
4fe70a4c46
34
README.md
34
README.md
@ -88,11 +88,16 @@
|
||||
- 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]
|
||||
> 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 |
|
||||
|-----------|--------|--------------------------|----------|--------|
|
||||
@ -103,23 +108,10 @@
|
||||
> ![!TIP]
|
||||
> **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]
|
||||
> Don't know how? Check this <a href="https://www.wireguard.com/install/">official documentation</a>
|
||||
|
||||
- `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
|
||||
> ![!NOTE]
|
||||
> This only applies to existing WireGuard Configuration under `/etc/wireguard`
|
||||
|
||||
```ini
|
||||
[Interface]
|
||||
@ -134,7 +126,7 @@
|
||||
PublicKey = abcd1234
|
||||
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.
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
> [!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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user