Docker
This instruction shows how to install the HES server using docker containers on Linux. Examples of commands are given for CentOS 7 and Ubuntu (18.04, 20.04, 22.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
in case of unsuccessful installation, on Centos, you may need to remove some packages
and retry the installation
Ubuntu
To verify installed docker version run the following command:
and docker compose:
2. Іnstalling HES in the docker
Download templates
We have prepared an archive with a template for building containers
Extracting files and moving to the /opt directory and create folders for HES
Build docker image
During operation, HES uses an encryption certificate that will be generated in the /opt/hes/hes-site/x509stores directory Since the server will run under the "root" user inside the container, you need to change the owner of the certificate directory:
Configure the HES
Copy file to /opt/HES/hes-site/appsettings.json
to /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.
Edit file:
А 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"
server=127.0.0.1 change here to server=hes-mysql
Your setting should look like this:
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 for MySQL (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 Docker for MS SQL (Optional)
Currently, HES can work with two databases: MySQL or MS SQL. By default, we use My SQL, but if you want to switch to MS SQL, you will need to perform a few additional steps, which will be described below
Skip this step, if you use a MySQL database
So, first you need to tweak the file /opt/HES/docker-compose.yml
We have prepared a template for the yml file to work with the MS SQL container. Just run the rename command:
You need to find the text in this file
SA_PASSWORD: C00ll_Passwrd_here
and set your SA user password instead of 'C00ll_Passwrd_here'. We will later need this password to create a user and HES database
Start MS SQL container only:
Use the docker exec -it command to start an interactive bash shell inside your running container
instead of "C00ll_Passwrd_here", enter your password here, which you specified in the /opt/HES/docker-compose.yml
file
The following sections walk you through using sqlcmd and Transact-SQL to create a new database and user.
Сhange <user_password> with your real password
You should remember the user password, it will come in handy later.
To exit from the Transact-SQL console, press Ctrl+C.
Now you need to tweak the file /opt/HEL/hes-site/appsettings.Production.json
The connection string should look like this
in the password line Password=password
, put your real password for user
, which you created in the previous step
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:
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:
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:
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'
Here you can find an update guide for Docker.
Last updated