edoc platform Administration Guide
Breadcrumbs

Install edoc platform on a virtual machine

If you use edoc platform locally (on-premises) in your organization, you perform the necessary installation steps yourself or commission the edoc team with the installation for a fee.

Essentially, a virtual machine (VM) is installed with the supported Ubuntu version as the operating system. The basic installation for edoc agent and the required components and tools on the virtual machine is performed using an installation script.

The installation script installs the following:

  • PHP and Git are installed with the package manager apt.

  • The Git repository is cloned from edoc agent to /opt/agent.

  • Composer is installed as a basic installation in accordance with the manufacturer's instructions (https://getcomposer.org).

  • MicroK8s is installed with the package manager snap.

  • Cron jobs are set up for regular updates, retrieving edoc agent tasks and transferring the system status.

Requirements for a successful installation

  • You have administrative access to at least the systems of your organization in edoc system control.

  • The SSH service is activated on the virtual machine (VM).

  • Your VM is connected to the Internet.

  • Ports 443 and 80 have been released.

  • You have been granted sudo permissions on the VM to perform the basic installation.

Basic steps of a basic installation

  1. Server images on the Ubuntu website: always download the server image from the Ubuntu website: https://ubuntu.com/download/server (in English). For security reasons, do not use any other source. The same applies to the current system within the same major version (24.04).

  2. Install the operating system: install the operating system on a virtual machine (VM), e.g. a Hyper-V VM. You must activate the SSH service.

  3. install edoc agent: once completing the installation of the operating system, install the agent (edoc agent) using a bash script (installation script) via SSH command:

    1. Connect to the VM via SSH and make sure that you have been granted sudo permissions.

    2. Copy the sudo command line in edoc system control on the Systeminformation (System information) page of your VM.

    3. Execute the copied command on the VM.

The basic installation is then automated and all further installations of the individual edoc apps and edoc services are controlled using edoc system control.


See also