Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 3.02 KB

build-from-source.md

File metadata and controls

46 lines (36 loc) · 3.02 KB
Raw

Building and Running from Source Code

The Linux Remote Desktop project consists of several components. Each component is actually a seperate github project that is built into a docker image.

A Docker Compose file (located in the root folder) is used to configure the containers, based on the docker images. After building the docker images, you can copy the root folder to the target server(s), configure the docker-compose.yml file to use the built images, and start all containers by entering: docker-compose up -d

Components

Please follow the different components for the build instructions on their respective Github page . The instructions for each component creates a docker image that can be configured in the Docker Compose file.

Management

Github's project: Management. The management component:

  • Is the main orchestrator that manages all the other components. It authneticates users and handles the lifecycle of the users' sesssions.
  • Connects to MySQL database to access persistent data (e.g. user credentials) and Redis data store to access non-persistent data (e.g. current loggged-in users).
  • Is based on node.js and is a stateless service, so you can have mutiple instances running for scalability and availability.

Frontend

Github's project: Frontend. The frontend component:

  • Is the only component that has direct access from the internet (or an outside network).
  • User that connects to the system using a web browser, can connect to the frontend compoent, which sends his request, either to the management service (for all user session management purposes), or to the gateway service (concerning remote display protocol traffic).
  • Hosts the Vue-based client modules: nubo-admin (which is the admin's control panel client) and nubo-client-desktop (which is the end user's desktop client).

Platform Server

Github's project: Platform Server. The platform server:

  • Manages the users' containers in each server.
  • Runs in each server and gets commands from the management component regarding users logging in or out, and then starts or stops the containers using the parameters recieved from the management component.
  • Sends health information and performance statistics to the management server.

Gateway

Github's project: Gateway. The gateway service:

  • Runs Guacamole proxy that converts traffic from Gucamole web clients to RDP.
  • Mutiple services can be added for performance. The services independently register themselves on the management service, so it can send traffic through them.

RSyslog

Github's project: RSyslog. The RSyslog component:

  • A simple Syslog-based server.
  • Designed to gather logs from all other services, so the admin has one single point from where to read all logs.
  • Important log events are added to the database, so they will be available on the Admin Control Panel.