.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "COMITUP" "8" "January 2017" "" ""
.
.SH "NAME"
\fBcomitup\fR \- Manage wifi connections on headless, unconnected systems
.
.SH "SYNOPSIS"
\fBcomitup\fR
.
.SH "DESCRIPTION"
The \fBcomitup\fR 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\.
.
.P
On startup, the service will attempt to connect to wifi using established networkmanager(8) connections\. If this is not successful, \fBcomitup\fR will establish a wifi hotspot with the name \fIcomitup\-<nnnn>\fR, where <nnnn> is a persistent 4\-digit number\.
.
.P
While the hotspot is active, a comitup\-web(8) service is available to manage connecting to an access point\.
.
.P
In all states, avahi\-daemon(8) is used to publish the mdns host name \fIcomitup\-<nnnn>\.local\fR, making the web service accessible as e\.g\. \fIhttp://comitup\-1234\.local\fR, for systems supporting Zeroconf\. For other systems, a \fIcomitup\fR Workstation entry is published which is visible to Zeroconf browsing applications, allowing the IP address to be manually determined\. The web service address is likely \fIhttp://10\.42\.0\.1\fR\.
.
.P
\fBcomitup\fR logs to \fI/var/log/comitup\.log\fR\.
.
.SS "D\-Bus Interface"
\fBComitup\fR provides a D\-Bus object which claims the name \fIcom\.github\.davesteele\.comitup\fR on the path \fI/com/github/davesteele/comitup\fR, supporting the interface \fIcom\.github\.davesteele\.comitup\fR\. The interface includes the following methods\.
.
.IP "\(bu" 4
\fIget_info()\fR
.
.IP
Input: None
.
.IP
Output: \fIDICT_ENTRY\fR
.
.IP
Return information about the current \fBComitup\fR service\. The keys are as follows:
.
.IP "" 4
.
.nf

* _version_ \- The package version\.

* _basename_ \- The currently configured basename (default **comitup**)\.


* _id_ \- The unique random numeric id associated with the service instance\.

* _hostnames_ \- A list of host names that are published for the service
  IP address\.
.
.fi
.
.IP "" 0

.
.IP "\(bu" 4
\fIaccess_points()\fR
.
.IP
Input: None
.
.IP
Output: Array of \fIDICT_ENTRY\fR
.
.IP
Return a list of visible access points\. This is represented as an array of D\-Bus \fIDICT_ENTRY\fR\. Each \fIDICT_ENTRY\fR contains strings associated with the following keys, \fIssid\fR, \fIstrength\fR (0 to 100) and \fIsecurity\fR (\fIencrypted\fR or \fIunencrypted\fR)\.
.
.IP "\(bu" 4
\fIstate()\fR
.
.IP
Input: None
.
.IP
Output: \fIstate\fR, \fIconnection\fR
.
.IP
This returns strings for the current \fBcomitup\fR state (either \fBHOTSPOT\fR, \fBCONNECTING\fR, or \fBCONNECTED\fR) and the \fIssid\fR name for the current connection on the wifi device\.
.
.IP "\(bu" 4
\fIconnect()\fR
.
.IP
Input: \fIssid\fR, \fIpassword\fR
.
.IP
Output: None
.
.IP
Delete any existing connection for \fIssid\fR, create a new connection, and attempt to connect to it\. The password may be a zero length string if not needed\.
.
.IP "\(bu" 4
\fIdelete_connection()\fR
.
.IP
Input: \fIssid\fR
.
.IP
Output: None
.
.IP
Delete the connection for \fIssid\fR\. The system will not be able to reconnect using this connection\.
.
.IP "" 0
.
.SH "COPYRIGHT"
Comitup is Copyright (C) 2016\-2017 David Steele <steele@debian\.org>\.
.
.SH "SEE ALSO"
comitup\-conf(5), comitup\-cli(1), comitup\-web(8)