mirror of https://github.com/m1k1o/neko.git synced 2025-04-28 18:06:20 +02:00

Miroslav Šedivý 3a8a5c30ef docs: use ConfigurationTab that allows switching between yaml, env and cmd.

2025-04-05 18:25:04 +02:00

11 KiB

Raw Blame History

description
Configuration related to the WebRTC and Networking in Neko.

import { Def, Opt } from '@site/src/components/Anchor'; import { ConfigurationTab } from '@site/src/components/Configuration'; import configOptions from './help.json';

WebRTC Configuration

This page describes how to configure WebRTC settings inside neko.

Neko uses WebRTC with the Pion library to establish a peer-to-peer connection between the client and the server. This connection is used to stream audio, video, and data bidirectionally between the client and the server.

ICE Setup

ICE, which stands for Interactive Connectivity Establishment, is a protocol used to find the best path to connect peers, such as a client and a server. It helps discover the public IP addresses and ports of both parties to establish a direct connection. ICE candidates, which contain this information, are exchanged through a signaling server to facilitate the connection process.

ICE Trickle

ICE Trickle is a feature that allows ICE candidates to be sent as they are discovered, rather than waiting for all candidates to be discovered before sending them. It means that the ICE connection can be established faster as the server can start connecting to the client as soon as it has a few ICE candidates and doesn't have to wait for all of them to be discovered.

ICE Lite

ICE Lite is a minimal implementation of the ICE protocol intended for servers running on a public IP address. It is not enabled by default to allow more complex ICE configurations out of the box.

:::info When using ICE Servers, ICE Lite must be disabled. :::

ICE Servers

ICE servers are used to establish a connection between the client and the server. There are two types of ICE servers:

STUN: A STUN server is used to discover the public IP address of the client. This is used to establish a direct connection between the client and the server.
TURN: A TURN server is used to relay data between the client and the server if a direct connection cannot be established.

The configuration of a single ICE server is defined by the following fields:

Field	Description	Type
	List of URLs of the ICE server, if the same server is available on multiple URLs with the same credentials, they can be listed here.	`string[]`
	Username used to authenticate with the ICE server, if the server requires authentication.	`string`
	Credential used to authenticate with the ICE server, if the server requires authentication.	`string`

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

```yaml title="Example of multiple ICE servers in YAML"
- urls: "turn:<MY-COTURN-SERVER>:3478"
  username: "neko"
  credential: "neko"
- urls: "stun:stun.l.google.com:19302"
```

```json title="Example of multiple ICE servers in JSON"
[
  {
    "urls": "turn:<MY-COTURN-SERVER>:3478",
    "username": "neko",
    "credential": "neko"
  },
  {
    "urls": "stun:stun.l.google.com:19302"
  }
]
```

:::tip
  You can specify the ICE servers as a JSON string in the `docker-compose.yaml` file using the `NEKO_WEBRTC_ICESERVERS_FRONTEND` and `NEKO_WEBRTC_ICESERVERS_BACKEND` environment variables.

  ```yaml title="docker-compose.yaml"
    NEKO_WEBRTC_ICESERVERS_FRONTEND: |
      [{
        "urls": [ "turn:<MY-COTURN-SERVER>:3478" ],
        "username": "neko",
        "credential": "neko"
      },{
        "urls": [ "stun:stun.nextcloud.com:3478" ]
      }]
  ```
:::

The ICE servers are divided into two groups:

- ICE servers that are sent to the client and used to establish a connection between the client and the server.
- ICE servers that are used by the server to gather ICE candidates. They might contain private IP addresses or other sensitive information that should not be sent to the client.

Example with Coturn server in Docker Compose

services:
  coturn:
    image: 'coturn/coturn:latest'
    network_mode: "host"
    command: |
      -n
      --realm=localhost
      --fingerprint
      --listening-ip=0.0.0.0
      --external-ip=<MY-COTURN-SERVER>
      --listening-port=3478
      --min-port=49160
      --max-port=49200
      --log-file=stdout
      --user=neko:neko
      --lt-cred-mech

