iothub.yml file reference

Quick Reference

The following is a complete list of configuration attributes available.

For more information about the attributes see the explanation below.

general:
  baseurl: http://localhost       # mandatory
  bind: 0.0.0.0 
  debug: false 
  docker: 
    registry: de 
  license_id: ""
  name: iothub 
  port: 80 
  ui: true 
  single_tenant: false 
  initial_mail: demo@example.com  # mandatory
  initial_password: ****          # mandatory
  version: v4.0.3

persistence:                               
  database: 
    database: iothub 
    host: "" 
    port: 3306 
    password: **** 
    type: maria 
    user: iothub    
  influx: 
    host: "" 
    password: **** 
    port: 8086 
    user: iothub

services:
  alarming: 
    enable: false 
  appdesigner: 
    enable: false 
  email: 
    enable: false 
    host: "" 
    port: 0 
    user: "" 
    password: "" 
    from: ""    
  gateway: 
    enable: false 
    agent_port: 9090 
    bind: 0.0.0.0 
    controller_port: 9190   
  history: 
    enable: false 
  workflow: 
    enable: false

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

Details

general

This parts contains detailed information about all attributes of the general configuration branch.

baseurl

mandatory
The url your IoTHub instance is reachable from the outside world.

Format: http(s)://your.url.com(:port)

bind

default: 0.0.0.0
This option allows you to set the IP-Address to bind the web front-end and RestAPI to

debug

default: false
Settings this option to true will enable the debug log output, which might help us helping you, if you are facing a problem.

But: As with this option enabled your IoTHub needs a bit more performance and it will need more disk space over time (due to the heavy log output), we recommend you to enable this option only when you are requested to do so by us.

docker

configuration options for a docker-based deployment.

docker > registry

default: de
With this option you can select the download endpoint to use during installation. In the first place this is interesting if you want to run an IotHub in china main land, as the download from your german server might be slow there.

Available options:

initial_mail

mandatory
Mail address for the initial user created on the first start of an IoTHub instance.

initial_password

mandatory
Password for the initial user created on the first start of an IoTHub instance.

license_id

default: empty
Use this option if you have different licenses on a system and want to enforce the IoTHub to use a specific one

name

default: iothub
This is the identifier of the IoTHub instance and it needs to be unique for one machine.

port

default: 80
This attribute lets you set the port to bind the web front-end and RestAPI to

single_tenant

default: false
By default a multi-tenant IoTHub will be created. If true, the IoTHub will be single_tenant.

This option has only an effect on the first start of a new IoTHub instance.

ui

default: true
If you set this option to false no web front-end will be installed. The IoTHub can still be managed via the RestAPI.

version

default: latest version at release time of the iothubctl
Here you can set the version of the IoTHub which you want to install

persistence

This parts contains detailed information about all attributes of the persistence configuration branch.

database

It is possible to use you own database system or to let us manage the database.

database > database

default: iothub
This attribute sets name of the database to use. If we manage the database system a database with this name will be created during the installation. If you use you own database sytstem you need to set the name of the database the IoTHub should use here.

database > host

default: empty

If you want to use your own database system you need to set the IP address or DNS name of the DBS here. If this option remains empty, the iothubctl will create an database system during the installation process for you.

database > port

default: 3306
If you want to use your own database system you need to set Port of the DBS here.

database > password

With this option you can provide the password to login on you database system.

database > type

default: maria
If we create/handle the database system for you, we will use MariaDB 10.4.

As the database systems have some differences between each other the IoTHub needs to know with which DBS he is talking to.
The following database systems are support:

DBS	type
MariaDB	maria
MySQL 5	mysql
MySQL 8	mysql

database > user

With this option you can provide the username to login on you database system. This user should have all privileges on the database you have provided in the database option.

influx

It is possible to use you own InfluxDB instance or to let us manage it.

influx > host

default: empty

If you want to use your own InfluxDB, you need to set the IP address or DNS name of it here. If this option remains empty, the iothubctl will create an InfluxDB instance during the installation process for you.

influx > password

With this option you can provide the password to login on you InfluxDB instance.

influx > port

default: 8086
If you want to use your own InfluxDB instance, you need to set Port of it here.

influx > user

With this option you can provide the username to login on you InfluxDB instance.

services

This parts contains detailed information about all attributes of the services configuration branch.

alarming

Here you can enable the alarming service.

alarming > enable

default: false
set this option to true, if you want to use the alarming service

appdesigner

In this option group you can enable the AppDesigner

appdesigner > enable

default: false
set this option to true, if you want to use the appdesigner service

appdesigner > bind

default: 0.0.0.0
the ip address to bind the apphub endpoint against

appdesigner > port

default: 9290
the port to bind the apphub endpoint against

email

With this option group you can configure the mailing service of the IoTHub. You need at least fill host, port, user and password to successful start the mailing service.

email > enable

default: false
set this option to true, if you want to use the mailing service

email > host

default: empty
Set this to an valid IP address or dns name of an smtp server

email > port

default: empty
provide the port for the smtp server

email > user

default: empty
Set the username to login on the smtp server

email > password

default: empty
Set the password to login on the smtp server

email > from

default: empty
Here you should set the from address to use when the service is sending mails.

gateway

With this option group you can configure the agent endpoint of the IoTHub.

gateway > enable

default: false
set this option to true, if you want to use the agent endpoint

gateway > agent_port

default: 9090
the port to bind the agents endpoint against

gateway > bind

default: 0.0.0.0
the ip address to bind the agents endpoint against

gateway > controller_port

default: 9190
the port to bind the agent controller endpoint against

history

With this option group you can configure the historical data service of the IoTHub.

history > enable

default: false
set this option to true, if you want to use the historical data service

workflow

With this option group you can configure the workflow engine of the IoTHub.

workflow > enable

default: false
set this option to true, if you want to use the workflow engine

# iothub.yml file reference

# Quick Reference

# Details

# general

# baseurl

# bind

# debug

# docker

# docker > registry

# initial_mail

# initial_password

# license_id

# name

# port

# single_tenant

# ui

# version

# persistence

# database

# database > database

# database > host

# database > port

# database > password

# database > type

# database > user

# influx

# influx > host

# influx > password

# influx > port

# influx > user

# services

# alarming

# alarming > enable

# appdesigner

# appdesigner > enable

# appdesigner > bind

# appdesigner > port

# email

# email > enable

# email > host

# email > port

# email > user

# email > password

# email > from

# gateway

# gateway > enable

# gateway > agent_port

# gateway > bind

# gateway > controller_port

# history

# history > enable

# workflow

# workflow > enable