Skip to content

Commit

Permalink
README.md: Mention Gentoo and FreeBSD ports
Browse files Browse the repository at this point in the history
  • Loading branch information
weiss committed Nov 15, 2024
1 parent 2684fc6 commit 97f1bae
Showing 1 changed file with 33 additions and 30 deletions.
63 changes: 33 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,10 @@ 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]. On **other Linux systems**, the binary release can be installed as
[described][9] in the reference documentation. For **Windows**, an installer is
[available][10].
[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:

Expand All @@ -61,12 +62,12 @@ brew tap processone/eturnal https://github.com/processone/eturnal
brew install processone/eturnal/eturnal
```

On **other platforms**, eturnal is [built from source][11].
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][12] format. For TURN relaying to
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
Expand All @@ -80,13 +81,13 @@ eturnal:
relay_ipv6_addr: "2001:db8::4" # The server's public IPv6 address (optional).
```
A more detailed, commented [example configuration][13] is shipped with the
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][14]. For
non-systemd platforms, example [init][15] and [OpenRC][16] scripts are shipped
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:
Expand All @@ -98,22 +99,22 @@ 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][17]
`/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][18]. For notable changes
between eturnal releases, see the [change log][19].
`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][20] for bug reports and feature requests. Feel
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][21], you could also join our public room
`[email protected]`. Otherwise, just use the [web client][22].
As an alternative, there's an `#eturnal` channel [on Slack][23].
[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/
Expand All @@ -123,18 +124,20 @@ As an alternative, there's an `#eturnal` channel [on Slack][23].
[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://eturnal.net/doc/#Installation
[10]: https://eturnal.net/windows/
[11]: https://eturnal.net/doc/install.html
[12]: https://en.wikipedia.org/wiki/YAML
[13]: https://github.com/processone/eturnal/blob/1.12.1/config/eturnal.yml
[14]: https://www.freedesktop.org/software/systemd/man/systemctl.html
[15]: https://github.com/processone/eturnal/blob/1.12.1/overlay/init/sysv/eturnal
[16]: https://github.com/processone/eturnal/blob/1.12.1/overlay/init/openrc/eturnal.initd
[17]: https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html
[18]: https://eturnal.net/doc/
[19]: https://github.com/processone/eturnal/blob/1.12.1/CHANGELOG.md
[20]: https://github.com/processone/eturnal/issues
[21]: https://xmpp.org
[22]: https://eturnal.net/chat/
[23]: https://erlef.org/slack-invite/erlanger
[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

0 comments on commit 97f1bae

Please sign in to comment.