Installation

This article contains instructions for installing the current (6th) generation of software. Installation of 5th and 4th generation software is not supported.

To activate VMmanager, you need license information. If you purchased VMmanager from ISPsystem, you can view this information in your personal account at eu.ispsystem.com in the "Licenses" section. After installation you need to enter a value from the Token field.

When installing and upgrading, the platform downloads software from ISPsystem's online resources:

docker-registry.ispsystem.com — docker registry;
download.ispsystem.com — repository.

These resources are public services and access to them is provided without authentication.

SELinux will be disabled during the installation as it prevents the platform from working correctly.

Server preparation

/etc/hosts file

Make sure that the /etc/hosts file has an entry for the server in the format:

<server IP address> <server hostname>

/etc/resolv.conf file

Make sure that the /etc/resolv.conf file has entries in the format:

nameserver <IP address of the DNS server>

If the IP address of the systemd-resolved local service (127.0.0.53) is specified as the DNS server, check that the DNS server addresses are specified in /etc/systemd/resolved.conf:

DNS=<servers list>

Installation steps

Connect to the server via SSH with the superuser permissions (root per default).

Download the installation script:

curl -O https://download.ispsystem.com/6/installer/vm/vm

Make it executable:
```
chmod +x vm
```
Run the installation process:
```
./vm install
```
Optional parameters
Optional command parameters:
- -n — domain name of the server. Will be used in the platform URL;
  Example command
  ./vm install -n="vmmanager.example.com"
- --registry-port — TCP port for downloading docker container images. Use this option if the server denies incoming connections on ports 5000/tcp and 443/tcp;
  Example command
  ./vm install --registry-port=5001
- -f — installation on a server with specifications below the required ones;
- --ssl-crt-file, --ssl-key-file — path to the files with the public and private key of the SSL certificate. The data will be added to the web server settings;
  Example command
  ./vm install --ssl-crt-file="/root/example.crt" --ssl-key-file="/root/example.key"
- --proxy — HTTP proxy settings in the format http://<user>:<password>@<address>:<port>:
  - <user> — username for authorization. Optional parameter ;
  - <password> — password for authorization. Optional parameter ;
  - <address> — HTTP proxy IP address;
  - <port> — HTTP proxy port.
    Example command for a proxy with authorization
    ./vm install --proxy="http://admin:pass123@192.168.57.1:3128"
    Example command for a proxy without authorization
    ./vm install --proxy="http://192.168.57.1:3128"
- --verbose — show additional information:
  - docker images download, run and unpack status;
  - output of commands run by the installer.
    Пример команды
    ./vm --verbose install
The installer will check the server against the minimum system requirements. If the server does not meet the requirements, a warning of the form will appear in the terminal window:
Example of the warning
```
Checking available resources of the machine ... fail
Resources of the machine don't match with minimal requirements

  RESOURCE  | MACHINE  | REQUIRED  
------------+----------+-----------
  CPU Speed | 3.60 GHz |  2 GHz    
  CPU Cores |    1     |    2      
  RAM       | 0.47 Gb  |   2 Gb    
  Storage   | 6.94 Gb  |  40 Gb
```
To install the platform on a server with specifications below the required ones, add the -f parameter to the installation command:
Example command
```
./vm install -f
```
After the platform is installed successfully, in the terminal you will see the access link to VMmanager:
The panel has been successfully installed
```
Link to administrator registration page: https://1.2.3.4/auth/setup?token=C50A0BFA55DEDE3343AABE713022A15F
```
When you open a link, your browser will display a warning about a possible security threat. This happens if the server uses a self-signed SSL certificate. You can connect a valid SSL certificate to the platform by following the instructions.
Go to the VMmanager interface using the received link and create the first user:
1. Enter the User email.
2. Create a Password or click generate to automatically generate a password.
3. Click Done.
Activate the license:
1. Click the Setting button in the License not activated window.
2. In the License key field enter the value of the Token parameter of your license. You can find it in the Client area eu.ispsystem.com on the license information page.
3. Click Activate.
If you have a resource package certificate, activate it:
1. Go to → System information → Activate package .
2. Enter the code from your resource package certificate.
3. Click Activate.
  
  For more information about resource packs, see the Licensing article.

After installation, VMmanager platform will be available by the IP address or domain name of your server. The installer will be started as the systemd service.

Reinstalling the platform

Create a new Token value for your license. You can do it in your client area at eu.ispsystem.com or contact technical support.
Stop the platform:
```
vm down
```
Delete the directory /opt/ispsystem/vm :
```
rm /opt/ispsystem/vm -rf
```
Restart the vm service:
```
systemctl restart vm
```
Install the platform:
```
vm install
```
Activate the license:
1. In the right menu click → System information.
2. In the License key field enter the value of the Token parameter of your license. You can find it in the Client area eu.ispsystem.com on the license information page.
3. Click Activate.

If you have lost the login link

When VMmanager is installed on the server, but the first user is not created, you can get the unique link to the web-interface:

Connect through SSH to the server with VMmanager.
Execute the installation command through the systemd service vm:
```
vm install
```
Log in to the interface using the link and specify the credentials of the first user.
Activate the license:
1. In the right menu click → System information.
2. In the License key field enter the value of the Token parameter of your license. You can find it in the Client area eu.ispsystem.com on the license information page.
3. Click Activate.

Logs

The VMmanager installation log is kept in the file /opt/ispsystem/vm/install.log.

Useful tips