Skip to content

Latest commit

 

History

History
242 lines (132 loc) · 7.94 KB

README.md

File metadata and controls

242 lines (132 loc) · 7.94 KB
Raw

Coturn TURN server Docker image

Docker CI Docker Hub

Docker Hub | GitHub Container Registry | Quay.io

Changelog

Supported tags and respective Dockerfile links

Supported platforms

  • linux: amd64, arm32v6, arm32v7, arm64v8, i386, ppc64le, s390x

What is Coturn TURN server?

The TURN Server is a VoIP media traffic NAT traversal server and gateway. It can be used as a general-purpose network traffic TURN server and gateway, too.

github.com/coturn/coturn

How to use this image

To run Coturn TURN server just start the container:

docker run -d -p 3478:3478 -p 3478:3478/udp -p 5349:5349 -p 5349:5349/udp -p 49152-65535:49152-65535/udp coturn/coturn

Why so many ports opened?

As per RFC 5766 Section 6.2, these are the ports that the TURN server will use to exchange media.

You can change them with min-port and max-port Coturn configuration options:

docker run -d -p 3478:3478 -p 3478:3478/udp -p 5349:5349 -p 5349:5349/udp -p 49160-49200:49160-49200/udp \
       coturn/coturn --min-port=49160 --max-port=49200

Or just use the host network directly (recommended, as Docker performs badly with large port ranges):

docker run -d --network=host coturn/coturn

Configuration

By default, default Coturn configuration and CLI options provided in the CMD Dockerfile instruction are used.

  1. You may either specify your own configuration file instead.

    docker run -d --network=host \
           -v $(pwd)/my.conf:/etc/coturn/turnserver.conf \
       coturn/coturn

  2. Or specify command line options directly.

    docker run -d --network=host coturn/coturn \
           -n --log-file=stdout \
           --min-port=49160 --max-port=49200 \
           --lt-cred-mech --fingerprint \
           --no-multicast-peers --no-cli \
           --no-tlsv1 --no-tlsv1_1 \
           --realm=my.realm.org \

  3. Or even specify another configuration file.

    docker run -d --network=host  \
           -v $(pwd)/my.conf:/my/coturn.conf \
       coturn/coturn -c /my/coturn.conf

Automatic detection of external IP

detect-external-ip binary may be used to automatically detect external IP of TURN server in runtime. To add --external-ip=<detected external IP> using detect-external-ip as argument for turnserver, set envronment variable DETECT_EXTERNAL_IP. Also, environment variables DETECT_RELAY_IP, DETECT_EXTERNAL_IPV6 and DETECT_RELAY_IPV6 can be used for adding arguments --external-ip=<detected external IP> or --relay-ip=<detected external IP>. It's okay to use it multiple times (the value will be evaluated only once).

docker run -d --network=host \
           -e DETECT_EXTERNAL_IP=yes \
           -e DETECT_RELAY_IP=yes \
           coturn/coturn \
           -n --log-file=stdout

By default, IPv4 address is discovered. In case you need an IPv6 one, specify the --ipv6 flag:

docker run -d --network=host coturn/coturn \
           -n --log-file=stdout \
           --external-ip='$(detect-external-ip --ipv6)' \
           --relay-ip='$(detect-external-ip --ipv6)'

Persistence

By default, Coturn Docker image persists its data in /var/lib/coturn/ directory.

You can speedup Coturn simply by using tmpfs for that:

docker run -d --network=host --mount type=tmpfs,destination=/var/lib/coturn coturn/coturn

Image versions

alpine

This image is based on the popular Alpine Linux project, available in the alpine official image. Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.

This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use musl libc instead of glibc and friends, so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See this Hacker News comment thread for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.

<X>

Latest tag of the latest major X Coturn version.

This is a multi-platform image.

<X.Y>

Latest tag of the latest minor X.Y Coturn version.

This is a multi-platform image.

<X.Y.Z>/<X.Y.Z.W>

Latest tag of the concrete X.Y.Z (or X.Y.Z.W) Coturn version.

This is a multi-platform image.

<X.Y.Z>-r<N>/<X.Y.Z.W>-r<N>

Concrete N image revision tag of the concrete X.Y.Z (or X.Y.Z.W) Coturn version.

Once built, it's never updated.

This is a multi-platform image.

<X.Y.Z>-r<N>-<dist>/<X.Y.Z.W>-r<N>-<dist>

Concrete N image revision tag of the concrete X.Y.Z (or X.Y.Z.W) Coturn version on the concrete dist (alpine or debian).

Once built, it's never updated.

This is a multi-platform image.

<X.Y.Z>-r<N>-<dist>-<arch>/<X.Y.Z.W>-r<N>-<dist>-<arch>

Concrete N image revision tag of the concrete X.Y.Z (or X.Y.Z.W) Coturn version on the concrete dist (alpine or debian) and arch.

Once build, it's never updated.

This is a single-platform image.

edge-<dist>

Latest tag of the latest master branch of Coturn on the concrete dist (alpine or debian).

This is a multi-platform image.

edge-<dist>-<arch>

Latest tag of the latest master branch of Coturn on the concrete dist (alpine or debian) and arch.

This is a single-platform image.

License

Coturn and its Docker images are licensed under this license.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

Issues

We can't notice comments in the DockerHub (or other container registries) so don't use them for reporting issue or asking question.

If you have any problems with or questions about this image, please contact us through a GitHub issue.