From 4812c10c1a5d85d60d14589ab46efb9351816b1d Mon Sep 17 00:00:00 2001
From: Tamas Levai <levait@tmit.bme.hu>
Date: Fri, 29 Nov 2024 16:05:39 +0100
Subject: [PATCH] doc(icetester): Make it appear on the readthedocs

---
 docs/cmd/icetester.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 mkdocs.yml            |  1 +
 2 files changed, 43 insertions(+)
 create mode 100644 docs/cmd/icetester.md

diff --git a/docs/cmd/icetester.md b/docs/cmd/icetester.md
new file mode 100644
index 0000000..a43eb20
--- /dev/null
+++ b/docs/cmd/icetester.md
@@ -0,0 +1,42 @@
+# icetester: Universal UDP echo service using WebRTC/ICE
+
+`icetester` is test server that can be used WebRTC/ICE connectivity. The tester serves a simple
+WebSocket/JSON API server that clients can use to create a WebRTC data channel. whatever is
+received by `icetester` on the data channel will be echoed back to the client over the data channel.
+
+While `icetester` can be used as a standalone too, the intended use is via `stunnerctl icetest`.
+
+## Installation
+
+Install `icetester` using the standard Go toolchain and add it to `$PATH`.
+
+```console
+go install github.com/l7mp/stunner/cmd/icetester@latest
+```
+
+Building from source is as easy as it usually gets with Go:
+
+```console
+cd stunner
+go build -o turncat cmd/icetester/main.go
+```
+
+The containerized version is available as `docker.io/l7mp/icester`.
+
+## Usage
+
+Deploy a STUNner gateway and test is via UDP and TCP through `stunnerctl`:
+
+```console
+stunnerctl icetest
+```
+
+## License
+
+Copyright 2021-2024 by its authors. Some rights reserved. See [AUTHORS](../../AUTHORS).
+
+MIT License - see [LICENSE](../../LICENSE) for full text.
+
+## Acknowledgments
+
+Initial code adopted from [pion/stun](https://github.com/pion/stun) and [pion/turn](https://github.com/pion/turn).
diff --git a/mkdocs.yml b/mkdocs.yml
index 580c317..9e401a5 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -37,6 +37,7 @@ nav:
   - 'stunnerctl': 'cmd/stunnerctl.md'
   - 'stunnerd': 'cmd/stunnerd.md'
   - 'turncat': 'cmd/turncat.md'
+  - 'icetester': 'cmd/icetester.md'
 plugins:
   - search
   - mkdocstrings: