Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/instrumentisto/coturn-docker-image
[Closed] Coturn TURN server Docker image
https://github.com/instrumentisto/coturn-docker-image
coturn coturn-docker docker-coturn docker-stun docker-turn stun stun-docker stunserver turn turn-docker turnserver
Last synced: 5 days ago
JSON representation
[Closed] Coturn TURN server Docker image
- Host: GitHub
- URL: https://github.com/instrumentisto/coturn-docker-image
- Owner: instrumentisto
- License: other
- Archived: true
- Created: 2018-05-17T13:29:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-06T11:09:37.000Z (over 3 years ago)
- Last Synced: 2024-08-01T12:36:28.559Z (3 months ago)
- Topics: coturn, coturn-docker, docker-coturn, docker-stun, docker-turn, stun, stun-docker, stunserver, turn, turn-docker, turnserver
- Language: Makefile
- Homepage:
- Size: 34.2 KB
- Stars: 190
- Watchers: 9
- Forks: 46
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - instrumentisto/coturn-docker-image - [Closed] Coturn TURN server Docker image (others)
README
Coturn TURN server Docker image
===============================
[](https://hub.docker.com/r/instrumentisto/coturn/tags) [](https://travis-ci.org/instrumentisto/coturn-docker-image) [](https://hub.docker.com/r/instrumentisto/coturn)
## Status
__PROJECT IS CLOSED AND ARCHIVED. NO MAINTAINING WILL BE CONTINUED.__
Consider to use [official `coturn/coturn` Docker image](https://hub.docker.com/r/coturn/coturn) instead ([source repo](https://github.com/coturn/coturn/tree/master/docker/coturn)).
## Supported tags and respective `Dockerfile` links
- [`4.5.2`, `4.5`, `4`, `latest`][Dockerfile]
## 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](https://github.com/coturn/coturn)
## How to use this image
To run Coturn TURN server just start the container:
```bash
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:
```bash
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][7]):
```bash
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.
```bash
docker run -d --network=host \
-v $(pwd)/my.conf:/etc/coturn/turnserver.conf \
instrumentisto/coturn
```
2. Or specify command line options directly.
```bash
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.
```bash
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).
```bash
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:
```bash
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][1], available in [the alpine official image][2]. 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][4] instead of [glibc and friends][5], 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][6] 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][92].
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][90] for producing `instrumentisto/coturn` Docker images are licensed under [Blue Oak Model License 1.0.0][91].
## 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][3].
[1]: http://alpinelinux.org
[2]: https://hub.docker.com/_/alpine
[3]: https://github.com/instrumentisto/coturn-docker-image/issues
[4]: http://www.musl-libc.org
[5]: http://www.etalabs.net/compare_libcs.html
[6]: https://news.ycombinator.com/item?id=10782897
[7]: https://github.com/instrumentisto/coturn-docker-image/issues/3
[90]: https://github.com/instrumentisto/coturn-docker-image
[91]: https://github.com/instrumentisto/coturn-docker-image/blob/master/LICENSE.md
[92]: https://github.com/coturn/coturn/blob/master/LICENSE
[Dockerfile]: https://github.com/instrumentisto/coturn-docker-image/blob/master/Dockerfile
[RFC 5766 Section 6.2]: https://tools.ietf.org/html/rfc5766.html#section-6.2