Skip to content

Latest commit

 

History

History
101 lines (78 loc) · 4.67 KB

configuration.md

File metadata and controls

101 lines (78 loc) · 4.67 KB
Raw

Environment variables

Variable Description Default
APP_ENV_FILE The location of an env file to load in, during initialisation .env
APP_HEALTH_PORT_ENABLED Enable binding of a health port true
APP_HEALTH_PORT The port to bind to for health checking :8081
APP_PORT The port to serve traffic on :8080
APP_METRICS_ENABLED Enable binding of a metrics port true
APP_PORT_METRICS The port to bind for metrics traffic :2112
APP_HTTP_REAL_IP_HEADER The HTTP header to use for real IPs ""
APP_SERVE_FOLDER / KO_DATA_PATH The local folder path to serve ./site
APP_TEMPLATE_MAP_PATH The path to a template map ./template-map.yaml
APP_VUEJS_HISTORY_MODE Enable Vuejs history mode path rewriting false
APP_HEADER_SET_ENABLE Enable header setting for requests false
APP_HEADER_MAP_PATH The path to the header map ./headers.yaml
APP_REDIRECT_ROUTES_ENABLED Enable a map of paths to urls to redirect to true
APP_REDIRECT_ROUTES_PATH The path to a YAML file containing a map of paths to urls ./redirects.yaml
APP_HTTP_ALLOWED_ORIGINS Specifies a CORS rule for allowed origin domains which can refer to this instance of go-http-server in a browser *

Templating

when APP_VUEJS_HISTORY_MODE and APP_HEADER_SET_ENABLE are both set to true, templated values may also be passed to the index.html. The template to use is passed with the setting APP_HEADER_MAP_PATH.

A document may contain Go html templates, such as

<html>
  <head>
    <meta name="base-domain" content="{{ .BaseDomain }}">
  </head>
  <body>
    <h1>{{ .SiteTitle }}</h1>
    ...
  </body>
</html>

A template config may look like the following

SiteTitle: Hello!
BaseDomain: "${BASE_DOMAIN}"

with the env for BASE_DOMAIN set to example.com, the document will render as

<html>
  <head>
    <meta name="base-domain" content="example.com">
  </head>
  <body>
    <h1>Hello!</h1>
    ...
  </body>
</html>

this functionality is also configurable through the self-service dotfile config.

Environment variables

Just like template map, environment variables can be highly dynamically set.

  Referrer-Policy:
    - strict-origin
  X-Content-Type-Options:
    - "${APP_CONTENT_TYPE_OPTIONS}"

These headers will be added to the response. Headers configured this way can also be evaluated from environment variables.

Dotfile configuration

When a file called .ghs.yaml exists in the serve folder, it will be loaded in for the web server configuration. Current values for configuration are

error404FilePath: string
headerMap:        map[string][]string
historyMode:      bool
redirectRoutes:   map[string]string
templateMap:      map[string]string

for overriding the value set by the server.

Fields

The dotfile config supports a smaller and limited subset of the go-http-server settings. This is to ensure that in a self-service environment, certain configs cannot be set. The following fields are:

error404FilePath: the path to a html document to serve the file not found message. headerMap: a key+value-array pair to set headers. Values are env-evaluated (e.g: X-Something-Important: ["Value-Here", "${SOME_ENV}"]). historyMode: when set, rewrites all requests with the exception of assets to index.html. redirectRoutes: a key+value pair to direct paths URLs to other URLs. (e.g: /a: /b, /example: https://example.com). templateMap: combined with historyMode, use Go html templating to replace Go templating expressions in an index.html.