From 679dfb39e8541dee8d162e8f21d48c1b634fb521 Mon Sep 17 00:00:00 2001
From: Khanh Ngo <k@ndk.name>
Date: Sat, 25 Apr 2020 11:13:29 +0700
Subject: [PATCH] Create README.md

---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0e17504
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+# wireguard-ui
+A web user interface to manage your WireGuard setup.
+
+## Features
+- Friendly UI
+- Authentication
+- Manage extra client's information (name, email, etc)
+- Retrieve configs using QR code / file
+
+## Run WireGuard-UI
+Only docker option for now, please refer to this example of [docker-compose.yml](https://github.com/ngoduykhanh/wireguard-ui/blob/master/docker-compose.yaml).
+
+Please adjust volume mount points to work with your setup. Then run it:
+
+```
+docker-compose up
+```
+
+## Auto restart WireGuard daemon
+WireGuard-UI only takes care of configuration generation. You can use systemd to watch for the changes and restart the service. Following is an example:
+
+Create /etc/systemd/system/wgui.service
+
+```
+[Unit]
+Description=Restart WireGuard
+After=network.target
+
+[Service]
+Type=oneshot
+ExecStart=/usr/bin/systemctl restart wg-quick@wg0.service
+```
+
+Create /etc/systemd/system/wgui.path
+
+```
+[Unit]
+Description=Watch /etc/wireguard/wg0.conf for changes
+
+[Path]
+PathModified=/etc/wireguard/wg0.conf
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Apply it
+```
+systemctl enable wgui.{path,service}
+systemctl start wgui.{path,service}
+```
+
+## Screenshot
+
+![wireguard-ui](https://user-images.githubusercontent.com/6447444/80270680-76adf980-86e4-11ea-8ca1-9237f0dfa249.png)
+
+## License
+MIT. See [LICENSE](https://github.com/ngoduykhanh/wireguard-ui/blob/master/LICENSE).