diff options
| author | Egor Tensin <Egor.Tensin@gmail.com> | 2022-11-28 14:24:16 +0100 |
|---|---|---|
| committer | Egor Tensin <Egor.Tensin@gmail.com> | 2022-11-28 14:26:07 +0100 |
| commit | 167dfcbd053e8213b7a7ac994c0d9b7c87f5eae4 (patch) | |
| tree | af917832c6eff6f6471a226501865b4b948f5e61 /README.md | |
| parent | workflows/ci: rename the publish job (diff) | |
| download | wg-api-web-167dfcbd053e8213b7a7ac994c0d9b7c87f5eae4.tar.gz wg-api-web-167dfcbd053e8213b7a7ac994c0d9b7c87f5eae4.zip | |
add README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e1468e5 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +wg-api-web +========== + +This is a simple web monitoring tool for WireGuard connections. +It uses [wg-api] to query data and formats it as a nice, sortable HTML table. + +[wg-api]: https://github.com/jamescun/wg-api + +Usage +----- + +Clone the repository and run + + WG_IFACE=wg0 docker-compose up -d + +Replace `WG_IFACE` with your interface name (or omit it to use wg0). + +### Peer aliases + +You can set readable aliases for peers' public keys. +Put them in a file and map to /data/aliases. +See [data/aliases] for an example. + +[data/aliases]: data/aliases + +Basically, it's like a `hosts` file, with keys on the left and readable names +on the right. + +License +------- + +Distributed under the MIT License. +See [LICENSE.txt] for details. + +[LICENSE.txt]: LICENSE.txt |