-
-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc(icetester): Make it appear on the readthedocs
- Loading branch information
1 parent
0be4af0
commit 4812c10
Showing
2 changed files
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters