ELMA365 On-Premises > Install ELMA365 to MicroK8s / Install ELMA365 Standard

Install ELMA365 Standard

ELMA365 Standard Edition can be installed on Ubuntu Server 20.04 LTS.

Before you begin, please read the minimum requirements to install and run ELMA365 Standard Edition. The following information does not provide instructions for configuring your company’s server, but helps you estimate compatibility with ELMA365.

Actual requirements depend on a real-life use of the system and vary significantly among different companies.

Initial configuration

Before the installation, if working in a private network make sure you have access to the following resources:

  • quay.io:443
  • docker.io:443
  • hub.elma365.tech:443
  • k8s.gcr.io:443
  • ​ghcr.io:443
  • *.docker.io:443
  • github.com:443
  • *.snapcraft.io:443
  • *.snapcraftcontent.com:443
  • *.githubusercontent.com:443
  • grafana.com:443

начало внимание

To enable push notifications on your mobile phone, configure access to fcm.googleapis.com:443. This is a Firebase Cloud Messaging (FCM) service from Google that allows you to deliver push notifications to Android and iOS phones.

конец внимание

Verify that 80 and 443 ports are open for external connections.

If you are using VMWare ESXi, make sure that disk UUID is switched on.

 

To enable disk UUID in VMWare ESXi:

 

  1. Shut down the virtual machine.
  2. Click on virtual machine name select Edit Settings.
  3. In the window that opens, select the Options tab.
  4. Select General in the Advanced section.
  5. Click Configuration Parameters… on the right-hand side
  6. In the window that appears check if the parameter disk.EnableUUID presents. Make sure it is set to TRUE. If there is no such parameter, click Add Row and add it.
  7. Switch on the virtual machine.

начало внимание

Read more on how to update versions older than 0.9.0 in this article.

конец внимание

Install the server on Ubuntu

All console commands listed in the "ELMA365 on-premises" section of ELMA365 Help must be run with elevated privileges. Therefore, before you continue switch to superuser by running the following command:

sudo –s

Please note that the hostname must not contain capital letters. If the hostname is not displayed at the command line prompt, you can check it by running the following command:

hostname – f

To change the hostname use the command:

hostnamectl set-hostname elma365client

Set the desired hostname where elma365client is the new hostname. Then, reboot the system.

начало внимание

If you are using VMWare ESXi >= 6.5, make sure that disk UUID is switched on. Read more about that on the official VMWare website.

конец внимание

There are several steps to install the server.

Step 1. Open the command line on the server. Then, run the following command:

curl -fsSL -o get_elma365.sh https://dl.elma365.com/standard/master/install.sh && chmod +x get_elma365.sh && ./get_elma365.sh

You can increase the installation timeout if necessary. Set the value for 120 minutes, for example.

TIMEOUT=120m ./get_elma365.sh

Step 2. Enter the Administrator password (root).

Step 3. Enter base-URL – local domain name or the server IP address. ELMA365 will be available at this IP address.

Step 4. Enter the main administrator login (email).

Step 5. Enter the main administrator password.

Next, you can set up an smtp server for email messaging. Skip this step if you want to configure the smtp server later. You can find it in the Administration workspace.

Step 6. Set up an smtp server:

  • SMTP host. Enter the server address according to your email server settings. For example, smtp.gmail.com.
  • SMTP port. Enter the connection port according to your email server settings. For example, 465.
  • Select the SSL. For example, TLS.
  • From address. Specify the address you want to use to send messages.
  • SMTP password. Specify the server password.

The installation process takes up 10-15 minutes. If the program is installed successfully, the following message will appear: ELMA365 successfully installed. Visit http:/.... [Step 3 server IP address].

The installation log files are located in /var/log/elma365/install.log. If you are experiencing problems installing ELMA365, consult the log files to troubleshoot the installation.

Uninstall

Remove the microk8s to delete all program components. To do so, run the following command:

sudo snap remove microk8s

To delete the user configuration files, remove the sudo rm /etc/elma365/elma365.yaml

Status check

You can check the statuses of the servers with the following command:

microk8s kubectl get pod

The table with the list of services appears. They should have the Running status.

Logging

You can view all log files by running the following command:

microk8s kubectl logs --selector=release=elma365 --all-containers > logs.txt

To find specific logs, specify the needed service [name].

microk8s kubectl logs --selector app=[name]

Example:

microk8s kubectl logs --selector app=main

To monitor the log files in real time, add -f to the command.

Example:

microk8s kubectl logs --selector app=main -f

To decrease the number of lines in a log file, add --tail to the command.

Additional information

The microk8s service is installed with the system. The microk8s service has the following components:

databases:

  • mongo
  • minio
  • redis
  • postgresql
  • rabbitmq

apps:

auth

Authorization and groups, users, and org chart management

balancer

Multi-tenancy management

calculator

Calculating different values in app items

chat

Private and group messages

collector

App items read and filter

convertik

Office formats to pdf converting

deploy

Migration management

diskjockey

Files and directories

docflow

Document workflow. Approval and review.

feeder

Activity stream / channels

front

ELMA365 Front end

integrations

External integrations

mailer

Email management

main

API gateway

notifier

Notifications and web-sockets

processor

Process management

scheduler

Schedules

settings

User profile and system profile management

templater

Text and office documents templater

vahter

Users management in a multi-tenancy system

web-forms

Web-forms for external systems management

widget

Widget management (interface customization)

worker

Validating, transpiling and user scripting

To access the databases, you need to forward the ports of the corresponding services:

  • sudo microk8s kubectl port-forward mongo-0 27017:27017
  • sudo microk8s kubectl port-forward redis-master-0 6379:6379
  • sudo microk8s kubectl port-forward postgres-0 5432:5432
  • sudo microk8s kubectl port-forward rabbitmq-0 15672:15672

 

 

Found a typo? Highlight the text, press ctrl + enter and notify us