path: root/README.md

wg-api-web
==========

[![CI](https://github.com/egor-tensin/wg-api-web/actions/workflows/ci.yml/badge.svg)](https://github.com/egor-tensin/wg-api-web/actions/workflows/ci.yml)

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.

See an example setup at https://egort.name/wg-api-web/.

[wg-api]: https://github.com/jamescun/wg-api

Usage
-----

Copy the [docker-compose.yml] file and run

    WG_IFACE=wg0 docker-compose up -d

Replace `WG_IFACE` with your interface name (or omit it to use wg0).

[docker-compose.yml]: docker-compose.yml

### 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.

### linuxserver/wireguard

To use with LinuxServer's [wireguard image], see [this docker-compose.yml].
Adjust the docker-compose.yml file how you see fit.
Pat attention to the comments at the top: they describe the changes required
to make it work.

[wireguard image]: https://docs.linuxserver.io/images/docker-wireguard
[this docker-compose.yml]: test/linuxserver/docker-compose.yml

License
-------

Distributed under the MIT License.
See [LICENSE.txt] for details.

[LICENSE.txt]: LICENSE.txt