Giter Site home page Giter Site logo

woahbase / alpine-coturn Goto Github PK

View Code? Open in Web Editor NEW
19.0 2.0 6.0 25 KB

MultiArch Alpine Linux + S6 + Coturn STUN/TURN Gateway for VoIP.

Home Page: https://woahbase.online/#/images/alpine-coturn

License: MIT License

Makefile 97.11% Dockerfile 2.89%
docker alpine turn stun coturn voip gateway webrtc server

alpine-coturn's Introduction

build status commit version:x86_64 size:x86_64 version:armhf size:armhf version:armv7l size:armv7l version:aarch64 size:aarch64

Container for Alpine Linux + Coturn Stun/Turn Server


This image containerizes the Coturn server to setup a STUN/TURN gateway for VoIP traffic as a micro service.

Based on Alpine Linux from my alpine-s6 image with the s6 init system overlayed in it.

The image is tagged respectively for the following architectures,

  • armhf
  • armv7l
  • aarch64
  • x86_64 (retagged as the latest )

non-x86_64 builds have embedded binfmt_misc support and contain the qemu-user-static binary that allows for running it also inside an x86_64 environment that has it.


Get the Image


Pull the image for your architecture it's already available from Docker Hub.

# make pull
docker pull woahbase/alpine-coturn:x86_64

Configuration Defaults


  • Config file loaded from /var/lib/coturn/turnserver.conf edit or remount this with your own. A default is provided which is auto loaded if there aren't any config file to start with.

  • Data stored at /var/lib/coturn.

  • Default configuration listens to ports 3478 and 5349(TLS), for the latter, you need to update the location where your certs are in the config file.


Run


If you want to run images for other architectures, you will need to have binfmt support configured for your machine. multiarch, has made it easy for us containing that into a docker container.

# make regbinfmt
docker run --rm --privileged multiarch/qemu-user-static:register --reset

Without the above, you can still run the image that is made for your architecture, e.g for an x86_64 machine..

This images already has a user alpine configured to drop privileges to the passed PUID/PGID which is ideal if its used to run in non-root mode. That way you only need to specify the values at runtime and pass the -u alpine if need be. (run id in your terminal to see your own PUID/PGID values.)

Running make starts the service.

# make
docker run --rm -it \
  --name docker_coturn --hostname coturn \
  -c 256 -m 256m \
  -e PGID=1000 -e PUID=1000 \
  -p 5349:5349/udp -p 3478:3478/udp \
  -p 5349:5349/tcp -p 3478:3478/tcp \
  -v /etc/hosts:/etc/hosts:ro \
  -v /etc/localtime:/etc/localtime:ro \
  -v data:/var/lib/coturn \
  woahbase/alpine-coturn:x86_64

Stop the container with a timeout, (defaults to 2 seconds)

# make stop
docker stop -t 2 docker_coturn

Removes the container, (always better to stop it first and -f only when needed most)

# make rm
docker rm -f docker_coturn

Restart the container with

# make restart
docker restart docker_coturn

Shell access


Get a shell inside a already running container,

# make debug
docker exec -it docker_coturn /bin/bash

set user or login as root,

# make rdebug
docker exec -u root -it docker_coturn /bin/bash

To check logs of a running container in real time

# make logs
docker logs -f docker_coturn

Development


If you have the repository access, you can clone and build the image yourself for your own system, and can push after.


Setup


Before you clone the repo, you must have Git, GNU make, and Docker setup on the machine.

git clone https://github.com/woahbase/alpine-coturn
cd alpine-coturn

You can always skip installing make but you will have to type the whole docker commands then instead of using the sweet make targets.


Build


You need to have binfmt_misc configured in your system to be able to build images for other architectures.

Otherwise to locally build the image for your system. [ARCH defaults to x86_64, need to be explicit when building for other architectures.]

# make ARCH=x86_64 build
# sets up binfmt if not x86_64
docker build --rm --compress --force-rm \
  --no-cache=true --pull \
  -f ./Dockerfile_x86_64 \
  --build-arg DOCKERSRC=woahbase/alpine-s6:x86_64 \
  --build-arg PGID=1000 \
  --build-arg PUID=1000 \
  -t woahbase/alpine-coturn:x86_64 \
  .

To check if its working..

# make ARCH=x86_64 test
docker run --rm -it \
  --name docker_coturn --hostname coturn \
  -e PGID=1000 -e PUID=1000 \
  --entrypoint sh \
  woahbase/alpine-coturn:x86_64 \
  -ec 'turnserver -h;'

And finally, if you have push access,

# make ARCH=x86_64 push
docker push woahbase/alpine-coturn:x86_64

Maintenance


Sources at Github. Built at Travis-CI.org (armhf / x64 builds). Images at Docker hub. Metadata at Microbadger.

Maintained by WOAHBase.

alpine-coturn's People

Contributors

lapnapra avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

alpine-coturn's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.