v3.8

Linux Docker deployment

Hideez Enterprise Server on Linux Docker

This instruction shows how to install the HES server using docker containers on Linux. Examples of commands are given for CentOS (7,8) and Ubuntu (18.04, 20.04) , other versions of the Linux was not tested.

First of all, you need to decide what URL will be for your future HES server. It can be something like hideez.yurcompany.com. Hereinafter, this name is indicated as <your_domain_name>. You can copy this instruction into any text editor and replace all instances of the <your_domain_name> with your name. After that, you can execute most of the commands just copying them from the editor.

You need to add your domain name to the DNS settings of your hosting provider.

1. Preparation (if not already done)

Install Docker

You can also always refer to the official installation documentation: https://docs.docker.com/engine/install

CentOS

$ sudo yum install -y yum-utils
$ sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
$ sudo yum install -y docker-ce docker-ce-cli containerd.io
$ sudo systemctl start docker
$ sudo systemctl enable docker

in case of unsuccessful installation, on Centos 8, you may need to remove some packages

$ sudo yum remove podman buildah -y

and retry the installation

Ubuntu

$ sudo apt-get install -y  apt-transport-https  ca-certificates curl gnupg lsb-release
$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
$ sudo echo \
  "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
$ sudo apt update
$ sudo apt install docker-ce -y

To verify installed docker version run the following command:

$ docker --version
Docker version 20.10.10, build b485636

Install Docker Compose

You can also always refer to the official installation documentation: https://docs.docker.com/compose/install/

$ sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose

Note: Replace “1.29.2” with docker compose version that you want to install but at this point of time this is the latest and stable version of the docker compos. You can see all releases of docker-compose here.

Test the installation.

$ sudo docker-compose --version
docker-compose version 1.29.2, build 5becea4c

in some cases (CentOS), if you can't start docker-compose from sudo (sudo: docker-compose: command not found), you need to create a link in /usr/bin/

$ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

2. Іnstalling HES in the docker

Download templates

We have prepared an archive with a template for building containers

$ cd ~
$ curl -O https://update.hideez.com/hes/docker_latest.tar.gz

Extracting files and moving to the /opt directory and create folders for HES

$ tar -xvf docker_latest.tar.gz
$ sudo mv HES /opt/

Build docker image

$ cd /opt/HES/
$ sudo docker build . -t hes

Configure the HES

Copy file to /opt/HES/hes-site/appsettings.json to /opt/HES/hes-site/appsettings.Production.json :

$ sudo cp /opt/HES/hes-site/appsettings.json /opt/HES/hes-site/appsettings.Production.json

The file /opt/HES/hes-site/appsettings.Production.json contains configuration and security settings, required to run the HES server.

А detailed description of the parameters of this file can be found on this page.

To start the container edit the file /opt/HES/hes-site/appsettings.Production.json, it is enough to change only the parameter in "DefaultConnection"

 "ConnectionStrings": {
    "DefaultConnection": "server=127.0.0.1;port=3306;database=db;uid=user;pwd=password"
  },

server=127.0.0.1 change here to server=hes-db

Your setting should look like this:

 "ConnectionStrings": {
    "DefaultConnection": "server=hes-db;port=3306;database=db;uid=user;pwd=password"
  },

WARNING! This names must be the same as the MySQL container name in the /opt/HES/docker-compose.yml

server - name of mysql server.

port - put here "3306". This is default value.

database - name of the DB (e.g. "db").

uid - username to access the DB (e.g. "user").

pwd - user password to access the DB. (default "password")

Configure the Docker (Optional)

Open the /opt/HES/docker-compose.yml file for editing. In this file you need to modify several parameters:

MYSQL_DATABASE - put here the same name as database in appsettings.Production.json (e.g. "db").

MYSQL_USER - put here the same name as uid in appsettings.Production.json (e.g. "user").

MYSQL_PASSWORD - put here the same password as password in appsettings.Production.json

MYSQL_ROOT_PASSWORD - put here the password for mysql root account. (default is "password")

Configure the Nginx (Optional)

Open the /opt/HES/nginx/nginx.conf file for editing. Uncoment and replace all instances of <your_domain_name> with your name.

Create a SSL Certificate

Here we providing instruction on how to get a self-signed certificate for SSL encryption. It can be used for test or demo purposes. For the production server, you need to acquire a certificate from a certificate authority. For a self-signed certificate, the browser will alert you that the site has security issues.

Run the following command and answer a few simple questions:

$ sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /opt/HES/nginx/certs/hes.key -out /opt/HES/nginx/certs/hes.crt

The certificate will be generated and copied to the HES directory.

Run the Server

Finally, when config files updated and certificate ready you can run the server:

$ cd /opt/HES
$ sudo docker-compose up -d

after uploading the images, your server is ready to work

Check the status

You can check the status of the docker containers running the command:

$ sudo docker-compose ps
 Name                 Command               State                                   Ports                                 
---------------------------------------------------------------------------------------------------------------------------
hes-db      docker-entrypoint.sh --def ...   Up      0.0.0.0:3306->3306/tcp,:::3306->3306/tcp, 33060/tcp                   
hes-nginx   /docker-entrypoint.sh ngin ...   Up      0.0.0.0:443->443/tcp,:::443->443/tcp, 0.0.0.0:80->80/tcp,:::80->80/tcp
hes-site    ./HES.Web                        Up      5000/tcp

To make sure that everything is configured correctly, open the URL of your site in a browser (https://<your_domain_name>). You should see the server authorization page. Log in using the default login 'admin@server' and default password 'admin'.

In case you cannot log in to the HES, see log files located in '/opt/HES/hes-site/logs'

3. How to update HES server

(Optimal) Backup the MySQL Database (for possible further recovery)) :

The following command will create a copy of the database (dump) in file db.sql in /opt/HES.old directory (on host) from container with name hes-db:

$ sudo mkdir /opt/HES.old
$ cd /opt/HES/
$ sudo sh -c "docker exec hes-db /usr/bin/mysqldump -u root --password=password db > /opt/HES.old/db.sql"

Stop containers:

$ cd /opt/HES/
$ sudo docker-compose down

(Optimal) Save the image of HES to a tar file (for possible further recovery):

$ sudo docker save -o /opt/HES.old/hes.tar hes

Remove image of HES:

$ sudo docker rmi hes --force

To upgrade the server to the latest version, run commands:

$ sudo docker build . -t hes

and Restart containers:

$ sudo docker-compose up -d

If something goes wrong, you can restore the HES server using the following commands:

Stop containers:

$ cd /opt/HES/
$ sudo docker-compose down

Remove image of HES:

$ sudo docker rmi hes --force

Start MySQL container only:

$ sudo docker-compose up -d hes-db

Restore the MySQL Database from dump file:

$ sudo cat /opt/HES.old/db.sql | sudo docker exec -i hes-db /usr/bin/mysql -u root --password=password db
$ sudo docker-compose down

Restore old image of HES from tar file:

$ sudo docker load -i /opt/HES.old/hes.tar

and start containers:

$ sudo docker-compose up -d

After checking that the update was successful and everything works fine, you can delete copies of the database and server:

$ sudo rm -rf /opt/HES.old

Last updated