https://github.com/processone/eturnal
STUN / TURN standalone server
https://github.com/processone/eturnal
Last synced: about 1 month ago
JSON representation
STUN / TURN standalone server
- Host: GitHub
- URL: https://github.com/processone/eturnal
- Owner: processone
- License: apache-2.0
- Created: 2020-06-15T08:18:37.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-25T14:51:41.000Z (about 2 months ago)
- Last Synced: 2025-02-25T15:42:58.418Z (about 2 months ago)
- Language: Erlang
- Homepage: https://eturnal.net
- Size: 1.1 MB
- Stars: 265
- Watchers: 27
- Forks: 23
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-webrtc - Eturnal - STUN / TURN standalone server. (Stun & Turn / C/C++)
README
# eturnal TURN Server
[][1]
[eturnal][2] is a modern, straightforward STUN and TURN server. For
authentication, the mechanism described in the [REST API for Access to TURN
Services][3] specification is implemented. The server can easily be tested [in a
Linux shell][4] or [using Docker][5]. For a persistent installation, see the
following section.
## Installation
> _Note:_ Running eturnal in **container environments** such as Docker or
> Kubernetes is described on a [separate documentation][6] page.
On **APT-based** Linux distributions, run:
```shell
sudo apt install extrepo
sudo extrepo enable eturnal
sudo apt update
sudo apt install eturnal
```
On **DNF5-based** Linux distributions, run:
```shell
sudo dnf config-manager addrepo --from-repofile=https://eturnal.net/eturnal.repo
sudo dnf install eturnal
sudo systemctl --now enable eturnal
```
On **DNF4-based** Linux distributions, run:
```shell
sudo dnf config-manager --add-repo https://eturnal.net/eturnal.repo
sudo dnf install eturnal
sudo systemctl --now enable eturnal
```
On **YUM-based** Linux distributions, run:
```shell
sudo yum-config-manager --add-repo https://eturnal.net/eturnal.repo
sudo yum install eturnal
sudo systemctl --now enable eturnal
```
On **SUSE** Linux Enterprise and openSUSE systems, [distribution
repositories][7] can be used instead. There's also an official **Alpine**
[package][8]. **Gentoo** users may install eturnal using the [GURU overlay][9].
On **other Linux systems**, the binary release can be installed as
[described][10] in the reference documentation. On **FreeBSD**, the official
[port][11] can be used. For **Windows**, an installer is [available][12].
On **macOS**, homebrew can be used like this:
```shell
brew tap processone/eturnal https://github.com/processone/eturnal
brew install processone/eturnal/eturnal
```
On **other platforms**, eturnal is [built from source][13].
## Configuration
The eturnal server is configured by editing the `/etc/eturnal.yml` file. This
file uses the (indentation-sensitive!) [YAML][14] format. For TURN relaying to
work, you'll have to specify the [shared authentication][3] `secret` and (if
autodetection fails) also the `relay_ipv4_addr` option, which should be set to
the server's _external_ IPv4 address. As an example, a configuration for
offering STUN and TURN services on port 3478 (UDP and TCP) might look like
this:
```yaml
eturnal:
secret: "long-and-cryptic" # Shared secret, CHANGE THIS.
relay_ipv4_addr: "203.0.113.4" # The server's public IPv4 address.
relay_ipv6_addr: "2001:db8::4" # The server's public IPv6 address (optional).
```
A more detailed, commented [example configuration][15] is shipped with the
eturnal server.
## Running eturnal
On Linux systems, the eturnal server is usually invoked by [systemd][16]. For
non-systemd platforms, example [init][17] and [OpenRC][18] scripts are shipped
below the `etc` directory.
For controlling eturnal, the `eturnalctl` command can be used; see:
```shell
eturnalctl help
```
## Logging
If eturnal was started by systemd, log files are written into the
`/var/log/eturnal` directory by default. In order to log to the [journal][19]
instead, the `log_dir` option can be set to `stdout` in the configuration file.
## Documentation
For a detailed description of eturnal's configuration options and the
`eturnalctl` tool, see the [reference documentation][20]. For notable changes
between eturnal releases, see the [change log][21].
## Feedback/Support
Please use [our issue tracker][22] for bug reports and feature requests. Feel
free to (ab)use it for usage questions as well. If you happen to be using
[XMPP][23], you could also join our public room
`[email protected]`. Otherwise, just use the [web client][24].
As an alternative, there's an `#eturnal` channel [on Slack][25].
[1]: https://github.com/processone/eturnal/actions/workflows/ci.yml
[2]: https://eturnal.net/
[3]: https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00
[4]: https://eturnal.net/doc/quick-test.html
[5]: https://eturnal.net/doc/container-quick-test.html
[6]: https://eturnal.net/doc/container.html
[7]: https://software.opensuse.org/download/?package=eturnal&project=devel:languages:erlang
[8]: https://pkgs.alpinelinux.org/packages?name=eturnal
[9]: https://gpo.zugaina.org/net-im/eturnal
[10]: https://eturnal.net/doc/#Installation
[11]: https://www.freshports.org/net/eturnal/
[12]: https://eturnal.net/windows/
[13]: https://eturnal.net/doc/install.html
[14]: https://en.wikipedia.org/wiki/YAML
[15]: https://github.com/processone/eturnal/blob/1.12.1/config/eturnal.yml
[16]: https://www.freedesktop.org/software/systemd/man/systemctl.html
[17]: https://github.com/processone/eturnal/blob/1.12.1/overlay/init/sysv/eturnal
[18]: https://github.com/processone/eturnal/blob/1.12.1/overlay/init/openrc/eturnal.initd
[19]: https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html
[20]: https://eturnal.net/doc/
[21]: https://github.com/processone/eturnal/blob/1.12.1/CHANGELOG.md
[22]: https://github.com/processone/eturnal/issues
[23]: https://xmpp.org
[24]: https://eturnal.net/chat/
[25]: https://erlef.org/slack-invite/erlanger