Pingclairfile

The Pingclairfile is the configuration language. It follows Caddyfile conventions: an optional global options block, then site blocks containing directives. This page describes the language itself; the directives it accepts are described in the directive reference.

🔤 Lexical rules

Rule	Detail
Comments	`#` to the end of the line.
Quoting	A value containing spaces is quoted with `"`. Quotes are removed before the value is parsed.
Durations	Written with a unit: `30s`, `5m`, `1h`. A bare number is refused where a duration is expected.
Case	Directive and option names are lowercase.
Placeholders	`{host}`, `{path}`, `{args[0]}`, `{block}`, and the rest of the placeholder set are expanded where the directive documents them.

🌐 Addresses

A site block is named by an address. The address determines the listener and, for public names, whether automatic HTTPS applies.

example.com {              # host: ports 443 and 80, automatic HTTPS
localhost:8080 {           # host and port
:8080 {                    # any host on this port
http://example.com {       # force plaintext

The port belongs to the address rather than to a separate listen directive, so the address and the listener cannot disagree.

🧭 Matchers

A directive that accepts a matcher applies only to matching requests. Matchers are written inline or declared with @name and referenced by name.

example.com {
    @api path /api/*
    header @api Cache-Control "no-store"

    handle /assets/* {
        file_server ./assets
    }
}

handle blocks group directives per route; a handle with no matcher is the fallback for its site.

🧩 Snippets and imports

Snippets are reusable fragments. A snippet declared as (name) { ... } is pulled in with import name, and can receive a block from its caller:

(proxied) {
    https://{args[0]} {
        encode zstd gzip
        {block}
    }
}

import proxied example.com {
    reverse_proxy 127.0.0.1:3000
}

A placeholder that receives nothing splices nothing, so a snippet written with {block} still compiles when its caller supplies no block.

🧰 Command-line tooling

The command line has a reference of its own: Command line lists every subcommand with its flags and defaults. Three of them belong to writing a configuration: pingclair validate, which compiles a file and names the first problem, pingclair adapt --pretty, which prints the JSON that file compiles to, and pingclair fmt, which formats it.

🚫 What is not part of the language

The format defines more names than the server implements. A recognized name that has no implementation is refused by name at load time, with a message saying the feature is missing. The authoritative list of refused names lives in the server repository’s README, and the project status page summarizes the categories.

📖Pingclairfile