openhim-core
Version:
The OpenHIM core application that provides logging and routing of http requests
213 lines (210 loc) • 7.88 kB
Markdown
OpenHIM Config options
======================
The following config option are provided by the OpenHIM. All of these options have default values. You only need to provide config options if they differ from the defaults.
```js
{
"bindAddress": "0.0.0.0",
"mongo": {
// The address of 1 or more mongo servers. If you are using a replicaSet
// you must specify the '?replicatSet=<name>' option in the url and list
// all of the hosts in the replica set in a comma separated list.
// eg. mongodb://localhost:27017,localhost:27018,localhost:27019/openhim?replicaSet=rs0
"url": "mongodb://localhost/openhim",
// The mongo address for the ATNA auditing to use, if different from the
// above.
"atnaUrl": "mongodb://localhost/openhim"
},
"logger": {
// the logging level
"level": "info",
// Whether to store log messages to mongo. Note: if this is disabled the
// logs API will NOT work!
"logToDB": true,
// Whether to cap the size of the log message stored in mongo. This only
// takes effect if the collection is being created for the first time. Ie.
// the first time the OpenHIM is run.
"capDBLogs": true,
// The max size in bytes of the logs collection
"capSize": 10000000,
},
"router": {
// The external hostname of the OpenHIM, used to rewrite urls in http responses
"externalHostname": "localhost"
// This is the port that the OpenHIM will receive HTTP request on to
// forward them to other services
"httpPort": 5001,
// This is the port that the OpenHIM will receive HTTPS request on to
// forward them to other services
"httpsPort": 5000,
// The timeout for requests that the OpenHIM makes to other services (in milliseconds)
"timeout": 60000
},
"api": {
// The port that the OpenHIM API uses
"httpsPort": 8080,
// API request are only valid for a particular window once made, this is
// the size of that window in seconds
"authWindowSeconds": 10,
// Max size allowed for ALL bodies in the transaction together
// Use min 1 MB to allow space for all routes on a transation and max 15 MB leaving 1 MB available for the transaction metadata
"maxBodiesSizeMB": 15,
// Max size of a request payload to the API
// Due to the maximum size of a mongo document, the bodies in the request will be truncated if the request is larger than 16MB
"maxPayloadSizeMB": 50,
// Certain API endpoints allow for details to be truncated, e.g. transactions with very large bodies
// This setting sets the size to truncate to (number of characters)
"truncateSize": 15000,
// A message to append to detail strings that have been truncated
"truncateAppend": "\n[truncated ...]"
},
"rerun": {
// The port that the transaction re-run processor runs on, this port is
// used internally and SHOULD NOT be expposed past your firewall
"httpPort": 7786,
// The host where the re-run processor is running (always the OpenHIM
// server)
"host": "localhost",
"processor": {
// if the processor is enabled or not
"enabled": true,
// The period to poll for new re-run tasks to run
"pollPeriodMillis": 2000
}
},
"tcpAdapter": {
"httpReceiver": {
// the port that the HTTP receiver for TCP transaction runs on. This
// is an internally used port and SHOULD NOT be exposed past your
// firewall.
"httpPort": 7787,
// The host where the tcp adpater's http receiver is running (always
// the OpenHIM server)
"host": "localhost"
}
},
"polling": {
// the port used by the polling channel processor, this is an internally
// used port and SHOULD NOT be exposed past your firewall.
"pollingPort": 7788,
// The host where the polling processor is running (always the OpenHIM
// server)
"host": "localhost"
},
"authentication": {
// What kind of authentication methods to allow
"enableMutualTLSAuthentication": true,
"enableBasicAuthentication": true
},
"email": {
// The address to use in the "from" field of the emails
"fromAddress": "address@example.com",
"nodemailer": {
// The nodemailer service to use see: https://github.com/andris9/Nodemailer
"service": "Gmail",
"auth": {
"user": "user@gmail.com",
"pass": "password"
}
}
},
"smsGateway": {
"provider": "clickatell",
"config": {
"user": "user",
"pass": "pass",
"apiID": "apiID"
}
},
"alerts": {
// To enable alerting when things go bad
"enableAlerts": true,
// How often to poll for alerts
"pollPeriodMinutes": 1,
// The name of the OpenHIM instance to use in the alert and report text
"himInstance": "openhim.jembi.org",
// The URL of the OpenHIM instance to use for links in the alert and
// report text
"consoleURL": "http://openhim.jembi.org"
},
"reports": {
// To enable daily and weekly reporting
"enableReports": true
},
"events": {
// Should event timestamps be normalized to the transaction time.
// This will be useful if you have mediators running on other servers
"enableTSNormalization": true
},
"statsd": {
// Report application metrics and transaction metrics to a statsd server
"enabled": false,
// The location of the statsd server (the default port must be used)
"host": "127.0.0.1"
},
"application": {
// The name of the application for use when reporting metrics to statsd
"name": "Development"
},
"newUserExpiry": {
// How long to wait before invalidating a user account if they don't
// login
"duration": 7,
"durationType": "days"
},
"auditing": {
// ATNA Audit Repository: Enable or disable the ATNA auditing servers and configure their ports
"servers": {
"udp": {
"enabled": false,
"port": 5050
},
"tls": {
"enabled": false,
"port": 5051
},
"tcp": {
"enabled": false,
"port": 5052
},
},
// ATNA Record Audit Event: Target repository for core to send its own audit events to
"auditEvents": {
// Connection type. Options are 'tcp', 'tls', 'udp' or 'internal'
// If 'internal' then audits will be sent to the HIM's internal audit repository.
"interface": "internal",
// Host and port are mandatory for all interfaces except 'internal', in which case the values are ignored
"host": "localhost",
"port": 5051
}
},
"caching": {
// Cache commonly used data for a performance boost
"enabled": true,
// How often should the cache be refreshed
"refreshMillis": 1000
},
"tlsClientLookup": {
// How should client be looked up using TLS. The options are 'strict'
// where the client's certificate common name must exactly match a
// client's domain attribute in the OpenHIM and 'in-chain' where as long
// as there is a client with a domain equal to any certificate in the
// client's certificate chain they will match.
"type": "strict"
},
"agenda": {
// How long to wait before starting up the async task processor
"startupDelay": 500
},
"certificateManagement": {
// Toggle whether to watch the file systems for the server certificate to
// use or to manage certifcates manually. If enables whenever certifcate
// changes are detected then the new certificate is loaded and the server
// user automatically restarted.
"watchFSForCert": false,
// The path to the server certificate (only used if watchFSForCert is enabled)
"certPath": "/etc/letsencrypt/live/openhim.jembi.org/cert.pem",
// The path to the server key (only used if watchFSForCert is enabled)
"keyPath": "/etc/letsencrypt/live/openhim.jembi.org/privkey.pem"
}
}
```