Installation instructions#

The application is typically installed using a docker image. Other installation types will be available in the future.

Docker#

To install the application with docker you need to create two volumes first:

namepathdescription
config/configContains the application settings.
manifests/dataContains the manifest files

As a simple ApplicationSettings.yaml file you can use the following:

1
2
3
Logging:
  LogToConsole: true
  MinimumLogLevel: Information  

If no log file is found the application creates a new ApplicationSettings.yaml file using default values in the /config path.

Copy your manifest file in the data directory and name it Manifest.yaml.

With that we can now start the docker container via:

1
2
3
4
5
docker run -d \
  --restart=always \
  -v MyVolume/config:/config \
  -v MyVolume/manifests:/data \
  "osgaga/mqtt2otel:latest"

or if you are using docker-compose:

1
2
3
4
5
6
7
8
9
version: "3.9"

services:
  mqtt2otel:
    container_name: mqtt2otel
    image: "osgaga/mqtt2otel"
    volumes:
      - ./config:/config
      - ./manifests:/data

and then

1
docker-compose up -d