Skip to content

Latest commit

 

History

History
98 lines (67 loc) · 4.05 KB

settings.md

File metadata and controls

98 lines (67 loc) · 4.05 KB
Raw

Configuration settings for httpserver

Configuration for httpserver can be provided in either json or toml format. Json examples are used below.

Fields and default values

Anything not specified in your settings file inherits the default.

Address

Address is a string in the form "IP:PORT". The default bind address is "127.0.0.1:8000". The IP address may be an IPV4 or IPV6 address.

TLS

An empty tls section, or no tls section, disables tls. To enable TLS, both cert_file and priv_key_file must contain absolute paths to existing files.

CORS

  • allowed_origins - a list of allowed origin addresses. See Access-Control-Allow-Origin Each origin must begin with either 'http:' or 'https:'. If the list is empty (the default) all origins are allowed. The default setting allows all origin hosts.

  • allowed_methods - a list of upper case http methods. See Access-Control-Allow-Headers Default:

    ["GET","POST","PUT","DELETE","HEAD","OPTIONS"]

  • allowed_headers - a list of allowed headers, case-insensitive. See Access-Control-Allow-Headers Default:

    ["accept", "accept-language", "content-type", "content-language"]

  • exposed_headers - see Access-Control-Expose-Headers

  • max_age_secs - sets the Access-Control-Max-Age header. Default is 300 seconds.

Content length limit

The http server is configured with a maximum content size that will be accepted for an incoming request. This is an important safety measure to prevent a caller from submitting unreasonably large requests to cause the server to run out of memory. By default, the content limit is 100MB (104857600 bytes). The value can be overridden with the setting max_content_len. The value of this setting is a json string containing a number, or a number followed immediately by a 'K', 'M', or 'G' (or lowercase 'k','m', or 'g'), representing *1024, *1048576, or *1073741824, respectively. For example, the following setting limits uploads to 20 MB.

{ "max_content_len": "20M" }

Cache Control

An optional set of cache-control values that will appear in the header if they are not already set.

Read Only Mode

If set to true, it allows only GET and HEAD methods on the provider. Default value is false.

Examples of settings files

Bind to all IP interfaces and port 3000, with TLS disabled

{ "address":  "0.0.0.0:3000" }

Example with all settings

{
  "address": "127.0.0.1:8000",
  "tls": {
    "cert_file": "/path/to/certificate.crt",
    "priv_key_file": "/path/to/private.key"
  },
  "cors": {
    "allowed_origins": [],
    "allowed_headers": [
      "accept", "accept-language", "content-language", "content-type", "x-custome-header"
    ],
    "allowed_methods": [ "GET", "POST", "PUT", "DELETE", "HEAD", "OPTIONS" ],
    "exposed_headers": [],
    "max_age_secs": 300
  },
  "max_content_len": "100M",
  "cache_control": "max-age=20",
  "readonly_mode": false,
}

Using the http server settings

The link definition connecting a component to a capability provider includes a key-value map called "values". "values" is currently defined as a map with string keys and string values, and there are a few options for specifying the httpserver settings within the values map.

  • use key config_file, with a value that is the absolute path to a json or toml file (file type detected by the .json or .toml extension).

  • use key config_b64, with a value that contains the settings base64-encoded. If you have the base64 utility, this command can generate the string value:

    cat settings.json | base64 -w0

    (The option -w0 omits line breaks within the base64)

  • use key config_json, with a value that is the raw json. Don't forget to escape quotes.