diff --git a/README.md b/README.md index 3ac2162..78957aa 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,6 @@ - [Dashboard Configuration file](#dashboard-configuration-file) - [Generating QR code](#generating-qr-code) - [❓ How to update the dashboard?](#-how-to-update-the-dashboard) - - [⚠️ Update from v1.x.x](#%EF%B8%8F--update-from-v1xx) - [🔍 Screenshot](#-screenshot) - [⏰ Changelog](#--changelog) - [🛒 Dependencies](#-dependencies) @@ -49,25 +48,24 @@ ## 💡 Features -- Add peers for each WireGuard configuration - -- Manage peer - -- Delete peers - -- And many more coming up! Welcome to contribute to this project! +- Easy to use interface, provided username and password protection to the dashboard +- Add peers and edit (Allowed IPs, DNS, Private Key...) +- View peers and configuration real time details (Data Usage, Latest Handshakes...) +- Share your peer configuration with QR code or file download +- Testing tool: Ping and Traceroute to your peer's ip +- **And more functions are coming up!** ## 📝 Requirement -- Ubuntu or Debian based OS, other might work, but haven't test yet. Tested on the following OS: +- Recommend the following OS, tested by our beloved users: - [x] Ubuntu 18.04.1 LTS - 20.04.1 LTS - [x] Debian GNU/Linux 10 (buster) [❤️ @[robchez](https://github.com/robchez)] - [x] AlmaLinux 8.4 (Electric Cheetah) [❤️ @[barry-smithjr](https://github.com/)] - [x] CentOS 7 [❤️ @[PrzemekSkw](https://github.com/PrzemekSkw)] - [ ] If you have tested on other OS and it works perfectly please provide it to me in [#31](https://github.com/donaldzou/wireguard-dashboard/issues/31). Thank you! -- ‼️ Make sure you have **Wireguard** and **Wireguard-Tools (`wg-quick`)** installed.‼️ How to install? +- Make sure you have **Wireguard** and **Wireguard-Tools (`wg-quick`)** installed. How to install? - Configuration files under **/etc/wireguard** - **Note**: @@ -235,7 +233,7 @@ In the `src` folder, it contained a file called `wg-dashboard.service`, we can u $ sudo systemctl restart wg-dashboard.service # <-- To restart the service ``` -8. **And now you can reboot your system, and use the command at step 6 to see if it will auto start after the reboot. If you have any questions or problem, please report a bug.** +8. **And now you can reboot your system, and use the command at step 6 to see if it will auto start after the reboot. If you have any questions or problem, please report it in the issue page.** ## ✂️ Dashboard Configuration @@ -256,7 +254,7 @@ Since version 2.0, Wireguard Dashboard will be using a configuration file called | | If `auth_req = false` , user will not be access the **Setting** tab due to security consideration. **User can only change the file directly in system**. | | | `version` | Dashboard Version | N/A | -

Latest Version: V2.1

+

Latest Version: V2.2

All these settings will be able to configure within the dashboard in **Settings** on the sidebar, without changing the actual file. **Except `version` and `auth_req` due to security consideration.** @@ -305,28 +303,37 @@ Endpoint = 0.0.0.0:51820 ``` $ ./wgd.sh start ``` -### ⚠️ **Update from v1.x.x** - -1. Stop the dashboard if it is running. -2. You can use `git pull https://github.com/donaldzou/wireguard-dashboard.git v2.2` to get the new update inside `Wireguard-Dashboard` directory. -3. Proceed **Step 2 & 3** in the [Install](#-install) step down below. - ## 🔍 Screenshot -![Sign In Page](img/Sign In.png) - +![Sign In Page](img/SignIn.png)

Sign In

-![Index Image](img/Home Page.png) - +![Index Image](img/HomePage.png)

Home

![Configuration](img/Configuration.png) +

Configuration

+ +![Add Peer](img/AddPeer.png) +

Add Peer

+ +![Edit Peer](img/EditPeer.png) +

Edit Peer

+ +![Delete Peer](img/DeletePeer.png) +

Delete Peer

+ +![Dashboard Setting](img/DashboardSetting.png) +

Dashboard Setting

+ +![Ping](img/Ping.png) +

Ping

+ +![Traceroute](img/Traceroute.png) +

Traceroute

-Home - ## ⏰ Changelog #### v2.1 - Jul 2, 2021 diff --git a/img/Add Peer.png b/img/AddPeer.png similarity index 100% rename from img/Add Peer.png rename to img/AddPeer.png diff --git a/img/Dashboard Setting.png b/img/DashboardSetting.png similarity index 100% rename from img/Dashboard Setting.png rename to img/DashboardSetting.png diff --git a/img/Delete Peer.png b/img/DeletePeer.png similarity index 100% rename from img/Delete Peer.png rename to img/DeletePeer.png diff --git a/img/Edit Peer.png b/img/EditPeer.png similarity index 100% rename from img/Edit Peer.png rename to img/EditPeer.png diff --git a/img/Group 2.png b/img/Group 2.png deleted file mode 100644 index 2dcf9d1..0000000 Binary files a/img/Group 2.png and /dev/null differ diff --git a/img/Group 2@2x.png b/img/Group 2@2x.png deleted file mode 100644 index 3ab02c2..0000000 Binary files a/img/Group 2@2x.png and /dev/null differ diff --git a/img/Group 3.png b/img/Group 3.png deleted file mode 100644 index 281bbc7..0000000 Binary files a/img/Group 3.png and /dev/null differ diff --git a/img/Group 3@2x.png b/img/Group 3@2x.png deleted file mode 100644 index 888a51a..0000000 Binary files a/img/Group 3@2x.png and /dev/null differ diff --git a/img/Home Page.png b/img/HomePage.png similarity index 100% rename from img/Home Page.png rename to img/HomePage.png diff --git a/img/QR Code of peer.png b/img/QRCode.png similarity index 100% rename from img/QR Code of peer.png rename to img/QRCode.png diff --git a/img/Sign In.png b/img/SignIn.png similarity index 100% rename from img/Sign In.png rename to img/SignIn.png