freeswitch-container

Concept

This is a freeswitch container for easy localisation. The concept is to regenerate vars.xml at startup, depending on the existence of a file localvars in freeswitchs /etc/freeswitch directory.

The Dockerfile contains an environment from which the Values are derived. This environment provides the defaults and looks like this:

ENV DEFAULT_PASSWORD='napw' \
    SOUND_PREFIX='$${sounds_dir}/en/us/callie' \
    DOMAIN='$${local_ip_v4}' \
    DOMAIN_NAME='$${domain}' \
    GLOBAL_CODEC_PREFS='OPUS,G722,H264,VP8' \
    OUTBOUND_CODEC_PREFS='OPUS,G722,H264,VP8' \
    EXTERNAL_RTP_IP='$${local_ip_v4}' \
    EXTERNAL_SIP_IP='$${local_ip_v4}' \
    XML_RPC_PASSWORD='napw' \
    INTERNAL_SIP_PORT='5060' \
    EXTERNAL_SIP_PORT='5080' \
    SIP_TLS_VERSION='tlsv1,tlsv1.1,tlsv1.2' \
    INTERNAL_TLS_PORT='3361' \
    INTERNAL_SSL_ENABLE='true' \
    EXTERNAL_TLS_PORT='3381' \
    EXTERNAL_SSL_ENABLE='false' \
    SIP_TLS_CIPHERS='ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH' \
    VERTO_BINDLOCAL_PORT='8082' \
    INTERNAL_TLS_ONLY='false' \
    ES_LISTEN_IP='127.0.0.1' \
    ES_LISTEN_PORT='8021' \
    ES_PW='ClueCon' \
    DEFCONPIN='0815' \
    MODCONPIN='2357' \
    CAPEM_URL='https://letsencrypt.org/certs/trustid-x3-root.pem.txt' \
    RECORDINGSDIR='/recordings'

You can overwrite each of the Variables during start of an instance container of this image.

If you use a persistent volume for /etc/freeswitch the vars.xml will only be rewritten at the first start. Either with the defaults, or, depending on which environment you set, with other values (plus the defaults for unset values), and the file /etc/freeswitch/localvars will be created. As localvars now exists on the persistent volume, vars.xml won't be rewritten anymore, unless you delete localvars, and start a new instance of the image with the same Volume mountet at /etc/freeswitch.

To see how this is implemented look at localvars.sh.

Also, there are 2 Variables concerning TLS-encryption:

ENV CRYPTDOM example.com
ENV CAPEM_URL https://letsencrypt.org/certs/trustid-x3-root.pem.txt

These are used by the optional entypoint-subscript letsencrypt-cert-load.sh. See this README for these.

Usage

It is recommended to start instances of this freeswitch image with hostnetworking, since the minimal config provided is not prepared for NAT handling, and for performance reasons.

If you want to run a container in a production environment you will need working TLS, which means certificates acceptet by your clients. One way to get the certs is letsencrypt, see here for an example.

Freeswitch needs the certs in a certain format, for the case of letsencrypt certs there is a script provided here. This is just an example, and the script will not run if you don't provide the necessary environment or volume mount. Since certificates need renewal from time to time, the example uses the same "file exists?" logic as the vars mechanism, combined with a check for the right CRYPTDOM environment.

Example start (you can replace podman with docker):

podman run --name=freeswitch \
  --env CRYPTDOM="example.com" \
  -v freeswitch_etc-freeswitch:/etc/freeswitch \
  -v freeswitch_recordings:/recordings \
  -v certbot_etc-letsencrypt:/etc-letsencrypt \
  --network=host \
  --env DOMAIN_NAME="example.com" \
  --env DOMAIN="example.com" \
  gidmoth/freeswitch:latest freeswitch

gidmoth/freeswitch-container

freeswitch-container

Concept

Usage