On this page:
   35.63    HTTP Access Log 35.65    HTTP Request Pool   

35.64HTTP Listener

 

The HTTP Listener configuration category includes the following configurable options:

  • Bind Address

  • Context Path

  • Endpoint Health Path

  • HTTPS Forwarding Assumed

  • Listener Port

  • Respect Forward Headers

35.64.1Property: 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
  • App Management Tools
  • CDS-Hooks REST Endpoint
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • FHIRWeb Console
  • Hybrid Providers REST Endpoint
  • JSON Admin API
  • Package Registry Endpoint
  • SMART App Host (Deprecated)
  • SMART Outbound Security
  • Subscription Websocket Endpoint
Default Value 0.0.0.0
Example Property
module.[MODULE_ID].config.bind_address = 0.0.0.0

35.64.2Property: 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
  • App Management Tools
  • CDS-Hooks REST Endpoint
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • FHIRWeb Console
  • Hybrid Providers REST Endpoint
  • JSON Admin API
  • Package Registry Endpoint
  • SMART App Host (Deprecated)
  • SMART Outbound Security
  • Subscription Websocket Endpoint
Default Value /
Example Property
module.[MODULE_ID].config.context_path = /

35.64.3Property: 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
  • App Management Tools
  • CDS-Hooks REST Endpoint
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • FHIRWeb Console
  • Hybrid Providers REST Endpoint
  • JSON Admin API
  • Package Registry Endpoint
  • SMART App Host (Deprecated)
  • SMART Outbound Security
  • Subscription Websocket Endpoint
Default Value /endpoint-health
Example Property
module.[MODULE_ID].config.endpoint_health.path = /endpoint-health

35.64.4Property: 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
  • App Management Tools
  • CDS-Hooks REST Endpoint
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • FHIRWeb Console
  • Hybrid Providers REST Endpoint
  • JSON Admin API
  • Package Registry Endpoint
  • SMART App Host (Deprecated)
  • SMART Outbound Security
  • Subscription Websocket Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.https_forwarding_assumed = false

35.64.5Property: Listener Port

 
Property Name Listener Port
Property Key
Property Type POSITIVE_INTEGER
Description The TCP port on which this module listens.
Applies to Modules
  • App Management Tools
  • CDS-Hooks REST Endpoint
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • FHIRWeb Console
  • Hybrid Providers REST Endpoint
  • JSON Admin API
  • Package Registry Endpoint
  • SMART App Host (Deprecated)
  • SMART Outbound Security
  • Subscription Websocket Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.port = 

35.64.6Property: 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
  • App Management Tools
  • CDS-Hooks REST Endpoint
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • FHIRWeb Console
  • Hybrid Providers REST Endpoint
  • JSON Admin API
  • Package Registry Endpoint
  • SMART App Host (Deprecated)
  • SMART Outbound Security
  • Subscription Websocket Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.respect_forward_headers = false
   35.63    HTTP Access Log 35.65    HTTP Request Pool