Skip to content

Server config description

This document contains descriptions for all parameters of the server/config.json configuration file for advanced reference.

Port for requests

 "port": {
    "http": 80, 
    "https": 443 
  }
Parameter Type Description
port.http number for HTTP requests, the default is 80
port.https number for HTTPS requests, the default is 443

Logging HTTP requests

"log-http": true
Parameter Type Description
log-http boolean enable logging, default is false.

Database

Config for connecting to a database.

  "sql": {
    "server": "123.123.123.123",
    "port": 123,
    "user": "qwerty"
    "password": "qwerty",
    "log": true,
  }
Parameter Type Description
sql.server string server address
sql.port number port
sql.user string user
sql.password string password
sql.log boolean enable logging of SQL queries, by default false

Mail server settings

It is used to send outgoing invitation letters, user registrations, and password recovery.

  "mail": {
    "server": "smtp.host.net",
    "port": 123,
    "user": "user@host.net",
    "password": "qwertyqwerty",
    "email": "qwerty@host.net"
  }
Parameter Type Description
mail.server string server address
mail.port number connection port
mail.user string user
mail.password string password
mail.email string email address to send mail

Reverse proxy

  "balancer": {
    "ip": [
      "123.123.123.123"
    ]
  }
Parameter Type Description
balancer.ip []string list of IP addresses

Google Captcha

If specified, it will be used on the login and user registration page.

  "captcha": {
    "key": "qwertyqwertyqwertyqwertyqwerty32",
    "secret": "qwertyqwertyqwertyqwerty"
  },
Parameter Type Description
captcha.key string API key
captcha.secret string secret key

Where to get the API key?

You can create a captcha and get an API key at reCAPTCHA .

Google Translate

If specified, automatic on-screen text detection and translation will be available when connecting to remote devices.

  "translate": {
    "google": "qwertyqwertyqwertyqwerty"
  }
Parameter Type Description
translate.google string API key

Where to get the API key?

You can get the API key at Translation Hub

Telegram bot

If specified, the following features will become available to Telegram users:

  • Receipt of two-factor authorization codes
  • Notifications when customer is ready to connect by invitation
  • Invitation creation
  • Permanent access to the devices
    • Obtaining a list
    • Connecting
    • File exchange
  "integrate": {
    "telegram": {
      "id": 123, 
      "name": "TelegramBot",
      "token": "123:qwertyqwertyqwertyqwerty" 
    }
  }
Parameter Type Description
integrate.telegram.id number bot ID
integrate.telegram.name string name
integrate.telegram.token string connection token

Download component

Config to connect to the Download component.

  "download": {
    "host": "host.net:123",
    "token": "qwertyqwertyqwertyqwerty"
  },
Parameter Type Description
download.host string server address:port
download.token string token

Storage component

Config to connect to the Storage component.

  "storage": [
    {
      "host": "host.net", 
      "port": 123,
      "key": "qwertyqwertyqwertyqwertyqwerty32",
      "token": "qwertyqwertyqwertyqwerty"
    }
  ]
Parameter Type Description
storage.[].host string server address
storage.[].port number port
storage.[].key string key
storage.[].token string token

Image component

Config to connect to the Image component.

  "storage_image": [
    {
      "host": "host.net",
      "port": 123,
      "key": "qwertyqwertyqwertyqwertyqwerty32",
      "token": "qwertyqwertyqwertyqwerty"
    }
  ]
Parameter Type Description
storage_image.[].host string server address
storage_image.[].port number port
storage_image.[].key string key
storage_image.[].token string token

Proxy component

Configs for connecting to the Proxy component.

STUN-server

  "stun": [
    {
      "ip": "123.123.123.123",
      "port": 123  
    }
  ]
Parameter Type Description
stun.[].ip string IP address
stun.[].port number port

TURN-server

  "turn": [
    {
      "ip": "123.123.123.123", 
      "port": 123,    
      "login": "qwerty",
      "password": "qwerty",
      "transport": "udp" 
    }
  ]
Parameter Type Description
turn.[].ip string IP address
turn.[].port number port
turn.[].login string login
turn.[].password string password

WebSocket-server

  "websocket": [
    {
      "host": "host.net",
      "port": 123 
    } 
  ]
Parameter Type Description
websocket.[].host string address
websocket.[].port number port

Token

It is used to authorize connection of other system components to the server.

  "token": "qwertyqwertyqwertyqwerty"
Parameter Type Description
token string token

TLS

Configuring TLS connection security

"tls": {
  "min_version": "TLSv1.2",
  "max_version": "TLSv1.3",
  "ciphers": "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256:TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256"
 }
Parameter Type Description
tls.min_version string TLS minimal version
tls.max_version string TLS maximal version
tls.ciphers string allowed algorithms,
you can specify more than one with a separator :

Possible values:
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

Last update: December 1st, 2023