General Information¶

Who is this help for?¶

The purpose of this document is to assist with installation and maintenance of the Getscreen.me system. It is intended for system administrators and DevOps engineers familiar with the Linux operating system and containerization .

What is the Self-Hosted version of the system?¶

This is a separate version of the Getscreen.me software delivery, which includes server components for self-hosting on the client infrastructure. Allows you to organize remote access within the local network (including without Internet access).

System structure¶

flowchart TD
    subgraph process [Connection process]
        Operator[Operator] <-->|WebRTC| Agent[Agent]
    end
    subgraph version [Self-Hosted version]
        subgraph Database
            DB[(PostgreSQL)]
        end
        subgraph Components
            Server{"SERVER"}
            Proxy{"Proxy 
            component"}
            Download{"Download 
            component"}
            Image{"Image
            component"}
            Storage{"Storage
            component"}
            Server --- Download
            Server --- Image
            Server --- Storage
            Server --- Proxy
            Server -.- DB
            Download -.- DB
        end
    end
    Operator -.-|WebSocket| Proxy -.-|WebSocket| Agent

    style Operator fill:#fff,stroke:#666;
    style Agent fill:#fff,stroke:#666;
    style process fill:#fff,stroke:#ccc;
    style version fill:#fff,stroke:#999;

The system consists of a main server and several autonomous components (the same web servers), which perform specific tasks.

In addition to the components, the system requires a database to store data. Included by default in the PostgreSQL version 14. Can be replaced by similar compatible software.

Server¶

The central component of the system that implements the following functions:

Connecting to agents on demand
Registration of new users
Agents registration in the system
User's personal account
Access to agent distributions
Service connection with agents

Download¶

Designed to work with agent distributions:

Stores all versions of distributions
Gives away distribution files
Generates distribution files for quick support
Prepares branded distributions

Image¶

Designed to work with desktop image thumbnails:

Receives images from agents
Sends images to the main server for displaying in the personal cabinet

Storage¶

Designed to work with video recordings of sessions:

Receives data for video recordings from the browser
Gives the files to the server to display them in your personal area
Transcodes video formats if necessary

Proxy¶

Designed to transfer data between the user and the agent when a P2P connection is unavailable for network reasons:

Retransmits video data from the agent to the browser
Proxies file transfers from agent to browser and vice versa

Last update: July 24th, 2024