coventry.conf(5)

📦 version 0.9.3, in alpine 3.24

💅 coventry.conf — the coventry service configuration bestie

okay so picture this: you're holding the manual page for coventry.conf(5), which lives in the File Formats Manual section, and it's literally the config file that tells the coventry service how to be its whole self. welcome, i'm your tour guide, let's go ✨

✨ NAME ✨

coventry.conf — the coventry service configuration. that's it, that's the vibe. 🎀

🦋 SYNOPSIS 🦋

The coventry.conf file is the configuration file for the coventry service. no cap. you'll typically find it hanging out at /etc/coventry.conf, and there's also an optional custom.conf that can be placed in the server prefix directory to override values and sections in it. so like, your main fit plus a little accessory that overrides the look. 💅

🌸 FILE FORMAT 🌸

Bestie. The file consists of sections which contain key value pairs. A section begins with the section name in square brackets and continues until the next section name. Hence:

[section-name]

key-name = value

The file is line-based — that is, each newline-terminated line represents either a comment, a section name, or a parameter. one line, one job, main character energy only. 👑

Section and key names are not case sensitive. so Name and nAmE are the same girl, they're just wearing different outfits.

Only the first equals sign in a parameter is significant. Whitespace before or after the first equals sign is discarded. Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value is retained verbatim — so keep it cute, it's staying exactly as written. 🫶

Any line beginning with a semicolon (;) or a hash (#) character is ignored, as are lines containing only whitespace. ghosted, effective immediately. 💀

🚨 An entire key value pair, comment, or section name must fit on one line. no wrapping, no spilling into the next line. it's giving "one story, one post".

The values following the equals sign in parameters are all either a string (no quotes needed, she's low maintenance) or a boolean, which may be given as yes/no, 0/1 or true/false. Case is not significant in boolean values, but is preserved in string values — booleans don't care, strings remember. Some items such as create modes are numeric.

💜 SECTION DESCRIPTIONS 💜

Coventry uses a 2 digit dialing plan, and each section in the configuration file, except for special sections, describes the configuration of a single sip device endpoint. this might include registration secrets, display name, and other properties. 🔥

The list of active sip endpoints, and their properties, can be re-loaded live and updated in a running coventry server with sighup. no restart, no drama, just glow-up in real time. ✨

🧚 SPECIAL SECTIONS 🧚

TODO

(yeah. that's the whole thing. we love an honestly-labeled work in progress 🫠)

Copyright © 2020 Tycho Softworks.

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. like, zero warranty, none, nada, don't come for her if it breaks. 🙈

okay that's the page!! shipped to you by Tycho Softworks, the Coventry manual, coventry.conf(5) — mwah, go configure something iconic, bestie 💖🎀🦋

📦 where this page comes from