You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Joachim Bauch 3714de9822
Merge pull request #371 from strukturag/dependabot/go_modules/github.com/nats-io/nats-server/v2-2.9.8
1 week ago
.github build(deps): Bump golangci/golangci-lint-action from 3.3.0 to 3.3.1 3 weeks ago
client Add hello version "2.0" that authenticates connections using a JWT. 4 months ago
dist/init/systemd remove @resources from SystemCallFilter 4 months ago
docker Add official docker images. 4 months ago
docs build(deps): Bump sphinx-rtd-theme from 1.1.0 to 1.1.1 in /docs 4 weeks ago
proxy Add hello version "2.0" that authenticates connections using a JWT. 4 months ago
scripts Fix issues reported by revive. 10 months ago
server Allow configuring backends through etcd. 5 months ago
.dockerignore Add official docker images. 4 months ago
.gitignore Add initial clustering support. 5 months ago
.golangci.yml CI: Ignore "error-strings" for revive linter. 9 months ago
.readthedocs.yaml CI: Pin dependencies to fix readthedocs build. 8 months ago
CHANGELOG.md Update changelog for 1.0.0 4 months ago
LICENSE Initial commit of the OpenSource version. 3 years ago
Makefile vendor: Automatically vendor protobuf modules. 4 months ago
README.md Add official docker images. 4 months ago
api_async.go Send initial user flags to internal sessions asynchronously. 5 months ago
api_backend.go Add hello version "2.0" that authenticates connections using a JWT. 4 months ago
api_backend_test.go Switch dependency tracking to Go modules. 2 years ago
api_grpc.go Allow configuring GRPC targets through etcd. 5 months ago
api_proxy.go Add hello version "2.0" that authenticates connections using a JWT. 4 months ago
api_signaling.go Add feature flag for hello version 2.0 4 months ago
api_signaling_test.go Add hello version "2.0" that authenticates connections using a JWT. 4 months ago
async_events.go Trigger "joined" events through async messages. 5 months ago
async_events_nats.go Trigger "joined" events through async messages. 5 months ago
async_events_test.go Refactor asynchronous events to central location. 5 months ago
backend_client.go Allow configuring backends through etcd. 5 months ago
backend_client_test.go Allow configuring backends through etcd. 5 months ago
backend_configuration.go Implement per-backend session limit for clusters. 5 months ago
backend_configuration_stats_prometheus.go Add more metrics on rooms / sessions / backends. 1 year ago
backend_configuration_test.go Allow configuring backends through etcd. 5 months ago
backend_server.go Disconnect sessions with the same room session id synchronously. 5 months ago
backend_server_test.go Only send single "incall" message with "all: true" in clustered setup. 5 months ago
backend_storage_etcd.go Implement per-backend session limit for clusters. 5 months ago
backend_storage_static.go Implement per-backend session limit for clusters. 5 months ago
backoff.go Add helper to wait with exponential backoff. 5 months ago
backoff_test.go Add helper to wait with exponential backoff. 5 months ago
capabilities.go Update capabilities if no hello v2 token key is found in cache. 4 months ago
capabilities_test.go Update capabilities if no hello v2 token key is found in cache. 4 months ago
certificate_reloader.go Add certificate reloader class. 5 months ago
certificate_reloader_test.go Add certificate reloader class. 5 months ago
client.go Fix issues reported by revive. 10 months ago
client_stats_prometheus.go Add more metrics on rooms / sessions / backends. 1 year ago
clientsession.go Use "defer" to re-acquire released lock. 3 months ago
clientsession_test.go Add hello version "2.0" that authenticates connections using a JWT. 4 months ago
concurrentmap.go Switch dependency tracking to Go modules. 2 years ago
concurrentmap_test.go Switch dependency tracking to Go modules. 2 years ago
continentmap.go Fix issues reported by revive. 10 months ago
deferred_executor.go Switch dependency tracking to Go modules. 2 years ago
deferred_executor_test.go Fix issues reported by revive. 10 months ago
etcd_client.go etcd: Fix race in initialized event. 5 months ago
etcd_client_test.go etcd: Fix race in initialized event. 5 months ago
geoip.go Stop using deprecated ioutil package. 8 months ago
geoip_test.go Stop using deprecated ioutil package. 8 months ago
gnatsd.conf Initial commit of the OpenSource version. 3 years ago
go.mod Merge pull request #371 from strukturag/dependabot/go_modules/github.com/nats-io/nats-server/v2-2.9.8 1 week ago
go.sum Merge pull request #371 from strukturag/dependabot/go_modules/github.com/nats-io/nats-server/v2-2.9.8 1 week ago
grpc_backend.proto Implement per-backend session limit for clusters. 5 months ago
grpc_client.go Implement per-backend session limit for clusters. 5 months ago
grpc_client_test.go grpc: Reload certificate if file has changed and support mutual authentication. 5 months ago
grpc_common.go grpc: Always use reloadable credentials. 5 months ago
grpc_common_test.go Make sure replaced files have different modification times. 5 months ago
grpc_internal.proto grpc: Automatically detect if a target is the current server itself. 5 months ago
grpc_mcu.proto Add initial clustering support. 5 months ago
grpc_server.go Implement per-backend session limit for clusters. 5 months ago
grpc_server_test.go Make sure replaced files have different modification times. 5 months ago
grpc_sessions.proto Disconnect sessions with the same room session id synchronously. 5 months ago
grpc_stats_prometheus.go Add metrics for GRPC calls. 5 months ago
http_client_pool.go Use proxy from environment for backend client requests. 3 months ago
http_client_pool_test.go Move capabilities handling to own file and refactor http client pool. 7 months ago
hub.go Update capabilities if no hello v2 token key is found in cache. 4 months ago
hub_stats_prometheus.go Add more metrics on rooms / sessions / backends. 1 year ago
hub_test.go Update capabilities if no hello v2 token key is found in cache. 4 months ago
janus_client.go Update comment to match new gofmt output. 4 months ago
lru.go Switch dependency tracking to Go modules. 2 years ago
lru_test.go Switch dependency tracking to Go modules. 2 years ago
mcu_common.go Add specific ID for connections 7 months ago
mcu_common_test.go Lint prometheus stats. 1 year ago
mcu_janus.go Support toggling audio/video in subscribed streams. 7 months ago
mcu_janus_test.go Lint prometheus stats. 1 year ago
mcu_proxy.go Log error responses when deleting proxy publishers / subscribers. 3 months ago
mcu_proxy_test.go Update tests for new continent map. 1 year ago
mcu_stats_prometheus.go Also track subscriber streams by type. 1 year ago
mcu_test.go Fix handling of "unshareScreen" messages and add test. 5 months ago
mkdocs.yml Add documentation on the available metrics. 9 months ago
mock_data_test.go Check individual audio/video permissions on change. 1 year ago
natsclient.go Refactor asynchronous events to central location. 5 months ago
natsclient_loopback.go Refactor asynchronous events to central location. 5 months ago
natsclient_loopback_test.go Use "T.Cleanup()" instead of manually deferred shutdown function. 8 months ago
natsclient_test.go Use "T.Cleanup()" instead of manually deferred shutdown function. 8 months ago
notifier.go Add SingleNotifier class. 5 months ago
notifier_test.go Support multiple waiters for the same key. 2 years ago
proxy.conf.in Move etcd configuration to common section. 5 months ago
room.go Send initial user flags to internal sessions asynchronously. 5 months ago
room_ping.go Update capabilities if no hello v2 token key is found in cache. 4 months ago
room_ping_test.go Allow configuring backends through etcd. 5 months ago
room_stats_prometheus.go Add more metrics on rooms / sessions / backends. 1 year ago
room_test.go Refactor asynchronous events to central location. 5 months ago
roomsessions.go Disconnect sessions with the same room session id synchronously. 5 months ago
roomsessions_builtin.go Disconnect sessions with the same room session id synchronously. 5 months ago
roomsessions_builtin_test.go Add initial clustering support. 5 months ago
roomsessions_test.go Fix various issues found by golangci-lint. 2 years ago
server.conf.in grpc: Reload certificate if file has changed and support mutual authentication. 5 months ago
session.go Add "permission" for sessions that may not receive display names. 7 months ago
session_test.go Switch dependency tracking to Go modules. 2 years ago
single_notifier.go Add SingleNotifier class. 5 months ago
single_notifier_test.go Add SingleNotifier class. 5 months ago
stats_prometheus.go Add prometheus metrics. 1 year ago
stats_prometheus_test.go Add more metrics on rooms / sessions / backends. 1 year ago
syscallconn.go Fix file mode, should not be executable. 4 months ago
testclient_test.go Add hello version "2.0" that authenticates connections using a JWT. 4 months ago
testutils_test.go Add tests for regular NATS client. 2 years ago
transient_data.go Add API for transient room data. 10 months ago
transient_data_test.go Also return in-order list of "join" events. 8 months ago
vendor_helper_test.go vendor: Automatically vendor protobuf modules. 4 months ago
virtualsession.go Fix sending messages to virtual sessions on different servers. 5 months ago
virtualsession_test.go Added tests for clustered behaviour. 5 months ago

