Skip to content

Server

Under the server config option the (http) server can be configured.

port

integer 7672 optional

The port config option is used to set the port at which LightHouse starts the webserver and listens for incoming requests. Will only be used if tls is not used. If tls is enabled port 443 will be used (and optionally port 80).

config.yaml 
server:
    port: 4242

tls

Under the tls config option settings related to tls can be configured. It is unlikely that one enables tls since a reverse proxy will be used in most cases.

If tls is enabled port 443 will be used.

config.yaml 
server:
    tls:
        enabled: true
        redirect_http: true
        cert: /path/to/cert
        key: /path/to/key

enabled

boolean true optional

If set to false tls will be disabled. Otherwise, it will automatically be enabled, if cert and key are set.

redirect_http

boolean true optional

The redirect_http option determines if port 80 should be redirected to port 443 or not.

cert

file path required for TLS

The cert option is set to the tls cert file.

key

file path required for TLS

The key option is set to the tls key file.

trusted_proxies

list of strings optional

The trusted_proxies option is used to configure a list of trusted proxies by IP address or network range (CIDR notation).

If LightHouse runs behind some sort of proxy, like a load balancer, then certain header information may be sent to LightHouse using special X-Forwarded-* headers or the Forwarded header. For example, to forward the client's real IP address.

If set, such header information is only used when the request comes via one of the trusted proxies. If unset, the information is always read from the headers, which might be spoofed.

config.yaml 
server:
    trusted_proxies:
        - "10.0.0.0/8"
        - "172.16.0.0/12"
        - "192.168.0.0/16"
        - "fc00::/7"

forwarded_ip_header

string X-Forwarded-For optional

The forwarded_ip_header option specifies which HTTP header to use for getting the client's real IP address when behind a proxy.

config.yaml 
server:
    forwarded_ip_header: X-Real-IP