Skip to content

Commit

Permalink
docs(neko): Add sections to install steps
Browse files Browse the repository at this point in the history
  • Loading branch information
levaitamas committed Dec 4, 2024
1 parent 0085ca0 commit 4454adc
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/examples/neko/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,14 @@ To run this example, you need:
* a [deployed STUNner](../../INSTALL.md#installation-1) (presumably the latest stable version),
* optionally, an [Ingress controller](../TLS.md#ingress) to ingest traffic into the cluster.

### Quick installation
### STUNner configuration

The simplest way to deploy the demo is to clone the [STUNner git repository](https://github.com/l7mp/stunner) and deploy the [manifest](neko.yaml) packaged with STUNner.

Configure STUNner to act as a STUN server towards clients, and to let media reach the media server.
First, configure STUNner to act as a TURN server towards clients, and to let media reach the media server.

```console
git clone https://github.com/l7mp/stunner
cd stunner/docs/examples/neko

kubectl apply -f stunner.yaml
```

Expand All @@ -43,7 +42,9 @@ STUNNERIP=$(kubectl get service udp-gateway -n default -o jsonpath='{.status.loa
> [!NOTE]
> This IP should be accessible from your browser. If that "public IP" is behind a NAT, you can overwrite it with the actual public IP that routes to the service by hand (e.g. `STUNNERIP=<your public IP>`).
We need to give this public IP the Neko configuration in the `NEKO_ICESERVERS` environment variable, inside the `json` content (basically this will tell you browser to use STUNner as a STUN/TURN server).
### Setup Neko

We need to set the STUNner public IP in the Neko configuration file under the `NEKO_ICESERVERS` environment variable, which is inside the `json` content. This will tell you browser to use STUNner as a STUN/TURN server.
You can do that by hand, or by this fancy `sed` command:
```console
sed -i "s/turn:[\.0-9]*:3478/turn:$STUNNERIP:3478/g" neko.yaml
Expand Down

0 comments on commit 4454adc

Please sign in to comment.