3. Configuration

The configuration consists of files in YAML format on disk. The package comes with multiple example configurations in /opt/halon/share/examples.

The YAML configuration files can be edited directly, and validated against the JSON schemas using the halonconfig script. The schemas can be browsed using a tool like Bovet’s docson. They are also included in our Visual Studio Code integration, which provides validation, autocomplete and hover support when editing them.

The YAML configuration allows for byte format and time format syntax in a lot of places. For example time such as servers[].timeout.idle may be specified in the format of ?d?h?m?s. Size fields such as servers[].phases.data.maxsize may be specified in the format of ?(TiB|GiB|MiB|KiB|B).

The running configuration contains the bulk of the configuration data, including all the Halon script. It can be softly reloaded and deployed in a blue-green fashion using per-connection conditions, using the control sockets, API, command line interface or web administration. The default startup configuration loads the running configuration from /etc/halon/smtpd-app.yaml as per the environment.appconf directive.

• 3.1. Startup configuration
  • 3.1.1. Server directives
  • 3.1.2. Monitor directives
  • 3.1.3. Queue directives
  • 3.1.4. Threads directives
    • 3.1.4.1. Scripts
    • 3.1.4.2. Events
  • 3.1.5. Other directives
  • 3.1.6. Clustering directives
  • 3.1.7. Environment directives
    • 3.1.7.1. Performance and log
    • 3.1.7.2. Configuration paths
    • 3.1.7.3. Other environment
• 3.2. Running configuration
  • 3.2.1. Script directives
  • 3.2.2. Server directives
  • 3.2.3. Transport directives
  • 3.2.4. Monitor directives
  • 3.2.5. Queue directives
  • 3.2.6. General directives
  • 3.2.7. List directives
  • 3.2.8. Resolver directives
  • 3.2.9. Other directives
  • 3.2.10. Example
• 3.3. Suspend configuration
  • 3.3.1. Suspend directives
• 3.4. Policy configuration
  • 3.4.1. Policy directives
  • 3.4.2. Rate directives
• 3.5. Delivery configuration
  • 3.5.1. Delivery directives
• 3.6. Performance tuning
  • 3.6.1. Thread tuning
    • 3.6.1.1. servers[].threads.event
    • 3.6.1.2. threads.scripts[].count
    • 3.6.1.3. queues.threads.pickup
    • 3.6.1.4. resolver.threads.event
  • 3.6.2. Startup configuration
    • 3.6.2.1. environment.syslog.mask
    • 3.6.2.2. spool.fsync
    • 3.6.2.3. spool.loader.threads.wait
    • 3.6.2.4. environment.uuid.version
  • 3.6.3. Running configuration
    • 3.6.3.1. servers[].logging
    • 3.6.3.2. servers[].phases.connect.remoteptr
    • 3.6.3.3. servers[].phases.data.multipart
    • 3.6.3.4. servers[].phases.data.fixheaders
  • 3.6.4. Resolver subsystem
    • 3.6.4.1. resolver.concurrency
  • 3.6.5. Queueing subsystem
    • 3.6.5.1. pooling
  • 3.6.6. Memory tuning