Skip to content

Commit

Permalink
doc(icetester): Make it appear on the readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
levaitamas committed Nov 29, 2024
1 parent 0be4af0 commit 4812c10
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/cmd/icetester.md
Original file line number Diff line number Diff line change
@@ -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).
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ nav:
- 'stunnerctl': 'cmd/stunnerctl.md'
- 'stunnerd': 'cmd/stunnerd.md'
- 'turncat': 'cmd/turncat.md'
- 'icetester': 'cmd/icetester.md'
plugins:
- search
- mkdocstrings:
Expand Down

0 comments on commit 4812c10

Please sign in to comment.