comitup-conf(5)

💖 comitup-conf(5) — the vibe file manual 💖

okay so like. this is comitup.conf, the config file format page for the comitup wifi management service. no cap, if you're here you're probably staring at a .conf file wondering what all the little words do. don't worry bestie, we're going through every single one. 🫶

---

✨ NAME ✨

comitup.conf — the Comitup configuration file format. that's it, that's the name, slay.

---

🌸 DESCRIPTION 🌸

so the comitup.conf file is literally the whole personality of the wifi management service comitup(8). it's where you tell comitup how to behave.

and where does it live? in the /etc/ directory. iconic location, obviously. 🏠

---

🎀 PARAMETERS 🎀

here's the main character energy part. every knob you can turn, one by one:

• ap_name — by default, comitup spins up a hotspot named comitup-<nnn>, publishes an avahi-daemon(8) host entry for comitup-<nnn>, and establishes an mdns identity for comitup-<nnn>.local. setting this parameter swaps out that comitup string for whatever you want. and here's the cute part: if your config value contains an <nnn> string with between one and four “n’s”, it gets replaced with a persistent, random number. similarly, the string <hostname> gets replaced with the computer's hostname. 🦋

heads up bestie: for the Avahi Service Discovery publication to work correctly, the name should be ASCII, with no special characters or white space. keep it simple!!

• ap_password — if this one is defined in the config file, then the comitup hotspot will require that any connection to the hotspot be authenticated, using this password. 🔐
• web_service — this defines a user web service to be controlled by comitup. it gets disabled in the HOTSPOT state in preference of the comitup web service, and gets enabled in the CONNECTED state. this should be the name of the systemd web service, like apache2.service or nginx.service. it defaults to a null string, meaning no service is controlled.
• service_name — this defines the mdns service name advertised by comitup. it defaults to “comitup”, and will be advertised as “_comitup._tcp”. 💅
• enable_appliance_mode — by default, comitup will use multiple wifi interfaces, if available, to connect to the local hotspot and to the internet simultaneously. setting this to anything other than “true” will limit comitup to the first wifi interface.

this is experimental. ⚠️ you've been warned, girlypop.

• external_callback — the path to an external script that gets called on comitup state changes. it will include a single argument, either HOTSPOT, CONNECTING, or CONNECTED. the script will run as the owning user and group.
• primary_wifi_device — override the default choice for the primary WiFi device to use. 💻
• verbose — set to 1 (or yes or true) to enable more verbose logging. more words, more chaos, we love a chatty log. 😭
• enable_nuke — set to 1 (or yes or true) to enable a hardware-based factory reset function. this will cause all WiFi connection settings to be deleted. 🧨 on a Raspberry Pi, short out pins 39 and 40 on the GPIO header for three seconds to invoke. the green LED will flash three times to indicate success.

this capability is also available via comitup-cli and the D-BUS interface.

• ipv6_link_local — set to 1 to force Comitup to create only “link-local” IPv6 addresses for the upstream WiFi connection, affording a higher level of protection for that link. “link-local” addresses cannot route to the Internet. 🛡️ delete existing connections after changing the value of this parameter.

---

👑 COPYRIGHT 👑

Comitup is Copyright (C) 2016-2021 David Steele <steele@debian.org>

---

🌈 SEE ALSO 🌈

comitup(8), comitup-cli(1), comitup-web(8)

---

and that's the whole page bestie, you ate it 💖

this was the comitup-conf(5) manual page, hailing from July 2021. go configure something iconic. periodt. 💅✨