Replace <MY-COTURN-SERVER> with your LAN or Public IP address, and allow ports 49160-49200/udp and 3478/tcp. The --user flag is used to specify the username and password for the TURN server. The --lt-cred-mech flag is used to enable the long-term credentials mechanism for authentication. More information about the Coturn server can be found here.

Network Setup

Since WebRTC is a peer-to-peer protocol that requires a direct connection between the client and the server. This can be achieved by:

Using a public IP address for the server (or at least reachable from the client if deployed on a private network).
Using a TURN server to relay data between the client and the server if a direct connection cannot be established.

All specified ports along with the server's IP address will be sent to the client in ICE candidates to establish a connection. Therefore, it is important to ensure that the specified ports are open on the server's firewall, are not remapped to different ports, and are reachable from the client.

:::danger Remember WebRTC does not use the HTTP protocol, therefore it is not possible to use nginx or other reverse proxies to forward the WebRTC traffic. If you only have exposed port 443 on your server, you must expose as well the WebRTC ports or use a TURN server. :::

There exist two types of connections:

Ephemeral UDP port range: The range of UDP ports that the server uses to establish a connection with the client. Every time a new connection is established, a new port from this range is used. This range should be open on the server's firewall.
UDP/TCP multiplexing: The server can use a single port for multiple connections. This port should be open on the server's firewall.

Ephemeral UDP port range

The ephemeral UDP port range can be configured using the following configuration:

The range 59000-59100 contains 101 ports, which should be open on the server's firewall. The server uses these ports to establish a connection with the client. You can specify a different range of ports if needed, with fewer or more ports, depending on the number of simultaneous connections you expect.

:::tip Make sure When specifying the ephemeral UDP port range in docker-compose.yaml, make sure to use the same range for ports as UDP.

environment:
  NEKO_WEBRTC_EPR: "59000-59100"
ports:
  - "59000-59100:59000-59100/udp"

It is important to expose the same ports to the host machine, without any remapping e.g. 49000-49100:59000-59100/udp instead of 59000-59100:59000-59100/udp. :::

UDP/TCP multiplexing

The UDP/TCP multiplexing port can be configured using the following configuration:

- The port used for UDP connections.
- The port used for TCP connections.

The server uses only port 59000 for both UDP and TCP connections. This port should be open on the server's firewall. You can specify a different port if needed, or specify only one of the two protocols. UDP is generally better for latency, but some networks block UDP so it is good to have TCP available as a fallback.

:::tip Make sure When specifying the UDP/TCP multiplexing port in docker-compose.yaml, make sure to correctly specify the protocol in the ports section.

environment:
  NEKO_WEBRTC_UDPMUX: "59000"
  NEKO_WEBRTC_TCPMUX: "59000"
ports:
  - "59000:59000/udp"
  - "59000:59000/tcp"

It is important to expose the same ports to the host machine, without any remapping e.g. 49000:59000/udp instead of 59000:59000/udp. :::

Server IP Address

The server IP address is sent to the client in ICE candidates so that the client can establish a connection with the server. By default, the server IP address is automatically resolved by the server to the public IP address of the server. If the server is behind a NAT, you want to specify a different IP address or use neko only in a local network, you can specify the server IP address manually.

NAT 1-to-1

Currently, only one address can be specified. Therefore if you want to access your instance from both local and public networks, your router must support NAT loopback (hairpinning).

IP Retrieval URL

If you do not specify the server IP address, the server will try to resolve the public IP address of the server automatically.

The server will send an HTTP GET request to the specified URL to retrieve the public IP address of the server.

Bandwidth Estimator

:::danger The bandwidth estimator is an experimental feature and might not work as expected. :::

The bandwidth estimator is a feature that allows the server to estimate the available bandwidth between the client and the server. It is used to switch between different video qualities based on the available bandwidth. The bandwidth estimator is disabled by default.

11 KiB Raw Blame History