Configuration

The default.json file includes defaults that can be overridden. The easiest way to override the defaults for a given installation is to create a local.json that specifies only the properties that you want to override.

Property	Required?	Type	Description
server.hostname	No	string (default: localhost)	The host name that the server should bind to (recommended "0.0.0.0")
server.port	No	number (default: 3333)	The port that the server should bind to
server.https	No	object	If the object is present and has both a key and cert path, indicates that the server should be hosted using the key/cert as https
server.https.keyPath	Yes	string	The path on the file system to the key. Required to be PEM format.
server.https.certPath	Yes	string	The path on the file system to public cert. Required to be in PEM format.
server.enableSecurity	Yes	boolean	Whether to enable additional security/permissions in ToF. Authentication is always required, but when this is disabled any logged-in user can access any resource in the system. When enabled, additional permissions take effect and users must have permissions to view/edit individual resources.
server.supportUrl	Yes	string	Where users should be redirected to when they click the "Request Support" button
server.googleAnalyticsCode	No	string	A google analytics code to track ToF usage at a specific installation
server.logFileName	No	string (default: logs/tof.log)	The path to the file that should store logs
server.logLevel	No	"all" or "trace" or "warn" or "error" (default: all)	The level of logging that should be reported
server.maxLogSizeKB	No	number (default: 1024)	The maximum size that each log file can have it in, before rolling to a new log file.
server.maxRequestSizeMegabytes	Yes	number (default: 50)	What the maximum requests size is allowed for the node.js server. This for requests from the browser to the ToF server.
server.latestIgPublisherPath	No	string (default: assets/ig-publisher/latest)	The location on the server where the latest version of the IG publisher should placed
server.bannerMessage	No	string	An optional message that can be displayed on all pages to users.
server.maxAsyncQueueRequests	No	number (default: 10)	The maximum number of asynchronous requests that can be made to the configured FHIR servers at a single time. Currently this is only using during import. May be applied to more locations in the future.
publish.queueLimit	Yes	number (default: 2)
publish.timeout	Yes	number
auth	Yes		See Authentication for more information on how to configure authentication.
auth.clientId	Yes	string
auth.scope	Yes	string
auth.logoutUrl	Yes	string
auth.issuer	Yes	string
auth.jwksUri	Yes	string
headerPropogation
github	No		Configurable properties related to Github integration functionality
github.clientId	Yes	string	The client id of the application registered with github. See Github Applications to create/register ToF as an application for your Github organization.
github.secret	Yes	string	The secret/password of the application registered with github
announcementService	No		Configuration to allow integration with a mailing list provider. Currently only campaigner is supported. In future, may consider support for other services such as MailChimp.
announcementService.type	Yes	"campaigner"
announcementService.apiKey	Yes	string	The API key to make requests to the mailing list provider
announcementService.listId	Yes	string	The ID of the mailing list to add users to
fhir.nonEditableResource    .RESOURCE_TYPE	No	Array of string	A list of resource instances that cannot be edited by users. This may include pre-loaded implementation guides and profiles.
fhir.publishedGuides	Yes	string	The URL that should be used to find a list of published implementation guides.
fhir.latestPublisher	Yes	string	The URL where the latest version of the FHIR IG publisher should be downloaded.
fhir.servers	Yes		List of FHIR servers that are supported by the installation of ToF.
fhir.servers.id	Yes	string	The internal id of the FHIR server. This can be arbitrarily set for each ToF installation, and is only used internally to ToF. Note, this is visible in the browser's URL to ToF.
fhir.servers.name	Yes	string	The name of the FHIR server to display to the user in the options.
fhir.servers.uri	Yes	string	The Base URL of the FHIR server.
fhir.servers.version	Yes	"stu3" or "r4"	The version of FHIR supported by this FHIR server.
fhir.servers.short	Yes	string	A very short display name for the FHIR server that is displayed to users in the top-right of every screen.
fhir.servers.supportsSnapshot	No	boolean (default: false)	Whether or not the server supports the $snapshot operation.
fhir.servers.supportedLogicalTypes	Yes	string[]	A list of logical type configurations that are supported by this FHIR server. ToF comes with logical type configurations for "FHIR-STU3", "FHIR-R4" and "CDA-R2.1"