aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2022-11-28 19:40:22 +0100
committerEgor Tensin <Egor.Tensin@gmail.com>2022-11-28 19:40:22 +0100
commit89b3f0082b2099a62c82b5709696b106ec89d03a (patch)
tree25789dc7cbc08e21ef99f4fe3b920215a5e184ca /README.md
parenthtml: fix relative URLs (diff)
downloadwg-api-web-89b3f0082b2099a62c82b5709696b106ec89d03a.tar.gz
wg-api-web-89b3f0082b2099a62c82b5709696b106ec89d03a.zip
README: update
Diffstat (limited to '')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index e1468e5..190397b 100644
--- a/README.md
+++ b/README.md
@@ -9,12 +9,14 @@ It uses [wg-api] to query data and formats it as a nice, sortable HTML table.
Usage
-----
-Clone the repository and run
+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.