Skip to content

Commit

Permalink
README.md: Link to example configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
weiss committed Jun 29, 2020
1 parent 5de3854 commit b143e90
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,10 @@ archive _into_ the `/opt/eturnal` directory:

The eturnal server is configured by editing the `/opt/eturnal/etc/eturnal.yml`
file. This file uses the (indentation-sensitive!) YAML format. A commented
example configuration with sane default settings is shipped with the eturnal
server. However, for TURN relaying to work, you'll have to specify the [shared
authentication][1] `secret`, and probably also the `relay_ipv4_addr` option,
which should be set to the server's external IPv4 address.
[example configuration][7] with sane default settings is shipped with the
eturnal server. However, for TURN relaying to work, you'll have to specify the
[shared authentication][1] `secret`, and probably also the `relay_ipv4_addr`
option, which should be set to the server's external IPv4 address.

> _Note:_ The `/opt/eturnal/etc/eturnal.yml` file can be copied to
> `/etc/eturnal.yml`, in which case the original copy in `/opt` will be ignored.
Expand Down Expand Up @@ -142,7 +142,7 @@ automatically, so there's no need to send a `HUP` signal after log rotation.

## Feedback/Support

Please use [our issue tracker][7] for bug reports and feature requests. Feel
Please use [our issue tracker][8] for bug reports and feature requests. Feel
free to (ab)use it for usage questions as well.

[1]: https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00
Expand All @@ -151,4 +151,5 @@ free to (ab)use it for usage questions as well.
[4]: https://www.openssl.org
[5]: https://gcc.gnu.org
[6]: https://github.com/erlang/rebar3/releases/download/3.14.0-rc2/rebar3
[7]: https://github.com/processone/eturnal/issues
[7]: https://github.com/processone/eturnal/blob/0.4.0/config/eturnal.yml
[8]: https://github.com/processone/eturnal/issues

0 comments on commit b143e90

Please sign in to comment.