Skip to content

Latest commit

 

History

History
166 lines (154 loc) · 4.57 KB

CONFIGURE.md

File metadata and controls

166 lines (154 loc) · 4.57 KB
Raw

HOMER-APP Configuration

The homer-app configuration includes a number of blocks allowing it to communicate with its connected elements.

Database Data

The data connections allow homer-app to communicate with one or more db nodes to fetch data results. The database_data element can contain one or more objects reflecting each unique node:

Single Node
  "database_data": {
    "LocalNode": {
      "help": "Settings for PGSQL Database (data)",
      "node": "LocalNode",
      "user": "homer_user",
      "pass": "homer_password",
      "name": "homer_data",
      "host": "127.0.0.1"
    }
  }
Multi Node
  "database_data": {
    "LocalNode": {
      "help": "Settings for PGSQL Database (data)",
      "node": "LocalNode",
      "user": "homer_user",
      "pass": "homer_password",
      "name": "homer_data",
      "host": "127.0.0.1"
    },
    "RemoteNode": {
      "help": "Settings for PGSQL Database (data)",
      "node": "RemoteNode",
      "user": "homer_user",
      "pass": "homer_password",
      "name": "homer_data",
      "host": "127.0.0.2"
    }
  }

Database Config

The config connection allows homer-app to read and write its configuration items to database.
NOTE: the database should be initialized using the dedicated commands.

  "database_config": {
    "help": "Settings for PGSQL Database (settings)",
    "node": "LocalConfig",
    "user": "homer_user",
    "pass": "homer_password",
    "name": "homer_config",
    "host": "localhost"
  }

InfluxDB Config (optional)

When desirable, homer-app can be configured to fetch timeseries from InfluxDB. Configure when needed.

  
  "influxdb_config": {
    "help": "Settings for InfluxDB Database (optional)",
    "user": "influx_user",
    "pass": "influx_password",
    "name": "homer_config",
    "host": "http:/127.0.0.1:8086" ,
    "database": "homer",
    "policy": "autogen"
  }

Prometheus Config (optional)

When desirable, homer-app can be configured to fetch timeseries from Prometheus. Configure when needed.

  "prometheus_config": {
    "help": "Settings for Prometheus Database (optional)",
    "user": "admin",
    "pass": "admin",
    "host": "http://127.0.0.1:9090",
    "api": "api/v1"
  }

Loki Config (optional)

When desirable, homer-app can be configured to fetch logs from Loki. Configure when needed.

  "loki_config": {
    "help": "Settings for LOKI Database (optional)",
    "user": "admin",
    "pass": "admin",
    "host": "http://127.0.0.1:3100",
    "api": "loki/api/v1",
    "param_query": "query_range"
  }

Server Config (mandatory)

This section defines the parameters used by homer-app to serve its API and Frontend. The root location refers to the full path where the User-Interface is deployed.

  "http_settings": {
    "help": "Settings for the HOMER Webapp Server",
    "host": "0.0.0.0",
    "port" : 9080,
    "root" : "/usr/local/homer/dist",
    "gzip" : true,
    "debug" : false
  }

System Settings

This section defined the path and names used for homer-app generated logs. Configure when needed. Loglevels: fatal, error, warn, info, debug, trace If the loglevel is >= info , the stdout will be enabled automaticaly.

  "system_settings": {
    "help": "Settings for HOMER logs",
    "logpath": "/usr/local/homer/log",
    "logname" : "homer-app.log",
    "loglevel": "error",
    "logstdout": false
  }

Authentication Settings

This section defines how homer-app will authenticate its API and UI users. By default, uses internal database.

  "auth_settings": {
    "_comment": "The type param can be internal, ldap",
    "type": "internal"
  },
  "ldap_config": {
    "base":  "dc=example,dc=com",
		"host":  "ldap.example.com",
		"port":   389,
    "usessl": false,
    "skiptls": true,
		"binddn": "uid=readonlysuer,ou=People,dc=example,dc=com",
		"bindpassword": "readonlypassword",
		"userfilter": "(uid=%s)",
    "groupfilter": "(memberUid=%s)",
    "admingroup": "admin",
    "adminmode": true,
    "attributes": ["givenName", "sn", "mail", "uid"]
  },
}

or if you want to make anonymous binding:

  "ldap_config": {
  ....
    "anonymous": true,
    "userdn": "uid=%s,ou=People,dc=example,dc=com"
  }

External Decoder Settings

This section defines an external packet decoder pipeline returning advanced dissection in JSON format:

  "decoder_shark": {
    "_comment": "Perform packet decoding using tshark application. Please define uid, gid if you run the app under root",
    "active": true,
    "bin": "/usr/bin/tshark",
    "protocols":  ["1_call","1_registration", "1_default"]
  }