openhim-mediator-file-queue/config/config.json

An async file queue for OpenHIM mediators

{
  "port": 4003,
  "heartbeat": true,
  "host": "",
  "endpoints": [],
  "log_level": "info",
  "statsd": {},
  "api": {
    "apiURL": "https://localhost:8080"
  },
  "mediatorConf": {
    "urn": "urn:uuid:a15c3d48-0686-4c9b-b375-f68d2f244a33",
    "version": "3.0.0",
    "name": "file-queue",
    "description": "Async file queue mediator for the OpenHIM",
    "defaultChannelConfig": [],
    "endpoints": [
      {
        "name": "File queue",
        "host": "localhost",
        "path": "/workers/test",
        "port": "4002",
        "primary": true,
        "type": "http"
      }
    ],
    "configDefs": [
      {
        "param": "endpoints",
        "displayName": "Endpoints",
        "description": "Configure File Queue endpoints",
        "type": "struct",
        "array": true,
        "template": [
          {
            "param": "name",
            "displayName": "Name",
            "description": "The name of the endpoint which is used for setting up the RESTlike routes for the worker",
            "type": "string"
          },
          {
            "param": "path",
            "displayName": "Path",
            "description": "The path to use for handling incoming requests. A '*' may be used to match any number of characters in a path.",
            "type": "string"
          },
          {
            "param": "url",
            "displayName": "Upstream URL",
            "description": "The URL to send the files to when processing them from the queue.",
            "type": "string"
          },
          {
            "param": "paused",
            "displayName": "Paused",
            "description": "Whether or not the endpoint's worker should be paused by default. This must be a boolean value.",
            "type": "bool"
          },
          {
            "param": "parallel",
            "displayName": "Parallel",
            "description": "The number of files that the worker should process in parallel.",
            "type": "number"
          },
          {
            "param": "updateTx",
            "displayName": "UpdateTx",
            "description": "Whether or not to attempt to update the OpenHIM transaction once the message has been processed.",
            "type": "bool"
          },
          {
            "param": "forwardMetadata",
            "displayName": "ForwardMetadata",
            "description": "Whether or not to use the url, headers and HTTP method of the original request when it is forwarded. The path of the original request will be appended to the url property.",
            "type": "bool"
          },
          {
            "param": "disableAutoChannelManagement",
            "displayName": "Disable auto channel managment",
            "description": "If disabled, the mediator won't automatically create and update channels as endpoint config is updated.",
            "type": "bool"
          }
        ]
      }
    ],
    "config": {
      "endpoints": [
        {
          "name": "echoServer",
          "path": "/test",
          "url": "http://localhost:8000",
          "paused": false,
          "parallel": 2,
          "updateTx": true,
          "forwardMetadata": true,
          "disableAutoChannelManagement": false
        }
      ]
    }
  }
}