.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "comitup-conf" "5" "February 2019" "" ""
.hy
.SH NAME
.PP
comitup.conf \- Comitup configuration file format
.SS DESCRIPTION
.PP
The \f[I]comitup.conf\f[R] file configures the wifi management service
comitup(8).
It is located in the \f[I]/etc/\f[R] directory.
.SS PARAMETERS
.IP \[bu] 2
\f[I]ap_name\f[R]: By default, comitup will create a hotspot named
\f[B]comitup-<nnn>\f[R], publish an avahi-daemon(8) host entry for
\f[B]comitup-<nnn>\f[R], and establish an mdns identity for
\f[B]comitup-<nnn>.local\f[R].
Setting this parameter will change the \f[B]comitup\f[R] string with one
of the users choosing.
If the configuration variable contains an <nnn> string, with one to 4
\[lq]n\[cq]s\[rq], it will be replaced with a persistent, random number.
Similarly, the string <hostname> is replaced with the computer\[cq]s
hostname.
.IP \[bu] 2
\f[I]ap_password\f[R]: If this parameter is defined in the configuration
file, then the comitup hotspot will require that any connection to the
hotspot be authenticated, using this password.
.IP \[bu] 2
\f[I]web_service\f[R]: This defines a user web service to be controlled
by \f[B]comitup\f[R].
This service will be disabled in the \f[B]HOTSPOT\f[R] state in
preference of the comitup web service, and will be enabled in the
\f[B]CONNECTED\f[R] state.
This should be the name of the systemd web service, such as
\f[I]apache2.service\f[R] or \f[I]nginx.service\f[R].
This defaults to a null string, meaning no service is controlled.
.IP \[bu] 2
\f[I]service_name\f[R]: This defines the mdns service name advertised by
\f[B]comitup\f[R].
This defaults to \[lq]workstation\[rq], and will be advertised as
\[dq]_workstation._tcp\[dq].
.IP \[bu] 2
\f[I]enable_appliance_mode\f[R]: By default, comitup will use multiple
wifi interfaces, if available, to connect to the local hotspot and to
the internet simultaneously.
Setting this to something other than \[lq]true\[rq] will limit comitup
to the first wifi interface.
.IP \[bu] 2
\f[I]external_callback\f[R]:
.RS 2
.PP
The path to an external script that is 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.
.RE
.IP \[bu] 2
\f[I]primary_wifi_device\f[R];
.RS 2
.PP
Override the default choice for the primary WiFi device to use.
.RE
.SS COPYRIGHT
.PP
Comitup is Copyright (C) 2016-2019 David Steele <steele\[at]debian.org>
.SS SEE ALSO
.PP
comitup(8), comitup-cli(8), comitup-web(8)