This instruction is only an example and does not describe a system for production, which typically requires orchestration tools or Docker hosting platforms.
Knowledge about docker.
A Linux host (Windows is not officially supported) with docker and docker-compose installed and configured
A public DNS name which devices can reach.
Matching certificates for the public address.
Installed instance of an SQL server, such as PostgreSQL, Microsoft SQL Server or Maria DB.
Download the Hermod docker image and file structure from Nexus support portal.
- Log in to Nexus Support portal.
- Go to Nexus Personal > Nexus Personal Messaging server and click a Hermod version to download the *.zip file.
- Unpack the *.zip file.
- Open the folder which was extracted, for example 3.x.y.RELEASE. Here you find the Hermod installation file and a simple-setup file to set up a default configuration.
- Unpack simple-setup.zip.
The following file structure will be created for configuration and certificate files:
- Put one or multiple CA certificates in base64 format with .cer file extension in the folder example/compose/hermod/cacerts. The filenames must not contain spaces.
Put one or multiple certificate containers - including the whole certificate chain with any intermediate CA certificates - in pkcs#12 format (with .pfx or .p12 extension) in the folder example/compose/hermod/certificates. The filenames must not contain spaces.
Failing to include intermediate CA certificates might produce erratic behavior in the Smart ID Mobile App, which is very difficult to troubleshoot.
The certificate containers are referred to from the configuration file application.yml (cod-hermod.yml). See below in the Hermod configuration section.
The docker image can be loaded locally to each machine, or to the docker registry, and used remotely from several machines.
If you want to load the released docker image locally on the target host:
- If you have a docker registry, load the image there.
To edit the docker compose configuration:
Edit the configuration file docker-compose.yml with the correct values for your environment. Below you can find examples, but the actual values must match the specific deployment scenarios.
File path: example/compose/hermod/docker-compose.yml
The default value for context path and uri base is /hermod/rest/ (that is http://localhost:20400/hermod/rest/...). You might want to change this for your specific configuration.
For example, if you want to change the context path and uri base to empty values, change the start command for Hermod in docker-compose.yml:
Also set the uribase to empty in the Hermod configuration, see the next step.
See also Add API user and callback URL in Hermod.
To edit the Hermod configuration:
Edit the configuration file config/application.yml (config/cod-hermod.yml might be a link) with the correct values for your environment. Below you can find examples, but the actual values must match the specific deployment scenarios.
Default file path: example/compose/hermod/config/application.yml
If you want to change the uribase, set the corresponding variable, for example to empty, in the application.yml (cod-hermod.yml) configuration file:
Start Postgres (unless you have you own, external instance running):
Connect to your database and run the SQL ddl for the specific vendor/version, for example, postgresql/V3.1.1__base_version.sql.
Start Hermod with the following command:
To install and start Hermod test app, which is a GUI that can be used for basic tests, see Install Hermod test app.
Make sure that the public URL that has been configured in Hermod has a valid and trusted SSL certificate. This can be verified by opening the Hermod public URL in a browser and make sure the connection is secure, by viewing the padlock in the browser bar.