Install ELMA365 to MicroK8s

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

Before you begin installation, please read the minimum requirements that your system has to meet so that ELMA365 On-Premises Standard can be installed and work correctly.

If you need to install ELMA365 On-Premises Enterprise, read the Install article.

Before installing to Ubuntu

If you are working in a private network, make sure access to the following resources is allowed:

To download images of ELMA365 services, databases, and additional services that provide additional features:

• *.quay.io:443
• docker.io:443
• hub.elma365.tech:443
• dl.elma365.com:443
• k8s.gcr.io:443
• ​ghcr.io:443
• gcr.io:443
• *.docker.io:443
• *.docker.com:443
• *.github.com:443
• *.snapcraft.io:443
• *.snapcraftcontent.com:443
• *.githubusercontent.com:443
• storage.googleapis.com:443
• storage.yandexcloud.net:443
• grafana.com:443
• cr.l5d.io:443
• linkerd.io:443

To install the Security Audit module:

• *.helm.sh:443

To work with the catalog of modules:

• store.elma365.ru:443

To work with Telegram, TelegramBot, WhatsApp, ViberBot, and VK messengers:

• web.whatsapp.com:443
• *.whatsapp.net:443
• chatapi.viber.com:443
• api.vk.com:443
• api.telegram.org:443

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

If you want push notifications on mobile devices to be available, set up access to fcm.googleapis.com:443. This is a Firebase Cloud Messaging (FCM) service provided by Google that allows you to deliver push notifications to Android and iOS platforms.

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

Make sure that ports 80 and 443 are open for external connections.

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

To enable disk UUID in VMWare ESXi, do the following:

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

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

Read more about updating versions older than 0.9.0 in How to update versions older than 0.9.0.

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

Install the server on Ubuntu

All console commands listed in the ELMA365 On-Premises section of the Help Center must be run with elevated privileges. Therefore, before you continue, switch to superuser authority 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 this command:

hostnamectl set-hostname elma365client

Here elma365client is the new hostname. After setting the name, run the reboot command.

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

Do not change the server’s hostname after installing MicroK8s and ELMA365. This will leave MicroK8s inoperable, and, consequently, ELMA365 will not work either.

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

The server installation includes several steps:

1. Open the command line on the server. Run the following command:

curl -fsSL -o elma365-installer.sh \
https://dl.elma365.com/onPremise/master/latest/download && \
chmod +x elma365-installer.sh && \
./elma365-installer.sh

2. The installation script prompts for the Administrator password (root password).
3. The presence of a swap file enabled in the system is checked. Note: It is recommended to disable the swap file to let the server be installed and work correctly. If it is enabled, the installation process will pause, and a warning will be displayed. The user can ignore the warning (not recommended) and resume installation by pressing Enter or disable the swap file and press Enter to continue. To interrupt the installation, press any other key.
4. At this step, you can change the DNS server. By default, ELMA365 uses public DNS servers 8.8.8.8 and 8.8.4.4.
5. Select the system interface language.
6. Specify the administrator’s login, i.e. the main administrator’s email address.
7. Specify the administrator’s password, i.e. the password allowing the main administrator to sign in.
8. Set up a connection with an SMTP server. It will be used to send invitations to new users, restore passwords, and send notifications about new tasks.

• SMTP host. Enter the host 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 emails from.
• SMTP password. Specify the email server password.

9. At this step, you can set up connections with distributed databases. This can be used to build a scalable and fault-tolerant architecture in installations with large amounts of data and number of users. Select an external service: PostgreSQL, MongoDB, S3, or Redis. Then specify the connection strings: hostname, port, username, and password.

You can connect to S3 via a proxy. This is optional and available if you selected S3 as the external service at step 9. Read more about this option in the MinIO S3 article.

10. Specify the base URL (the local domain name or the server’s IP address). The elma365 service will be available via this address.
11. This step is optional and only appears if you specified a domain name on the previous step.

You can enable HTTPS support to use an SSL certificate. To do that:

• Specify a domain name as the base URL. This setting will not work if you specified an IP HTTPS.
• You will be prompted to enable HTTPS. Do so.
• Specify the private key and the SSL certificate for the domain, including not only the domain name, but also the certification path. Such a certificate is usually issued immediately, and its name includes +chain. The key and the certificate have to be stored in your file management system. When using a self-signed certificate, the root CA’s certificate also needs to be specified. To update the certificate, follow these instructions.

12. ELMA365 server HTTPS proxy mode. This is an optional step; it only appears if you specified a domain name at step 10, but didn’t enable HTTPS at step 11. Enable this setting if there is a configured proxy server with SSL set up for the ELMA365 server.
13. Enable hostaliases. If you specify a domain name during installation, the possibility to establish a connection from the Kubernetes environment for this domain is checked. If it is impossible, you are prompted to enable hostaliases to make it work correctly. With some proxy servers, this setting needs to be disabled.

After that, the installation process will run. It takes up to 10–15 minutes. If the program is installed successfully, the following message will appear: “ELMA365 successfully installed”. Visit http:/.... [server IP address specified at step 3].

In an installed system, you can see the current version of the server in the Help menu. To do that, click the question mark icon on the main page to the left of the user profile data.

Note that in ELMA365 On-Premises you need an integration with OnlyOffice to view and edit files.

Was this helpful?

Thanks for your feedback!

Please specify why:

Recommendations did not help meArticle is hard to understandDidn`t answer my questionContent does not match the topicOther

How we can improve it?

YesNo

Please specify whyRecommendations did not help meArticle is hard to understandDidn`t answer my questionContent does not match the topicOther

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