README.md

Spreed standalone signaling server

Build Status Coverage Status Documentation Status Go Report

This repository contains the standalone signaling server which can be used for Nextcloud Talk (https://apps.nextcloud.com/apps/spreed).

See https://nextcloud-spreed-signaling.readthedocs.io/en/latest/ for further information on the API of the signaling server.

Building

The following tools are required for building the signaling server.

  • git
  • go >= 1.17
  • make
  • protobuf-compiler >= 3

All other dependencies are fetched automatically while building.

$ make build

or on FreeBSD

$ gmake build

Afterwards the binary is created as bin/signaling.

Configuration

A default configuration file is included as server.conf.in. Copy this to server.conf and adjust as necessary for the local setup. See the file for comments about the different parameters that can be changed.

Running

The signaling server connects to a NATS server (https://nats.io/) to distribute messages between different instances. See the NATS documentation on how to set up a server and run it.

Once the NATS server is running (and the URL to it is configured for the signaling server), you can start the signaling server.

$ ./bin/signaling

By default, the configuration is loaded from server.conf in the current directory, but a different path can be passed through the --config option.

$ ./bin/signaling --config /etc/signaling/server.conf

Running as daemon

systemd

Create a dedicated group and user:

sudo groupadd --system signaling
sudo useradd --system \
    --gid signaling \
    --shell /usr/sbin/nologin \
    --comment "Standalone signaling server for Nextcloud Talk." \
    signaling

Copy server.conf.in to /etc/signaling/server.conf and fix permissions:

sudo chmod 600 /etc/signaling/server.conf
sudo chown signaling: /etc/signaling/server.conf

Copy dist/init/systemd/signaling.service to /etc/systemd/system/signaling.service (adjust abs. path in ExecStart to match your binary location!)

Enable and start service:

systemctl enable signaling.service
systemctl start signaling.service

Running with Docker

Official docker containers for the signaling server and -proxy are available on Docker Hub at https://hub.docker.com/r/strukturag/nextcloud-spreed-signaling

See the README.md in the docker subfolder for details.

Docker Compose

You will likely have to adjust the Janus command line options depending on the exact network configuration on your server. Refer to Setup of Janus and the Janus documentation for how to configure your Janus server.

Copy server.conf.in to server.conf and adjust it to your liking.

If you're using the docker-compose.yml configuration as is, the MCU Url must be set to ws://localhost:8188, the NATS Url must be set to nats://localhost:4222, and TURN Servers must be set to turn:localhost:3478?transport=udp,turn:localhost:3478?transport=tcp.

docker-compose build
docker-compose up -d

Setup of NATS server

There is a detailed description on how to install and run the NATS server available at http://nats.io/documentation/tutorials/gnatsd-install/

You can use the gnatsd.conf file as base for the configuration of the NATS server.

Setup of Janus

A Janus server (from https://github.com/meetecho/janus-gateway) can be used to act as a WebRTC gateway. See the documentation of Janus on how to configure and run the server. At least the VideoRoom plugin and the websocket transport of Janus must be enabled.

The signaling server uses the VideoRoom plugin of Janus to manage sessions. All gateway details are hidden from the clients, all messages are sent through the signaling server. Only WebRTC media is exchanged directly between the gateway and the clients.

Edit the server.conf and enter the URL to the websocket endpoint of Janus in the section [mcu] and key url. During startup, the signaling server will connect to Janus and log information of the gateway.

The maximum bandwidth per publishing stream can also be configured in the section [mcu], see properties maxstreambitrate and maxscreenbitrate.

Use multiple Janus servers

To scale the setup and add high availability, a signaling server can connect to one or multiple proxy servers that each provide access to a single Janus server.

For that, set the type key in section [mcu] to proxy and set url to a space-separated list of URLs where a proxy server is running.

Each signaling server that connects to a proxy needs a unique token id and a public / private RSA keypair. The token id must be configured as token_id in section [mcu], the path to the private key file as token_key.

Setup of proxy server

The proxy server is built with the standard make command make build as bin/proxy binary. Copy the proxy.conf.in as proxy.conf and edit section [tokens] to the list of allowed token ids and filenames of the public keys for each token id. See the comments in proxy.conf.in for other configuration options.

When the proxy process receives a SIGHUP signal, the list of allowed token ids / public keys is reloaded. A SIGUSR1 signal can be used to shutdown a proxy process gracefully after all clients have been disconnected. No new publishers will be accepted in this case.

Clustering

The signaling server supports a clustering mode where multiple running servers can be interconnected to form a single "virtual" server. This can be used to increase the capacity of the signaling server or provide a failover setup.

For that a central NATS server / cluster must be used by all instances. Each instance must run a GRPC server (enable listening in section grpc and optionally setup certificate, private key and CA). The list of other GRPC targets must be configured as targets in section grpc or can be retrieved from an etcd cluster. See server.conf.in in section grpc for configuration details.

Setup of frontend webserver

Usually the standalone signaling server is running behind a webserver that does the SSL protocol or acts as a load balancer for multiple signaling servers.

The configuration examples below assume a pre-configured webserver (nginx or Apache) with a working HTTPS setup, that is listening on the external interface of the server hosting the standalone signaling server.

After everything has been set up, the configuration can be tested using curl:

$ curl -i https://myserver.domain.invalid/standalone-signaling/api/v1/welcome
HTTP/1.1 200 OK
Date: Thu, 05 Jul 2018 09:28:08 GMT
Server: nextcloud-spreed-signaling/1.0.0
Content-Type: application/json; charset=utf-8
Content-Length: 59

{"nextcloud-spreed-signaling":"Welcome","version":"1.0.0"}

nginx

Nginx can be used as frontend for the standalone signaling server without any additional requirements.

The backend should be configured separately so it can be changed in a single location and also to allow using multiple backends from a single frontend server.

Assuming the standalone signaling server is running on the local interface on port 8080 below, add the following block to the nginx server definition in /etc/nginx/sites-enabled (just before the server definition):

upstream signaling {
    server 127.0.0.1:8080;
}

To proxy all requests for the standalone signaling to the correct backend, the following location block must be added inside the server definition of the same file:

location /standalone-signaling/ {
    proxy_pass http://signaling/;
    proxy_http_version 1.1;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}

location /standalone-signaling/spreed {
    proxy_pass http://signaling/spreed;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "Upgrade";
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}

Example (e.g. /etc/nginx/sites-enabled/default):

upstream signaling {
    server 127.0.0.1:8080;
}

server {
    listen 443 ssl http2;
    server_name myserver.domain.invalid;

    # ... other existing configuration ...

    location /standalone-signaling/ {
        proxy_pass http://signaling/;
        proxy_http_version 1.1;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }

    location /standalone-signaling/spreed {
        proxy_pass http://signaling/spreed;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}

Apache

To configure the Apache webservice as frontend for the standalone signaling server, the modules mod_proxy_http and mod_proxy_wstunnel must be enabled so WebSocket and API backend requests can be proxied:

$ sudo a2enmod proxy
$ sudo a2enmod proxy_http
$ sudo a2enmod proxy_wstunnel

Now the Apache VirtualHost configuration can be extended to forward requests to the standalone signaling server (assuming the server is running on the local interface on port 8080 below):

<VirtualHost *:443>

    # ... existing configuration ...

    # Enable proxying Websocket requests to the standalone signaling server.
    ProxyPass "/standalone-signaling/"  "ws://127.0.0.1:8080/"

    RewriteEngine On
    # Websocket connections from the clients.
    RewriteRule ^/standalone-signaling/spreed/$ - [L]
    # Backend connections from Nextcloud.
    RewriteRule ^/standalone-signaling/api/(.*) http://127.0.0.1:8080/api/$1 [L,P]

    # ... existing configuration ...

</VirtualHost>

Caddy

v1

Caddy (v1) configuration:

myserver.domain.invalid {
  proxy /standalone-signaling/ http://127.0.0.1:8080 {
    without /standalone-signaling
    transparent
    websocket
  }
}

v2

Caddy (v2) configuration:

myserver.domain.invalid {
  route /standalone-signaling/* {
    uri strip_prefix /standalone-signaling
    reverse_proxy http://127.0.0.1:8080
  }
}

Setup of Nextcloud Talk

Login to your Nextcloud as admin and open the additional settings page. Scroll down to the "Talk" section and enter the base URL of your standalone signaling server in the field "External signaling server". Please note that you have to use https if your Nextcloud is also running on https. Usually you should enter https://myhostname/standalone-signaling as URL.

The value "Shared secret for external signaling server" must be the same as the property secret in section backend of your server.conf.

If you are using a self-signed certificate for development, you need to uncheck the box Validate SSL certificate so backend requests from Nextcloud to the signaling server can be performed.

Benchmarking the server

A simple client exists to benchmark the server. Please note that the features that are benchmarked might not cover the whole functionality, check the implementation in src/client for details on the client.

To authenticate new client connections to the signaling server, the client starts a dummy authentication handler on a local interface and passes the URL in the hello request. Therefore the signaling server should be configured to allow all backend hosts (option allowall in section backend).

The client is not compiled by default, but can be using the client target:

$ make client

Usage:

$ ./bin/client
Usage of ./bin/client:
  -addr string
        http service address (default "localhost:28080")
  -config string
        config file to use (default "server.conf")
  -maxClients int
        number of client connections (default 100)

Running multiple signaling servers

IMPORTANT: This is considered experimental and might not work with all functionality of the signaling server, especially when using the Janus integration.

The signaling server uses the NATS server to send messages to peers that are not connected locally. Therefore multiple signaling servers running on different hosts can use the same NATS server to build a simple cluster, allowing more simultaneous connections and distribute the load.

To set this up, make sure all signaling servers are using the same settings for their session keys and the secret in the backend section. Also the URL to the NATS server (option url in section nats) must point to the same NATS server.

If all this is setup correctly, clients can connect to either of the signaling servers and exchange messages between them.