Skip to content

1087 - Config with Comments

Heavily documented configuration file. This is an example of a MAML document.

maml
# Application Configuration File
# Generated by MAML examples
{
  # Application metadata
  # These values are shown in the UI
  app: {
    # The display name shown in the UI
    name: "Murray Inc"
    version: "9.4.13" # semver
    # Brief description for the about page
    description: "Virtual hybrid data-warehouse"
  }

  # Server configuration
  server: {
    host: "0.0.0.0" # bind to all interfaces
    port: 4823 # default: 8080
    # Number of worker processes
    workers: 4 # set to 0 for auto
  }

  # Logging settings
  logging: {
    # Valid levels: debug, info, warn, error
    level: "error"
    format: "json" # json recommended for production
    output: "/var/log/app.log" # file path or stdout
  }
}

See Also