Main Server Configuration¶

All system components are configured using JSON configuration files located next to the files of the running instances.

In this document, you will find all available parameters for the Main Server that are allowed in the server/config.json file. For easier reference, the options are grouped by purpose and sorted by importance.

Listening Ports¶

Ports on which the main server will run:

{
  "port": {
    "http": 80,
    "https": 443
  }
}

Database¶

Credentials for connecting to the database.

{
  "sql": {
    "server": "172.16.0.1",
    "port": 5432,
    "user": "getscreen",
    "password": "Kw7ZzOioC4pdj1kp",
    "log": true
  }
}

Inter-Component Communication¶

For all running system components to exchange messages with each other, they must be authorized with one another. In other words, each component must explicitly allow other components to send messages to it. This authorization is implemented using special tokens.

Authorization Token¶

The main server token that other system components use to authenticate with the main server.

{
  "token": "556vLWCNHXqF28eC"
}

Component Credentials¶

For the main server to communicate with the other subordinate components, it must also authenticate with them. Therefore, the configuration must include the address and token for each component that is being used.

Download Component¶

The values for the options in this section can be found in the download/config.json configuration file for the Download Component.

{
  "download": {
    "host": "example.net:5012",
    "token": "Isw6tEcfg79CN3IJ"
  }
}

Proxy Component¶

The values for the options in this section can be found in the proxy/config.json configuration file for the Proxy Component.

STUN Servers¶

A list of STUN servers in use.

{
  "stun": [
    {
      "ip": "172.16.0.10",
      "port": 5000
    }
  ]
}

TURN Servers¶

A list of TURN servers in use.

{
  "turn": [
    {
      "ip": "172.16.0.11",
      "port": 5001,
      "login": "jtzPwazErFubXzuw",
      "password": "w6xuiJKnZ0hriktw",
      "transport": "udp"
    }
  ]
}

WebSocket Servers¶

A list of WebSocket servers in use.

{
  "websocket": [
    {
      "host": "example.net",
      "port": 5002
    }
  ]
}

Image Component¶

The values for the options in this section can be found in the image/config.json configuration file for the Image Component.

{
  "storage_image": [
    {
      "host": "example.net",
      "port": 5003,
      "key": "PwayXNeyzUwrk64V",
      "token": "EasMwzCAKQlQkhGh"
    }
  ]
}

Storage Component¶

The values for the options in this section can be found in the storage/config.json configuration file for the Storage Component.

{
  "storage": [
    {
      "host": "example.net",
      "port": 5004,
      "key": "ENutE9xxDDj8HSw9",
      "token": "zfyvQKtfTonIs7zm"
    }
  ]
}

Communication Tools¶

Settings for peripheral tools required for the full operation of the server.

Mail Server¶

Required for sending passwords to newly registered or recovering technicians, connection invitations, as well as other system emails and notifications.

{
  "mail": {
    "server": "mail.example.net",
    "port": 587,
    "user": "[email protected]",
    "password": "8G9wLmvCxq6bR2pW",
    "email": "[email protected]"
  }
}

Telegram Bot¶

Used to send two-factor authentication codes, receive notifications, and access the personal dashboard when a technician enables the integration for their account.

{
  "integrate": {
    "telegram": {
      "id": 123,
      "name": "TelegramBot",
      "token": "AHp0KjWznFvbTsxH:DgBfX7J0QSlkSa9H"
    }
  }
}

Google Translate¶

Used for automatic translation of on-screen text during a remote desktop session.

{
  "translate": {
    "google": "qwertyqwertyqwertyqwerty"
  }
}

Security Settings¶

Captcha¶

You can enable CAPTCHA verification for technicians on the registration, login, and password recovery pages.

{
  "captcha_info": [
    {
      "type": "google",
      "key": "UdHonfCy9UubOE3s",
      "secret": "3DhRLmUW3AvIeiSg"
    }
  ]
}

Anonymous Access¶

You can deny anonymous technicians the ability to connect to devices using one-time links.

{
  "force_login": true
}

Password Settings¶

You can limit the password lifetime for user accounts and require users to change their password on first login.

{
  "password_timeout": 30,
  "password_change": true
}

Old Browsers¶

You can prevent technicians from using the system in outdated browser versions.

{
  "accept_old_browser": true
}

The following browser versions are considered outdated:

HSTS (HTTP Strict Transport Security)¶

You can enable an option that forces browsers to always use HTTPS when connecting to the server and blocks any HTTP connections.

{
  "hsts": true
}

CSP (Content Security Policy)¶

You can restrict which hosts are allowed to load content and receive requests in the browser where the dashboard and connection window are opened, helping to prevent XSS vulnerabilities.

{
  "csp": {
    "enable": true,
    "extra": "abc.example.net"
  }
}

Network Settings¶

Reverse Proxy¶

If you use a reverse proxy in the server environment, you must inform the server about it.

{
  "balancer": {
    "ip": [
      "123.123.123.123"
    ]
  }
}

Log HTTP Requests¶

You can enable logging of HTTP requests to the server.

{
  "log-http": true
}