---
name: "comitup"
section: "8"
platform: "linux"
package: "comitup"
version: "1.43-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/comitup"
---

# comitup(8)

Manage wifi connections on headless, unconnected systems

## NAME

comitup - Manage wifi connections on headless, unconnected systems

### SYNOPSIS

`comitup [options]`

### DESCRIPTION

The **comitup** service provides a means to establish a connection between a computer and a wifi access point, in the case where wifi is the only means available to access the computer.

On startup, the service will attempt to connect to wifi using established networkmanager(8) connections. If this is not successful, **comitup** will establish a wifi hotspot with the name *comitup-\<nnn\>*, where \<nnn\> is a persistent number.

While the hotspot is active, a [comitup-web(8)](/comitup-web/8.md) service is available to manage connecting to an access point. A captive portal environment is established to aid in discovery of the web service.

If two wifi interfaces are available, the hotspot will remain active on the first interface, and the internet connection will be made on the second. Otherwise, the hotspot will be replaced with the internet connection.

In all states, [avahi-daemon(8)](/avahi-daemon/8.md) is used to publish the mdns host name *comitup-\<nnn\>.local*, making the web service accessible as e.g. *http://comitup-123.local*, for systems supporting Zeroconf. For other systems, a *comitup* Workstation entry is published which is visible to Zeroconf browsing applications, allowing the IP address to be manually determined. The web service address is *http://10.41.0.1*.

**comitup** logs to */var/log/comitup.log*.

### Options

- •

  *-h*, *-help* - Print help and exit

- •

  *-c*, *-check* - Check the wifi device configuration and exit

- •

  *-i*, *-info* - Print info about the current configuration, and exit

- •

  *-v*, *-verbose* - Increase logging to */var/log/comitup.log*

### D-Bus Interface

**Comitup** provides a D-Bus object which claims the name *com.github.davesteele.comitup* on the path */com/github/davesteele/comitup*, supporting the interface *com.github.davesteele.comitup*. The interface includes the following methods.

- •

  *get\_info()*

  Input: None

  Output: *DICT\_ENTRY*

  Return information about the current **Comitup** service. The keys are as follows:

  - •

    *version* - The package version.

  - •

    *apname* - The currently configured AP hotspot name.

  - •

    *hostnames* - A list of host names that are published for the service IP address.

  - •

    *imode* - The current interface mode for comitup. This returns the string \`single' or \`router'. In \`single' mode, the hotspot is terminated when **CONNECTED**. In \`router' mode, the hotspot is retained, the upstream connection is made with the other wifi device, and traffic is routed between them. The web service is terminated when **CONNECTED**.

- •

  *access\_points()*

  Input: None

  Output: Array of *DICT\_ENTRY*

  Return a list of visible access points. This is represented as an array of D-Bus *DICT\_ENTRY*. Each *DICT\_ENTRY* contains strings associated with the following keys, *ssid*, *strength* (0 to 100) and *security* (*encrypted* or *unencrypted*).

- •

  *state()*

  Input: None

  Output: *state*, *connection*

  This returns strings for the current **comitup** state (either **HOTSPOT**, **CONNECTING**, or **CONNECTED**) and the *ssid* name for the current connection on the wifi device.

- •

  *connect()*

  Input: *ssid*, *password*

  Output: None

  Delete any existing connection for *ssid*, create a new connection, and attempt to connect to it. The password may be a zero length string if not needed.

- •

  *delete\_connection()*

  Input: *ssid*

  Output: None

  Delete the connection for *ssid*. The system will not be able to reconnect using this connection.

- •

  *nuke()*

  Input: None

  Output: None

  Perform a factory reset of Comitup information on the device, which consists of removing all WiFi connections, and restarting the service. Note that *enable\_nuke* must be enabled in comitup.conf for this to succeed.

### COPYRIGHT

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

### SEE ALSO

[comitup-conf(5)](/comitup-conf/5.md), [comitup-cli(1)](/comitup-cli/1.md), [comitup-web(8)](/comitup-web/8.md), comitup-watch(1)
