| 1 |
% comitup-conf(5) |
| 2 |
% |
| 3 |
% July 2021 |
| 4 |
|
| 5 |
# NAME |
| 6 |
|
| 7 |
comitup.conf -- Comitup configuration file format |
| 8 |
|
| 9 |
## DESCRIPTION |
| 10 |
|
| 11 |
The _comitup.conf_ file configures the wifi management service comitup(8). |
| 12 |
It is located in the _/etc/_ directory. |
| 13 |
|
| 14 |
## PARAMETERS |
| 15 |
|
| 16 |
* _ap\_name_: |
| 17 |
By default, comitup will create a hotspot named **comitup-<nnn>**, |
| 18 |
publish an avahi-daemon(8) host entry for **comitup-<nnn>**, and establish |
| 19 |
an mdns identity for **comitup-<nnn>.local**. Setting this parameter will |
| 20 |
change the **comitup** string with one of the users choosing. If the |
| 21 |
configuration variable contains an <nnn> string, with between one and four "n's", it |
| 22 |
will be replaced with a persistent, random number. Similarly, the string |
| 23 |
<hostname> is replaced with the computer's hostname. |
| 24 |
|
| 25 |
For the Avahi Service Discovery publication to work correctly, the name |
| 26 |
should be ASCII, with no special characters or white space. |
| 27 |
|
| 28 |
* _ap\_password_: |
| 29 |
If this parameter is defined in the configuration file, then the comitup hotspot will |
| 30 |
require that any connection to the hotspot be authenticated, using this password. |
| 31 |
|
| 32 |
* _web\_service_: |
| 33 |
This defines a user web service to be controlled by **comitup**. This service will be |
| 34 |
disabled in the **HOTSPOT** state in preference of the comitup web service, and will be |
| 35 |
enabled in the **CONNECTED** state. This should be the name of the systemd web service, |
| 36 |
such as _apache2.service_ or _nginx.service_. This defaults to a null string, |
| 37 |
meaning no service is controlled. |
| 38 |
|
| 39 |
* _service\_name_: |
| 40 |
This defines the mdns service name advertised by **comitup**. This defaults to "comitup", |
| 41 |
and will be advertised as "_comitup._tcp". |
| 42 |
|
| 43 |
* _enable\_appliance\_mode_: |
| 44 |
By default, comitup will use multiple wifi interfaces, if available, to connect to the |
| 45 |
local hotspot and to the internet simultaneously. Setting this to something other than |
| 46 |
"true" will limit comitup to the first wifi interface. |
| 47 |
|
| 48 |
This is experimental. |
| 49 |
|
| 50 |
* _external\_callback_: |
| 51 |
|
| 52 |
The path to an external script that is called on comitup state changes. It will include |
| 53 |
a single argument, either 'HOTSPOT', 'CONNECTING', or 'CONNECTED'. The script will run |
| 54 |
as the owning user and group. |
| 55 |
|
| 56 |
* _primary\_wifi\_device_; |
| 57 |
|
| 58 |
Override the default choice for the primary WiFi device to use. |
| 59 |
|
| 60 |
* _verbose_: |
| 61 |
|
| 62 |
Set to '1' (or 'yes' or 'true') to enable more verbose logging. |
| 63 |
|
| 64 |
* _enable\_nuke_: |
| 65 |
|
| 66 |
Set to '1' (or 'yes' or 'true') to enable a hardware-based factory reset |
| 67 |
function. This will cause all WiFi connection settings to be deleted. On a |
| 68 |
Raspberry Pi, short out pins 39 and 40 on the GPIO header for three seconds |
| 69 |
to invoke. The green LED will flash three times to indicate success. |
| 70 |
|
| 71 |
This capability is also availble via _comitup-cli_ and the D-BUS interface. |
| 72 |
|
| 73 |
* _ipv6\_link\_local_; |
| 74 |
|
| 75 |
Set to '1' to force Comitup to create only "link-local" IPv6 addresses for |
| 76 |
the upstream WiFi connection, affording a higher level of protection for |
| 77 |
that link. "link-local" addresses cannot route to the Internet. Delete |
| 78 |
existing connections after changing the value of this parameter. |
| 79 |
|
| 80 |
## COPYRIGHT |
| 81 |
|
| 82 |
Comitup is Copyright (C) 2016-2021 David Steele <[email protected]> |
| 83 |
|
| 84 |
## SEE ALSO |
| 85 |
|
| 86 |
comitup(8), comitup-cli(1), comitup-web(8) |
| 87 |
|