# Swarmica Installation Guide
# System Requirements

**ATTENTION! The server can be virtual, but only on hypervisor virtualization technologies. Installation and launch inside a guest OS on a container-based virtualization platform is not supported**

## OS

Supported OS versions:

-   ![Alt Server 11.1 Logo: Supported by Swarmica](https://support.swarmica.com/attachments/2/j/2jPOpQYzkvIX6DBM_a/altserver_monochrome.svg) Alt Server 11.1 (Astra Server 11.1)
-   ![Astra Linux 1.8 Logo: Supported by Swarmica](https://support.swarmica.com/attachments/L/t/Lt3oByCVvUK8DVO2_a/astra.svg) Astra Linux 1.8
-   ![RedOS 8 Standard Logo: Supported by Swarmica](https://support.swarmica.com/attachments/Z/I/ZIvDNee3nw_5rzDs_a/redos.svg) RedOS 8 Standard
-   ![RedOS 8 Certified Logo: Supported by Swarmica](https://support.swarmica.com/attachments/Z/I/ZIvDNee3nw_5rzDs_a/redos.svg) RedOS 8 Certified
-   ![Ubuntu 26.04 Standard Logo: Supported by Swarmica](https://support.swarmica.com/attachments/o/S/oSXg5vrAIKFNfklY_a/ubuntu.svg) Ubuntu 26.04.x LTS
-   ![Ubuntu 24.04 Standard Logo: Supported by Swarmica](https://support.swarmica.com/attachments/o/S/oSXg5vrAIKFNfklY_a/ubuntu.svg) Ubuntu 24.04.x LTS
-   ![Ubuntu 22.04 Standard Logo: Supported by Swarmica](https://support.swarmica.com/attachments/o/S/oSXg5vrAIKFNfklY_a/ubuntu.svg) Ubuntu 22.04.x LTS (it is recommended to upgrade to newer versions)

## Minimum

Minimum requirements for running the application and its functional testing:

```
CPU: 4 vCPU (Intel Core i5 / Xeon)
RAM: 16 GB
HDD: 50 GB SSD
```

## Recommended

For operational modes:

```
CPU: Intel Xeon / i7 8 Core
RAM: 32 GB
HDD: 500GB SSD (RAID array is desirable)
```

## Infrastructure Requirements

### Outgoing Traffic

The server where the product will be installed must have access to the following resources:

-   [https://reg.gl.swd.im](https://reg.gl.swd.im) - container image registry for the application
-   [https://license.swarmica.com](https://license.swarmica.com) - Swarmica license key server
-   [https://mirror.gcr.io](https://mirror.gcr.io) - mirror of the container image registry for related services such as redis, postgres, traefik, etc.
-   Mirrors or package repositories for Ubuntu OS configured on the server

If SMTP Relay is used for outgoing mail, it must also be accessible from the application server.

### Incoming Traffic

-   Ports 80 and 443 - for WEB interface
-   Port 25 - if an incoming email channel through SMTP is used

### DNS

-   The selected domain name must be resolved to the external IP address of the system (A record)

Example:

To make the system available at [support.swarmica.com](https://support.swarmica.com), installed on a server with IP address [79.141.74.181](https://79.141.74.181), you need to add the following records in DNS:

```
support.swarmica.com   A      79.141.74.181
```

### Incoming Mail

The recommended configuration is to receive mail through IMAP. To do this, prepare the account data where the technical support mail will arrive:

-   Server address
-   Port (993)
-   User (usually the same as the email address, for example, support@company.tld)
-   Password (usually the same as for the user, except for mail on services [Gmail](https://support.swarmica.com/article/ru/431-podklyuchenie-elektronnoj-pochty-gmail.html), [Yandex Mail](https://support.swarmica.com/article/ru/430-podklyuchenie-elektronnoj-pochty-yandex.html), [Mail.ru](https://support.swarmica.com/article/ru/432-podklyuchenie-elektronnoj-pochty-mailru.html) - there you need to create an application password)

### Outgoing Mail

To send outgoing mail, you need to configure SMTP Relay - an authorized SMTP server that will forward mail from the system to external recipients.

Supported protocols:

-   SMTP (25)
-   SMTP SSL (465)
-   SMTP TLS (587)

### License

Obtain the following data from the [Swarmica](mailto:support@swarmica.com) representative, necessary for the correct start of the system:

-   Swarmica license key
-   Account data for the container image registry (login and access token)

# Installation

1. Download the archive to the server where the installation is planned:

```bash
mkdir swarmica-installer
cd swarmica-installer
wget https://support.swarmica.com/attachments/installer/installer.tar.gz
```

:::tip
On RedOS, you must install the `wget` utility with the following command: `sudo dnf install wget`, if it is not the default
:::

2. Unpack the archive with a suitable utility:

```bash
tar -xvzf installer.tar.gz
```

3. Add execution permissions:

```bash
chmod +x installer.sh
```

4. Start the installation:

```bash
./installer.sh install
```

:::tip
During installation, the initial launch may take several minutes - this is expected time. You do not need to take any action: the installer will occasionally check the availability of the system and report on the completion of the installation
:::

Help: `./installer.sh help`

Launch in DEBUG mode: `export DEBUG=1; ./installer.sh install`