Team Server configuration file

The PrivMX Team Server configuration file is located at /etc/privmx-team-server/config.json. We describe the most important settings here:

[[TOC]]

Do not forget to restart team server service after you change some settings:

sudo service privmx-team-server restart

---

Domain & port (REQUIRED)

You should set a domain and a port:

{
    "domain": "example.com",
    "server": {
        "port": 80
    }
}

Enabling SSL

{
    "server": {
        "ssl": {
            "enabled": true,
            "privKeyPath": "/etc/privmx-team-server/cert/server.key",
            "certificatePath": "/etc/privmx-team-server/cert/server.crt"
        }
    }
}

Let's Encrypt webroot plugin

You can enable support for the webroot plugin by adding:

{
    "server": {
        "staticDirs": [
            {
                "url": "/.well-known/acme-challenge",
                "path": "/var/www/{your-domain}/.well-known/acme-challenge"
            }
        ]
    }
}

External mongodb

You can use an existing mongodb installation for your PrivMX Team Server:

{
    "db": {
        "mongo": {
            "url": "mongodb://my-external-host.com:27017",
            "dbName": "my_db_name"
        }
    }
}

PrivMX desktop application updater

By default your PrivMX desktop application updater is turned off and your server users do not receive any desktop application updates. You can setup your updater to be a proxy of the official PrivMX desktop application repository, so your server users will always receive the latest updates right after release.

{
    "updater": {
        "main": {
            "type": "proxy",
            "url": "https://repo.privmx.com/updater/repo/customers",
            "customPackageName": "privmx"
        }
    }
}

PrivMX Video Server pairing

After you install PrivMX Video Server, you should pair it with your team server using PRIVMX_API_SECRET (see docs). In order to do this, add the following section to the config:

{
    "video": {
        "enabled": true,
        "secret": "<PRIVMX_API_SECRET>",    
        "clientUrl": "https://<PRIVMX VIDEO SERVER DOMAIN>",
        "apiUrl": "https://<PRIVMX VIDEO SERVER DOMAIN>/privmx-api/",
        "jitsiScript": {
            "scriptsDirectory": "/path/to/jitsi/scripts"
        }
    }
}

In directory specified in video.jitsiScript.scriptsDirectory a client script should be placed. Download package from our cdn and unzip it to that directory.