diff --git a/CHANGELOG.md b/CHANGELOG.md index 6682bd1d4..fa7245c0e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning][SemVer]. ## [Unreleased] + +## [1.0.0] - 2020-07-13 ### Added - Allow for setting the `log_dir` option to the special value `stdout`, which tells eturnal to print log messages to the standard output rather than logging @@ -13,6 +15,9 @@ project adheres to [Semantic Versioning][SemVer]. ### Changed - Allow for binding to privileged ports (if started via systemd). - Disable TURN support in the example configuration file. +- If the distribution provides an `epmd.service`, make sure eturnal uses it + rather than starting its own epmd instance. +- Don't bind epmd to 127.0.0.1 by default. ### Fixed - Only signal readiness to systemd if eturnal's startup actually was successful. @@ -92,7 +97,8 @@ project adheres to [Semantic Versioning][SemVer]. ### Added - Initial (pre-)release of the eturnal STUN/TURN server. -[Unreleased]: https://github.com/processone/eturnal/compare/0.8.0...HEAD +[Unreleased]: https://github.com/processone/eturnal/compare/1.0.0...HEAD +[1.0.0]: https://github.com/processone/eturnal/releases/tag/1.0.0 [0.8.0]: https://github.com/processone/eturnal/releases/tag/0.8.0 [0.7.0]: https://github.com/processone/eturnal/releases/tag/0.7.0 [0.6.0]: https://github.com/processone/eturnal/releases/tag/0.6.0 diff --git a/README.md b/README.md index bd2c3975b..cca651979 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,13 @@ release](#installation-on-linuxx64-systems). On other platforms, eturnal is On **DEB-based** Linux/x64 distributions, run: - $ curl -O https://eturnal.net/download/package/eturnal_0.8.0-1_amd64.deb - $ sudo dpkg -i eturnal_0.8.0-1_amd64.deb + $ curl -O https://eturnal.net/download/package/eturnal_1.0.0-1_amd64.deb + $ sudo dpkg -i eturnal_1.0.0-1_amd64.deb On **RPM-based** Linux/x64 distributions, run: - $ curl -O https://eturnal.net/download/package/eturnal-0.8.0-1.x86_64.rpm - $ sudo rpm -i eturnal-0.8.0-1.x86_64.rpm + $ curl -O https://eturnal.net/download/package/eturnal-1.0.0-1.x86_64.rpm + $ sudo rpm -i eturnal-1.0.0-1.x86_64.rpm $ sudo systemctl daemon-reload $ sudo systemctl enable eturnal $ sudo systemctl start eturnal @@ -49,11 +49,11 @@ and `openssl-devel`. > official source tarball, you must [download rebar3][9] and make it executable > (`chmod +x rebar3`), first. - $ curl https://eturnal.net/download/eturnal-0.8.0.tar.gz | tar -C /tmp -xzf - - $ cd /tmp/eturnal-0.8.0 + $ curl https://eturnal.net/download/eturnal-1.0.0.tar.gz | tar -C /tmp -xzf - + $ cd /tmp/eturnal-1.0.0 $ ./rebar3 as prod tar -This generates the archive file `_build/prod/rel/eturnal/eturnal-0.8.0.tar.gz`. +This generates the archive file `_build/prod/rel/eturnal/eturnal-1.0.0.tar.gz`. The default installation prefix is set to `/opt/eturnal`, and it's assumed the server will be executed by a user named `eturnal`. To change these defaults, edit the `build.config` file, re-run `./rebar3 as prod tar`, and adapt the @@ -76,7 +76,7 @@ or `sudo -i`, first. 2. Extract the archive generated [above](#compilation): # cd /opt/eturnal - # tar -xzf /tmp/eturnal-0.8.0/_build/prod/rel/eturnal/eturnal-0.8.0.tar.gz + # tar -xzf /tmp/eturnal-1.0.0/_build/prod/rel/eturnal/eturnal-1.0.0.tar.gz 3. Copy the `eturnal.yml` file to `/etc` (optional): @@ -154,8 +154,8 @@ free to (ab)use it for usage questions as well. If you happen to be using [8]: https://gcc.gnu.org [9]: https://github.com/erlang/rebar3/releases/download/3.14.0-rc2/rebar3 [10]: https://en.wikipedia.org/wiki/YAML -[11]: https://github.com/processone/eturnal/blob/0.8.0/config/eturnal.yml +[11]: https://github.com/processone/eturnal/blob/1.0.0/config/eturnal.yml [12]: https://eturnal.net/documentation/ -[13]: https://github.com/processone/eturnal/blob/0.8.0/CHANGELOG.md +[13]: https://github.com/processone/eturnal/blob/1.0.0/CHANGELOG.md [14]: https://github.com/processone/eturnal/issues [15]: https://xmpp.org diff --git a/doc/overview.edoc b/doc/overview.edoc index 8ad88c7da..3c2d12aa0 100644 --- a/doc/overview.edoc +++ b/doc/overview.edoc @@ -19,7 +19,7 @@ limitations under the License. -------------------------------------------------------------------------------- @title eturnal STUN/TURN Server Documentation -@version 0.8.0 ({@date}) +@version 1.0.0 ({@date}) @copyright 2020 ProcessOne, SARL @author Holger Weiss @@ -35,7 +35,7 @@ credentials and eturnal. The service offering the credentails performs a password, and eturnal does the same to verify it. The README.md +href="https://github.com/processone/eturnal/blob/1.0.0/README.md">README.md file shipped with eturnal should get you started quickly. For details, see the reference documentation below. @@ -43,12 +43,12 @@ reference documentation below. Linux/x64 packages for DEB- and RPM-based distributions can be retrieved from [https://eturnal.net/download/package/]. On other Linux/x64 systems, the binary +href="https://eturnal.net/download/eturnal-1.0.0-linux-x64.tar.gz">binary release can be installed as described in this section. For building eturnal from source, see the README.md +href="https://github.com/processone/eturnal/blob/1.0.0/README.md#building-from-source">README.md file shipped with eturnal's source code +href="https://eturnal.net/download/eturnal-1.0.0.tar.gz">source code archive. The binary release archive holds a stand-alone directory that includes @@ -59,11 +59,11 @@ commands with superuser privileges: ``` # useradd -r -d /opt/eturnal eturnal -# curl https://eturnal.net/download/eturnal-0.8.0-linux-x64.tar.gz | tar -C /opt -xzf - +# curl https://eturnal.net/download/eturnal-1.0.0-linux-x64.tar.gz | tar -C /opt -xzf - ''' The example configuration +href="https://github.com/processone/eturnal/blob/1.0.0/config/eturnal.yml">configuration file shipped with eturnal can either be edited in place or copied into the system's `/etc' directory, first: diff --git a/scripts/get-version b/scripts/get-version index e9b129464..0e5251d5a 100755 --- a/scripts/get-version +++ b/scripts/get-version @@ -7,7 +7,7 @@ set -u export PATH='/usr/local/bin:/usr/bin:/bin' -rel_vsn='0.8.0' +rel_vsn='1.0.0' ( git describe --tags --match '[0-9]*' 2>'/dev/null' || echo "$rel_vsn" ) \ | sed -e 's/-g.*//' -e 's/-/+/' | tr -d '[:space:]'