Web administration configuration file syntax

Web administration configuration

Web administration configuration file is located in webconfig.yaml.

bindings

Port and IP address bindings the web server will listen to. By default the server will listen on localhost:8880 for HTTP requests.

We strongly recommend to use only HTTPS for requests coming from network (everything else but localhost).

bindings:
  # listen for HTTP requests on localhost:8880 - this is default configuration
  - hostname: localhost
    port: 8880
  # listen for HTTPS requests on 192.168.1.212:443, load SSL certificate from file
  - hostname: 192.168.1.212
    port: 443
    certificateFromFile:
      filePath: C:\cert.pfx
      password: "secretPasswordForCertificate"
  # you can also use hostname instead of IP address - the address will be resolved at runtime
  # this time load SSL certificate from Certificate store
  - hostname: wa.mydomain.com
    port: 443
    certificateFromStore:
      storeName: MyStore
      thumbprint: 92e50cdfeab5c164f32148117878fe4e7d7bc2c

bindings.hostname

string: [<IPv4 address> | <IPv6 address> | <hostname>]

IP address to listen on for HTTP or HTTPS requests. Use 0.0.0.0 to listen on any IPv4 endpoint and :: on any IPv6 endpoint. Hostnames can be used as well, the address will be resolved when the server starts.

bindings.port

number = 22

Port number to listen for HTTP or HTTPS requests on.

bindings.certificateFromFile.filePath

string

File path of .pfx (PKCS#12) certificate with private key.

bindings.certificateFromFile.password

string

Password for certificate’s private key decryption.

bindings.certificateFromStore.storeName

string

Local Computer Certificates store name, e.g. My (for Personal), Root, CA, WebHosting, etc. User certificates are currently not supported.

bindings.certificateFromStore.thumbprint

string

Certificate thumbprint. Certificate must have Server authentication capability and must contain an exportable private key.

logging

Logging configuration.

logging:
  # minimum log level for ASP.NET. See minLevel for supported values.
  aspNetMinLevel: warning

  # location of file logs. If not set logging will be disabled. Make sure the server has write rights to the folder specified.
  location: D:\burulogs
  
  # minimum log level.  Supported values are: verbose, debug, information, warning, error, fatal. Default is 'warning'.
  minLevel: warning

  # keep up to 31 files (1 month)
  maxFileCount: 31

Miscellaneous

# Disables warning shown for http (unsecured) endpoint on home page. Useful when running e.g. behind a reverse proxy. Default: false
suppressHttpEndpointWarning: false