Powered by Smile CDR v2025.02.PRE

Showing documentation for 2025.02.PRE

On this page:

49.97 HTTP Access Log 49.99 HTTP Request Pool

49.98.1HTTP Listener

The HTTP Listener configuration category includes the following configurable options:

Bind Address
Context Path
Endpoint Health Path
Unhealthy Status Code
HTTPS Forwarding Assumed
Listener Port
Respect Forward Headers

49.98.2Property: Bind Address

Property Name	Bind Address
Property Key
Property Type	STRING
Description	The local network interface address to bind to. Set to `0.0.0.0` to bind to all addresses.
Applies to Modules	CDS Hooks REST Endpoint EasyShare SHL Endpoint (Admin) EasyShare SHL Endpoint (Public) FHIR Gateway REST Endpoint FHIR REST Endpoint (All FHIR Versions) FHIR REST Endpoint (DSTU2 - Deprecated) FHIR REST Endpoint (R3 - Deprecated) FHIR REST Endpoint (R4 - Deprecated) FHIRWeb Console HL7 v2.x Listening Endpoint Hybrid Providers REST Endpoint JSON Admin API MDM UI Package Registry Endpoint Payer to Payer Product Portal SMART Outbound Security Subscription Websocket Endpoint appSphere
Default Value	`0.0.0.0`
Example Property	`module.[MODULE_ID].config.bind_address = 0.0.0.0`

49.98.3Property: Context Path

Property Name	Context Path
Property Key
Property Type	STRING
Description	This setting provides the path at the given port that this server will listen on. By default the server simply listens at the `/` path, but this could be changed to a sub-path for some network architectures. For example, if a reverse proxy is proxying the server but also serving other endpoints with the same port at different paths, this setting can be used as a hint to this server as to which path should be used. If a reverse proxy is serving this server in such a way that a request to the proxy at `/baseurl/foo/index.html` should map to `/index.html` on this server, you should put `/baseurl/foo` as the context root.
Applies to Modules	CDS Hooks REST Endpoint EasyShare SHL Endpoint (Admin) EasyShare SHL Endpoint (Public) FHIR Gateway REST Endpoint FHIR REST Endpoint (All FHIR Versions) FHIR REST Endpoint (DSTU2 - Deprecated) FHIR REST Endpoint (R3 - Deprecated) FHIR REST Endpoint (R4 - Deprecated) FHIRWeb Console HL7 v2.x Listening Endpoint Hybrid Providers REST Endpoint JSON Admin API MDM UI Package Registry Endpoint Payer to Payer Product Portal SMART Outbound Security Subscription Websocket Endpoint appSphere
Default Value	`/`
Example Property	`module.[MODULE_ID].config.context_path = /`

49.98.4Property: Endpoint Health Path

Property Name	Endpoint Health Path
Property Key
Property Type	STRING
Description	Specifies a path (in the form `/path/to/endpoint`) that will be used as the Endpoint Health Check path. See Endpoint Health for information on this feature.
Applies to Modules	CDS Hooks REST Endpoint EasyShare SHL Endpoint (Admin) EasyShare SHL Endpoint (Public) FHIR Gateway REST Endpoint FHIR REST Endpoint (All FHIR Versions) FHIR REST Endpoint (DSTU2 - Deprecated) FHIR REST Endpoint (R3 - Deprecated) FHIR REST Endpoint (R4 - Deprecated) FHIRWeb Console HL7 v2.x Listening Endpoint Hybrid Providers REST Endpoint JSON Admin API MDM UI Package Registry Endpoint Payer to Payer Product Portal SMART Outbound Security Subscription Websocket Endpoint appSphere
Default Value	`/endpoint-health`
Example Property	`module.[MODULE_ID].config.endpoint_health.path = /endpoint-health`

49.98.5Property: Unhealthy Status Code

