[Closed] Coturn TURN server Docker image
6c25f154
8.1 MB
over 1 year ago
22.7M
Name
Layer
Last update
over 1 year ago
over 1 year ago
over 1 year ago
over 1 year ago
over 1 year ago
over 1 year ago
over 1 year ago
over 1 year ago
over 1 year ago
over 1 year ago
over 1 year ago
Readme

Coturn TURN server Docker image

GitHub release Build Status Docker Pulls

Status

PROJECT IS CLOSED AND ARCHIVED. NO MAINTAINING WILL BE CONTINUED.

Consider to use official coturn/coturn Docker image instead (source repo).

Supported tags and respective Dockerfile links

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 49152-65535:49152-65535/udp instrumentisto/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 49160-49200:49160-49200/udp \
       instrumentisto/coturn -n --log-file=stdout \
                             --external-ip='$(detect-external-ip)' \
                             --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 instrumentisto/coturn

Configuration

By default, default Coturn configuration and CLI options provided in 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 \
           instrumentisto/coturn
    
  2. Or specify command line options directly.

    docker run -d --network=host instrumentisto/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 \
           instrumentisto/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. It's okay to use it multiple times (the value will be evaluated only once).

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

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 \
       instrumentisto/coturn

Image versions

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 version of X Coturn major version.

X.Y

Latest version of X.Y Coturn minor version.

X.Y.Z or X.Y.Z.W

Concrete X.Y.Z or X.Y.Z.W version of Coturn.

License

Coturn is 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.

The sources for producing instrumentisto/coturn Docker images are licensed under Blue Oak Model License 1.0.0.

Issues

We can't notice comments in the DockerHub 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.