Para chamadas Matrix que falham quando os participantes estão em redes diferentes, implemente o coturn em um host com um IP público, habilite suas credenciais REST TURN com tempo limitado e configure o Synapse com o mesmo segredo compartilhado e URIs TURN. Em seguida, permita o intervalo de listener TURN e relay UDP em todos os firewalls. O STUN pode ajudar os clientes a descobrir caminhos de rede, mas o TURN é o relay que transporta a mídia quando um caminho direto não pode ser estabelecido.
Esta configuração é adequada para um servidor doméstico Synapse auto-hospedado e um host TURN Debian ou Ubuntu separado com um endereço IPv4 público estático. O exemplo usa o listener padrão do coturn na porta 3478 e o intervalo de retransmissão UDP padrão de 49152 a 65535. Substitua o domínio, o segredo e os caminhos do exemplo pelos seus próprios. Se o coturn estiver atrás de um NAT, consulte a nota sobre NAT abaixo; um host público diretamente acessível é mais simples e confiável.
1. Aponte um nome de host TURN para o servidor.
Crie um registro DNS A que turn.example.comaponte para o endereço IPv4 público do host do coturn. Use um nome de host dedicado para que suas configurações de rede e certificado possam ser gerenciadas independentemente do serviço web Matrix. Não publique um registro AAAA a menos que o coturn tenha conectividade IPv6 funcionando e as regras de firewall correspondentes; um endereço IPv6 inacessível pode fazer com que alguns clientes escolham um caminho que falhe.
A documentação atual do TURN da Synapse afirma que o serviço TURN precisa de um endpoint IP público. O NAT só funciona quando o gateway possui um endereço público e encaminha as portas necessárias corretamente, e a documentação alerta que as configurações de NAT ainda podem ser instáveis. Consulte a documentação de configuração do TURN da Synapse .
2. Instale o coturn e configure o relay autenticado.
No Debian ou Ubuntu, instale o pacote de distribuição:
sudo apt update
sudo apt install coturn
Abra o arquivo /etc/turnserver.confcom um editor de texto e configure as opções essenciais abaixo. Gere uma senha longa e aleatória usando um gerenciador de senhas ou um gerador criptograficamente seguro. Insira essa senha exata no Synapse posteriormente; não reutilize uma senha de usuário do Matrix nem exponha a senha em um repositório público.
listening-port=3478
fingerprint
use-auth-secret
static-auth-secret=REPLACE_WITH_A_LONG_RANDOM_SECRET
realm=turn.example.com
server-name=turn.example.com
min-port=49152
max-port=65535
use-auth-secrete static-auth-secrethabilite o mecanismo de credenciais REST do TURN que o Synapse usa para emitir credenciais temporárias. realmDeve ser um nome de domínio para o seu serviço TURN. O intervalo de portas de retransmissão é separado do ouvinte: os clientes contatam a porta 3478 para solicitar uma alocação e, em seguida, a mídia usa as portas de retransmissão alocadas. Os documentos de configuração de exemplo do coturn detalham as opções de ouvinte, retransmissão, TLS e IP externo; os padrões e caminhos dos pacotes de distribuição podem ser diferentes.
Habilite e inicie o serviço e, em seguida, verifique seu status:
sudo systemctl enable --now coturn
sudo systemctl status coturn
Se o seu pacote tiver um parâmetro de ativação separado em /etc/default/coturn, siga as instruções desse arquivo antes de iniciar o serviço. Verifique os logs com sudo journalctl -u coturn -ecaso ele não inicie.
3. Permitir tráfego de escuta e retransmissão
Permita o tráfego UDP e TCP de entrada na porta 3478, além das portas UDP de entrada 49152 a 65535, no firewall do host e em qualquer firewall de nível de provedor. Por exemplo, com o UFW:
sudo ufw allow 3478/udp
sudo ufw allow 3478/tcp
sudo ufw allow 49152:65535/udp
sudo ufw status
Mantenha o intervalo de retransmissão o mais restrito possível dentro dos limites da sua implementação e configure os servidores TURN min-portde max-portforma que correspondam ao intervalo do firewall. Se você habilitar um ouvinte TLS, abra também a porta configurada e utilize o turns:URI e as configurações de certificado correspondentes. O TLS na conexão TURN é opcional neste exemplo básico; as instruções do Synapse observam que a mídia de voz e vídeo WebRTC permanece criptografada mesmo quando o TURN usa seu ouvinte UDP/TCP simples, enquanto a segurança da sinalização depende da sua configuração HTTPS do Matrix.
Para um host atrás de um NAT, configure external-ip=PUBLIC_IP/PRIVATE_IPo mapeamento do coturn e encaminhe tanto a porta 3478 quanto todo o intervalo de retransmissão para o host do coturn, sem alterar os números das portas de retransmissão externas. Por exemplo, uma porta de retransmissão pública 52000 deve alcançar a porta interna 52000. As orientações da Synapse indicam que o NAT ainda pode causar problemas; se você não puder encaminhar um amplo intervalo de UDP, geralmente é mais prático hospedar o coturn em um VPS com IP público.
4. Conecte o Synapse ao coturn
Adicione as seguintes configurações ao arquivo de configuração ativo do Synapse, geralmente homeserver.yaml`./synapse.conf`. O nome do host, a porta e o segredo devem corresponder à configuração do coturn:
turn_uris:
- "turn:turn.example.com:3478?transport=udp"
- "turn:turn.example.com:3478?transport=tcp"
turn_shared_secret: "REPLACE_WITH_A_LONG_RANDOM_SECRET"
turn_user_lifetime: 86400000
turn_allow_guests: false
O valor de tempo de vida é em milissegundos; este exemplo solicita ao Synapse que emita credenciais válidas por 24 horas. Configure o acesso de convidados de acordo com sua política de registro; não é necessário apenas habilitar chamadas para usuários registrados. Mantenha o URI turn_shared_secretprivado e idêntico ao do coturn static-auth-secret. Não adicione um stun:URI como substituto para o TURN: os dois protocolos desempenham funções relacionadas, mas diferentes.
Reinicie o Synapse após validar a sintaxe YAML:
sudo systemctl restart matrix-synapse.service
sudo systemctl status matrix-synapse.service
As implantações de contêineres devem atualizar a configuração do Synapse montada e reiniciar o contêiner do Synapse. Os clientes podem precisar recarregar ou atualizar a configuração do servidor; o Synapse observa que a atualização das configurações TURN pelos clientes pode levar até uma hora.
Verificar um candidato a retransmissão
Faça o teste a partir de um navegador ou dispositivo em uma rede diferente do servidor TURN, como um telefone usando dados móveis. Em um cliente Matrix baseado em navegador, inspecione a solicitação autenticada do servidor doméstico /_matrix/client/v3/voip/turnServer(clientes mais antigos podem usar o /r0/caminho legado). A resposta deve incluir URIs TURN e campos temporários de nome de usuário/senha; a especificação Matrix define a resposta de credenciais deste endpoint.
Use essas credenciais no teste oficial WebRTC Trickle ICE , insira um servidor como turn:turn.example.com:3478?transport=udp<server> e selecione o teste de retransmissão se a página oferecer filtragem por tipo de candidato. Um resultado bem-sucedido inclui um candidato cujo tipo é <type> relay. Por fim, faça uma chamada Matrix entre dispositivos em redes separadas. Uma chamada que toca, mas permanece em "conectando", geralmente indica portas de retransmissão bloqueadas, um mapeamento NAT incorreto ou credenciais incompatíveis; verifique os logs do coturn e as notas de solução de problemas TURN do Synapse antes de alterar configurações de chamada não relacionadas.
Para diagnósticos de navegador, a Synapse recomenda chrome://webrtc-internals/o uso do Chrome e about:webrtcdo Firefox. Se o candidato a servidor de retransmissão não aparecer, primeiro confirme se a chave secreta corresponde exatamente e, em seguida, verifique a porta UDP 3478 e todo o intervalo de retransmissão nos firewalls do host e do provedor. O projeto coturn documenta as opções de porta e IP externo em sua referência turnserver .