Property Name	Unhealthy Status Code
Property Key
Property Type	POSITIVE_INTEGER
Description	Status code to return if any Health Checks are unhealthy.
Applies to Modules	CDS Hooks REST Endpoint EasyShare SHL Endpoint (Admin) EasyShare SHL Endpoint (Public) FHIR Gateway REST Endpoint FHIR REST Endpoint (All FHIR Versions) FHIR REST Endpoint (DSTU2 - Deprecated) FHIR REST Endpoint (R3 - Deprecated) FHIR REST Endpoint (R4 - Deprecated) FHIRWeb Console HL7 v2.x Listening Endpoint Hybrid Providers REST Endpoint JSON Admin API MDM UI Package Registry Endpoint Payer to Payer Product Portal SMART Outbound Security Subscription Websocket Endpoint appSphere
Default Value	`200`
Example Property	`module.[MODULE_ID].config.endpoint_health.status_code_if_unhealthy = 200`

49.98.6Property: HTTPS Forwarding Assumed

Property Name	HTTPS Forwarding Assumed
Property Key
Property Type	BOOLEAN
Description	If enabled, the server will treat incoming requests as though they were secure even if they are not. This is useful in order to force redirects to use HTTPS in environments where the `X-Forwarded-Proto` does not reliably get passed from network infrastructure in front of Smile CDR to Smile CDR.
Applies to Modules	CDS Hooks REST Endpoint EasyShare SHL Endpoint (Admin) EasyShare SHL Endpoint (Public) FHIR Gateway REST Endpoint FHIR REST Endpoint (All FHIR Versions) FHIR REST Endpoint (DSTU2 - Deprecated) FHIR REST Endpoint (R3 - Deprecated) FHIR REST Endpoint (R4 - Deprecated) FHIRWeb Console HL7 v2.x Listening Endpoint Hybrid Providers REST Endpoint JSON Admin API MDM UI Package Registry Endpoint Payer to Payer Product Portal SMART Outbound Security Subscription Websocket Endpoint appSphere
Default Value	`false`
Example Property	`module.[MODULE_ID].config.https_forwarding_assumed = false`

49.98.7Property: Listener Port

Property Name	Listener Port
Property Key
Property Type	POSITIVE_INTEGER
Description	The TCP port on which this module listens.
Applies to Modules	CDS Hooks REST Endpoint EasyShare SHL Endpoint (Admin) EasyShare SHL Endpoint (Public) FHIR Gateway REST Endpoint FHIR REST Endpoint (All FHIR Versions) FHIR REST Endpoint (DSTU2 - Deprecated) FHIR REST Endpoint (R3 - Deprecated) FHIR REST Endpoint (R4 - Deprecated) FHIRWeb Console HL7 v2.x Listening Endpoint HL7 v2.x Listening Endpoint (Deprecated) HL7 v2.x Sending Endpoint Hybrid Providers REST Endpoint JSON Admin API MDM UI Package Registry Endpoint Payer to Payer Product Portal SMART Outbound Security Subscription Websocket Endpoint appSphere
Default Value	(no default)
Example Property	`module.[MODULE_ID].config.port =`

49.98.8Property: Respect Forward Headers

Property Name	Respect Forward Headers
Property Key
Property Type	BOOLEAN
Description	If enabled, the server will respect values provided by the client in the HTTP `Forward`, `X-Forwarded-For`, `X-Forwarded-Host`, and `X-Forwarded-Proto` headers. These headers are useful in cases where Smile CDR is being served behind a reverse proxy. This setting should be disabled if the server is not behind a proxy since this could allow clients to masquerade their source IP, which is a security risk. See Respecting Forward Headers for more information.
Applies to Modules	CDS Hooks REST Endpoint EasyShare SHL Endpoint (Admin) EasyShare SHL Endpoint (Public) FHIR Gateway REST Endpoint FHIR REST Endpoint (All FHIR Versions) FHIR REST Endpoint (DSTU2 - Deprecated) FHIR REST Endpoint (R3 - Deprecated) FHIR REST Endpoint (R4 - Deprecated) FHIRWeb Console HL7 v2.x Listening Endpoint Hybrid Providers REST Endpoint JSON Admin API MDM UI Package Registry Endpoint Payer to Payer Product Portal SMART Outbound Security Subscription Websocket Endpoint appSphere
Default Value	`false`
Example Property	`module.[MODULE_ID].config.respect_forward_headers = false`

49.97 HTTP Access Log 49.99 HTTP Request Pool