Knowledge about docker.
A host 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 (unless included in the installation procedure described in this article).
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 2.3.x.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 your certificates in example/compose/hermod/certificates and example/compose/hermod/cacerts.
The filenames must not contain spaces and the extension on certificates in cacerts should be .cer.
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.
To edit the Hermod configuration:
Edit the configuration file config/cod-hermod.yml 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/cod-hermod.yml
If you want to change the uribase, set the corresponding variable, for example to empty, in the 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/V2.3.x_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.