thor.yml Configuration Reference

This topic describes thor.yml file format version 1.0.

thor.yml is YAML file defining version and project keys and noc, expose, and services sections.

version

File format version. Must have value 1.0.

version: "1.0"

project

Project name. Defines docker containers name prefix. Used to distingush container names when multiple thor projects are used on same host. By default, the name of directory in which the thor.yml file locates is used as project name.

project: mynoc

NOC Section

Defines common noc configuration.

tag

Defines docker image tag. Default value is master.

noc:
    tag: "24.1"

path

NOC source code path to override container's /opt/noc. Used for development and allows to expose local changes directly in container.

noc:
    path: /home/joe/work/noc

custom

NOC custom code path. Allows to mount NOC customizations from local host.

noc:
    custom: /home/joe/work/noc-custom

installation_name

Installation name as shown in web interface. Has default value Unconfigured Installation.

noc:
    installation_name: "ACME INC"

Expose Section

Web interface entrypoint configuration.

domain_name

Domain name for web interface. By default has the value go.getnoc.com which techninally resolves to the localhost. When using default domain name the Gufo Thor is able to sign the domain certificate in fully transparent manner.

Warning

If you wish to change the domain_name you have to generate private key and sign the certificate by yourself.

expose:
    domain_name: go.getnoc.com

port

Web interface port. 32777 is used by default.

expose:
    port: 32777

open_browser

If set to true, open https://<domain_name>:<port>/ in browser on every gufo-thor up

expose:
    open_browser: true

Services Section

This section contains a list of services to start. Services can be specified as

• list of service names.

  services: [web, card]
  

• mapping of service configuration items.

  services:
    web:
      scale: 4
    card:
      scale: 2
  

tag

Docker image tag to override global tag section for given service.

services:
    web:
        tag: "stable"

scale

Number of instances of service to launch. Note, not all services are scalable, so refer to the NOC Services Reference.

services:
    web:
        scale: 4