| 1 |
# |
| 2 |
# Comitup configuration |
| 3 |
# |
| 4 |
|
| 5 |
|
| 6 |
# ap_name |
| 7 |
# |
| 8 |
# This defines the name used for the AP hotspot, and for the ZeroConf |
| 9 |
# host name. The "<nnn>" string, if present, will be replaced with an |
| 10 |
# instance-unique, persistent number of the same length. There may be |
| 11 |
# up to four "n's" in the string. Similarly, the string "<hostname>" |
| 12 |
# is replaced with the system hostname. |
| 13 |
# |
| 14 |
# For ZeroConf Service discovery to work properly, this should resolve to an |
| 15 |
# ASCII string with no spaces or special characters. |
| 16 |
# |
| 17 |
# ap_name: comitup-<nnn> |
| 18 |
|
| 19 |
# ap_password |
| 20 |
# |
| 21 |
# If an ap_password is defined, then the AP hotspot is configured with |
| 22 |
# "infrastructure WPA-psk" authentication, requiring this password |
| 23 |
# to connect. The password must be between 8 and 63 characters. You |
| 24 |
# should reboot after changing this value. |
| 25 |
# |
| 26 |
# ap_password: supersecretpassword |
| 27 |
|
| 28 |
# web_service |
| 29 |
# |
| 30 |
# The name of a systemd service to be disabled when comitup is managing a |
| 31 |
# hotspot, and enabled when there is a normal wifi connection. |
| 32 |
# |
| 33 |
# Note that the service supplied here should be disabled in systemctl |
| 34 |
# (e.g. "systemctl disable apache2.service") so that it is managed solely |
| 35 |
# by comitup. |
| 36 |
# |
| 37 |
# web_service: httpd.service |
| 38 |
|
| 39 |
|
| 40 |
# service_name |
| 41 |
# |
| 42 |
# The mdns service name to advertise as. Will be merged with "._tcp" to create the |
| 43 |
# full string. (e.g. "_comitup._tcp") |
| 44 |
# |
| 45 |
# service_name: comitup |
| 46 |
|
| 47 |
# enable_appliance_mode |
| 48 |
# |
| 49 |
# If enabled (true), and if two wifi adapters are available, comitup will |
| 50 |
# maintain the comitup-<nnn> hotspot on the first, and make other AP |
| 51 |
# connections on the second. IP forwarding and NAT are enabled, so that |
| 52 |
# hosts on the comitup hotspot will be able to access external networks. |
| 53 |
# |
| 54 |
# enable_appliance_mode: True |
| 55 |
|
| 56 |
# external_callback |
| 57 |
# |
| 58 |
# An external script that is called on comitup state changes. It will |
| 59 |
# include a single argument, either 'HOTSPOT', 'CONNECTING', or |
| 60 |
# 'CONNECTED'. |
| 61 |
# |
| 62 |
# The script must be executable. It will be run with the permissions of the |
| 63 |
# owning user. |
| 64 |
# |
| 65 |
# external_callback: /usr/local/bin/comitup-callback |
| 66 |
|
| 67 |
# primary_wifi_device |
| 68 |
# |
| 69 |
# By default, the first wifi device returned by NetworkManager is used as |
| 70 |
# the primary wifi device. This allows you to override this choice. |
| 71 |
# The primary device is used to spawn the access point. |
| 72 |
# |
| 73 |
# primary_wifi_device: wlan0 |
| 74 |
|
| 75 |
# verbose |
| 76 |
# |
| 77 |
# Enable verbose logging in /var/log/comitup.log. |
| 78 |
# |
| 79 |
# verbose: 0 |
| 80 |
|
| 81 |
# enable_nuke |
| 82 |
# |
| 83 |
# If true, Comitup will monitor, on a Raspberry Pi, for a short between pins 39 |
| 84 |
# and 40. If the short is maintained for 3 seconds, the device will delete all |
| 85 |
# defined WiFi connections, flash the board LED 3 times, and restart Comitup. |
| 86 |
# |
| 87 |
# enable_nuke: 0 |
| 88 |
|
| 89 |
# ipv6_link_local |
| 90 |
# |
| 91 |
# Typically, IPv4 addresses assigned by ISPs involve Network Address |
| 92 |
# Translation. This offers some protection to devices, since such addresses are |
| 93 |
# not routable from the Internet by default. This is not the case for IPv6. In |
| 94 |
# this case, extra steps often need to be taken to protect the device. This |
| 95 |
# option can force Comitup to configure IPv6 on upstream WiFi connections to be |
| 96 |
# configured only with link-local IPv6 addresses, making them inaccessible from |
| 97 |
# the Internet for that protocol. |
| 98 |
# |
| 99 |
# ipv6_link_local: 1 |