Installing Conference Calling 2.0 (aka SFT)¶

Background¶

Please refer to the following section to better understand SFT and how it works.

As part of the wire-server umbrella chart¶

The sftd is packaged as its own Helm chart.

In your ./values/sftd/values.yaml file you should set the following settings:

1
2

host: sftd.example.com # Replace example.com with your domain
allowOrigin: https://webapp.example.com # Should be the address you used for the webapp deployment (Note: you must include the uri scheme "https://")

In your secrets.yaml you should set the TLS keys for sftd domain:

1
2
3
4
5

tls:
  crt: |
    <TLS CRT HERE>
  key: |
    <TLS KEY HERE>

You should also make sure that you configure brig to know about the SFT server in your ./values/wire-server/values.yaml file:

1
2
3

brig:
  optSettings:
    setSftStaticUrl: "https://sftd.example.com:443"

Now you can deploy as usual:

1

helm upgrade wire-server wire/wire-server --values ./values/wire-server/values.yaml

By default sftd doesn’t need to set that many options, so we define them inline. However, you could of course also set these values in a values.yaml file.

SFT will deploy a Kubernetes Ingress on $SFTD_HOST. Make sure that the domain name $SFTD_HOST points to your ingress IP as set up in Installing wire-server (production) components using Helm. The SFT also needs to be made aware of the domain name of the webapp that you set up in Installing wire-server (production) components using Helm for setting up the appropriate CSP headers.

1
2

export SFTD_HOST=sftd.example.com
export WEBAPP_HOST=webapp.example.com

Now you can install the chart:

1
2
3
4
5

helm install sftd sftd  \
  --set host=$SFTD_HOST \
  --set allowOrigin=https://$WEBAPP_HOST \
  --set-file tls.crt=/path/to/tls.crt \
  --set-file tls.key=/path/to/tls.key

You should also make sure that you configure brig to know about the SFT server, in the ./values/wire-server/values.yaml file:

1
2
3

brig:
  optSettings:
    setSftStaticUrl: "https://sftd.example.com:443"

And then roll-out the change to the wire-server chart

1

helm upgrade wire-server wire/wire-server --values ./values/wire-server/values.yaml

For more advanced setups please refer to the technical documentation.

Firewall rules¶

The SFT allocates media addresses in the UDP default port range. Ingress and egress traffic should be allowed for this range. Furthermore the SFT needs to be able to reach the Restund server, as it uses STUN and TURN in cases the client can not directly connect to the SFT. In practise this means the SFT should allow ingress and egress traffic on the UDP default port range from and to both, clients and Restund servers.

For more information on this port range, how to read and change it, and how to configure your firewall, please see this note.

The SFT also has an HTTP interface for initializing (allocation) or joining (signaling) a call. This is exposed through the ingress controller as an HTTPS service.

SFT does require access to the TURN control port during process startup, but does not use it for any real purpose. It is a health check, that is going to be removed eventually.

An SFT instance does not communicate with other SFT instances, TURN does talk to TURN.

Recapitulation table:

For more information, please refer to the source code of the Ansible role: sft-server.