Skip to main content
Version: 0.10.0-dev

Entry Point Configuration

The file snakeway.hcl is the entry point for all Snakeway configuration. It defines how Snakeway runs as a process, where it finds TLS certificates, and where it discovers the rest of its configuration files.

Structure Overview

server {
version = 1
pid_file = "..."
threads = 8
work_stealing = true
ca_file = "..."

tls_automation = {
renew_within_days = 30

acme = { ... }
cert_store = { ... }
}
}

include {
devices = "device.d/*.hcl"
ingresses = "ingress.d/*.hcl"
}

Blocks

server

Process-level settings: worker threads, PID file, TLS automation, and upstream CA configuration.

See Server Block.

server.tls_automation

Automatic certificate issuance and renewal via the ACME protocol.

See TLS Automation.

include

Glob patterns that tell Snakeway where to find device and ingress configuration files, relative to CONFIG_ROOT.

FieldTypeDefaultDescription
devicesstringrequiredGlob pattern for device configuration files.
ingressesstringrequiredGlob pattern for ingress configuration files.