1
0
Fork 0
mirror of https://github.com/iiab/iiab.git synced 2025-02-13 03:32:12 +00:00
iiab/vars/default_vars.yml

734 lines
26 KiB
YAML
Raw Normal View History

2019-01-30 23:05:41 +00:00
# DO NOT MODIFY THIS FILE! CHANGES WILL BE LOST WHEN "git pull" IS RUN!
# PUT YOUR CUSTOMIZATIONS HERE: /etc/iiab/local_vars.yml
# READ "What is local_vars.yml and how do I customize it?" IN http://FAQ.IIAB.IO
2017-05-27 18:09:50 +00:00
# Internet-in-a-Box (IIAB) uses True/False to indicate boolean values.
2017-05-27 18:09:50 +00:00
2020-01-16 16:05:05 +00:00
# IIAB does NOT currently support uninstalling apps! So: if any IIAB app is
# installed with 'APP_XYZ_install: True' below, do NOT later change that.
2020-09-08 02:11:34 +00:00
# WARNING: IF YOU CONNECT YOUR IIAB'S INTERNAL WIFI TO THE INTERNET OVER 5 GHz,
# YOU'LL PREVENT OLDER LAPTOPS/PHONES/TABLETS (WHICH REQUIRE 2.4 GHz) FROM
# CONNECTING TO YOUR IIAB'S INTERNAL HOTSPOT. See "wifi_up_down: True" below.
2020-01-16 16:05:05 +00:00
# IIAB (PRE-)release version number, for {{ iiab_env_file }}
iiab_base_ver: 7.2
2019-05-24 18:04:14 +00:00
iiab_revision: 0
2019-11-19 13:50:09 +00:00
iiab_etc_path: /etc/iiab
2019-11-19 13:18:48 +00:00
2019-05-24 18:04:14 +00:00
# Main configuration file
iiab_local_vars_file: "{{ iiab_etc_path }}/local_vars.yml"
2019-05-24 18:04:14 +00:00
# Installation status files
iiab_env_file: "{{ iiab_etc_path }}/iiab.env"
iiab_ini_file: "{{ iiab_etc_path }}/iiab.ini"
2019-11-28 11:49:19 +00:00
iiab_state_file: "{{ iiab_etc_path }}/iiab_state.yml"
2017-05-27 18:09:50 +00:00
iiab_base: /opt/iiab
iiab_dir: "{{ iiab_base }}/iiab"
pip_packages_dir: "{{ iiab_base }}/pip-packages"
yum_packages_dir: "{{ iiab_base }}/yum-packages"
downloads_dir: "{{ iiab_base }}/downloads"
iiab_download_url: http://download.iiab.io/packages
2017-05-27 18:09:50 +00:00
2018-10-15 07:17:49 +00:00
content_base: "/library"
doc_base: "{{ content_base }}/www"
doc_root: "{{ doc_base }}/html"
2017-05-27 18:09:50 +00:00
2019-11-19 13:34:38 +00:00
# Python 3 dist path
2019-11-19 13:56:47 +00:00
py3_dist_path: /usr/lib/python3/dist-packages
2019-11-19 13:34:38 +00:00
2018-10-15 07:17:49 +00:00
# Ansible's default timeout for "get_url:" downloads (10 seconds) often fails
download_timeout: 200
2017-05-27 18:09:50 +00:00
2018-10-15 07:17:49 +00:00
# Languages (for Apache)
default_language: en
language_priority: en es fr
2017-05-27 18:09:50 +00:00
# Real-time clock: set RTC chip family here. Future auto-detection plausible?
# rtc_id: ds3231
2018-10-15 07:05:34 +00:00
# Set iiab_admin_user_install: False if you don't want iiab_admin_user & wheel
# group auto-created in roles/iiab-admin/tasks/main.yml (hence disabling sudo-
# checks/warnings of published passwds like pi/raspberry & iiab-admin/g0adm1n).
iiab_admin_user_install: True
# If iiab_admin_user_install: False, set iiab_admin_user (below) to an existing
# Linux user that has sudo access, for login to Admin Console http://box/admin
iiab_admin_user: iiab-admin
2018-10-15 07:53:00 +00:00
iiab_admin_published_pwd: g0adm1n # For live checks/alerts of published pwds
2018-10-15 07:29:26 +00:00
# Password hash to override above, if Ansible creates above user:
2018-10-15 07:23:02 +00:00
iiab_admin_pwd_hash: $6$xsce51$D.IrrEeLBYIuJkGDmi27pZUGOwPFp98qpl3hxMwWV4hXigFGmdSvy3s/j7tn6OnyTTLmlV7SsN0lCUAFzxSop.
2018-10-15 07:05:34 +00:00
# Obtain a password hash - NEW MORE SECURE WAY:
# python3 -c 'import crypt; print(crypt.crypt("<plaintext>", crypt.mksalt(crypt.METHOD_SHA512)))'
# Obtain a password hash - OLD WAY:
2017-12-30 11:31:02 +00:00
# python -c 'import crypt; print crypt.crypt("<plaintext>", "$6$<salt>")'
2017-12-30 11:00:20 +00:00
2017-05-27 18:09:50 +00:00
# Time Zone (php needs timezone to be set)
2017-07-05 06:58:41 +00:00
local_tz: "{{ ansible_date_time.tz }}"
2017-05-27 18:09:50 +00:00
2020-10-03 20:24:03 +00:00
# IIAB Admin Console is sometimes not needed, e.g. on Raspberry Pi Zero W
admin_console_install: True
admin_console_enabled: True
#
# Set to "False" if you want to revert to the older Dynamic Menuing system
# (prior to IIAB 6.7, this had used https://github.com/iiab/iiab-menu)
js_menu_install: True
# IIAB Networking README: https://github.com/iiab/iiab/tree/master/roles/network
# IIAB Networking Doc: https://github.com/iiab/iiab/wiki/IIAB-Networking
# Read it offline too: http://box/info > "IIAB Networking"
2018-10-15 07:17:49 +00:00
# NETWORK PARAMETERS FOLLOW ACROSS THE NEXT 100 LINES, as enabled by Ansible's
# NETWORK role (/opt/iiab/iiab/roles/network). SEE ALSO:
# https://github.com/iiab/iiab/blob/master/roles/network/defaults/main.yml
2017-05-27 18:09:50 +00:00
# The following variable may be useful in debugging:
disregard_network: False # Use cache, or error out if cache does not exist.
2018-10-15 07:17:49 +00:00
iiab_hostname: box
iiab_domain: lan
2017-05-27 18:09:50 +00:00
lan_ip: 172.18.96.1
lan_netmask: 255.255.224.0
# Homepage: set to /home or /wordpress or /wiki (for MediaWiki)
2019-01-09 22:31:21 +00:00
iiab_home_url: /home
# You might also want to set captiveportal_splash_page (below!)
2019-01-09 22:31:21 +00:00
# Internal Wi-Fi Access Point
2020-08-08 17:59:01 +00:00
# Values are used if there is an internal Wi-Fi adapter and hostapd is enabled.
#
2020-09-08 12:25:39 +00:00
# WARNING: IF YOU CONNECT YOUR IIAB'S INTERNAL WIFI TO THE INTERNET OVER 5 GHz,
# YOU'LL PREVENT OLDER LAPTOPS/PHONES/TABLETS (WHICH REQUIRE 2.4 GHz) FROM
# CONNECTING TO YOUR IIAB'S INTERNAL HOTSPOT. See "wifi_up_down: True" below.
#
2020-08-08 23:33:32 +00:00
# Raspberry Pi OS requires WiFi country -- SET THIS IN /etc/iiab/local_vars.yml
host_country_code: US
2017-05-27 18:09:50 +00:00
host_ssid: "Internet in a Box"
host_wifi_mode: g
host_channel: 6
hostapd_secure: False
2017-09-05 13:50:16 +00:00
hostapd_password: changeme
2020-05-09 19:03:25 +00:00
hostapd_install: True # 2020-01-21: this var MIGHT be implemented in future.
hostapd_enabled: True
2020-08-05 19:47:49 +00:00
wifi_hotspot_capacity_rpi_fix: True # Restores the ability of RPi internal
# WiFi hotspots to service 30-to-32 client devices. Background explanation:
# https://github.com/iiab/iiab/issues/823#issuecomment-662285202 and PR #2472.
wifi_up_down: True # Creates a 2nd virtual WiFi adapter for upstream WiFi
2020-05-09 19:03:25 +00:00
# (e.g. to Internet) in addition to downstream WiFi (e.g. classroom hotspot).
# You can set iiab_gateway_enabled below, to enable "passthrough" to Internet.
2017-05-27 18:09:50 +00:00
2017-10-27 11:15:49 +00:00
# Gateway mode
iiab_lan_enabled: True
iiab_wan_enabled: True
# Ties in what the user populated in the GUI for static WAN IP address info:
2017-10-27 11:15:49 +00:00
gui_wan: True
adm_cons_force_ssl: False
adm_cons_allow_downloads: False
# Enable "campus access" to ~10 common IIAB services like Kiwix (3000), KA Lite
# (8008) and Calibre (8010 or 8080) etc, on the WAN side of your IIAB server.
# Only 1 of the 6 lines below should be uncommented:
#
#ports_externally_visible: 0 # none
#ports_externally_visible: 1 # ssh only
#ports_externally_visible: 2 # ssh + http-or-https (for Admin Console's box.lan/admin too)
ports_externally_visible: 3 # ssh + http-or-https + common IIAB services
#ports_externally_visible: 4 # ssh + http-or-https + common IIAB services + Samba
#ports_externally_visible: 5 # all but databases
#
# Or further customize your iptables firewall by editing:
# /opt/iiab/iiab/roles/network/templates/gateway/iiab-gen-iptables
# And then run: cd /opt/iiab/iiab; ./iiab-network
2019-01-03 20:07:00 +00:00
2020-05-09 19:03:25 +00:00
# Set True if client machines should have "passthrough" access to WAN/Internet:
2019-01-03 20:07:00 +00:00
iiab_gateway_enabled: False
2017-10-27 11:15:49 +00:00
gw_squid_whitelist: False
gw_block_https: False
2019-01-03 17:53:11 +00:00
dhcpd_install: False
2017-05-27 18:09:50 +00:00
dhcpd_enabled: False
2019-01-03 19:11:41 +00:00
# named (BIND)
2019-01-03 17:53:11 +00:00
named_install: False
2018-10-07 13:11:01 +00:00
named_enabled: False
2017-05-27 18:09:50 +00:00
block_DNS: False
2019-01-03 18:08:57 +00:00
# dnsmasq - handles DHCP and DNS
2018-07-04 17:56:48 +00:00
dnsmasq_install: True
2018-10-03 16:47:22 +00:00
dnsmasq_enabled: True
2018-07-19 15:23:12 +00:00
# Enable in local_vars.yml AFTER installing IIAB! Then run "cd /opt/iiab/iiab; ./iiab-network"
2018-07-13 17:33:02 +00:00
dns_jail_enabled: False
2018-10-03 18:31:06 +00:00
# Python-based Captive Portal, that @m-anish & @jvonau experimented with in
# July 2018 (https://github.com/iiab/iiab/pull/870) and that @georgejhunt
2020-01-05 01:11:04 +00:00
# extensively later refined (PRs #1179, #1300, #1327, #2070).
captiveportal_install: True
captiveportal_enabled: False
2019-12-04 23:30:26 +00:00
captiveportal_port: 9090
2019-12-22 04:11:42 +00:00
captiveportal_splash_page: /
# You might also want to set iiab_home_url (above!)
2018-12-12 16:38:03 +00:00
# In a pinch, disable Captive Portal using instructions in http://FAQ.IIAB.IO
2018-10-03 18:31:06 +00:00
2019-09-25 18:53:42 +00:00
# Bluetooth PAN access to IIAB server
bluetooth_install: True
bluetooth_enabled: False
bluetooth_term_enabled: False
2020-01-21 16:54:33 +00:00
# UNMAINTAINED as of October 2017: https://github.com/iiab/iiab/pull/382
wondershaper_install: False
2017-05-27 18:09:50 +00:00
wondershaper_enabled: False
# Intended for developers: ONLY CHANGE THESE IF YOU KNOW WHAT YOU ARE DOING
# The following 2 override the detection when not "auto"
user_wan_iface: auto
user_lan_iface: auto
2019-09-02 20:14:01 +00:00
2019-09-03 22:10:07 +00:00
# See "How do I set a static IP address?" for Ethernet, in http://FAQ.IIAB.IO
2020-05-09 22:52:50 +00:00
# Ethernet - IF NECESSARY, CUSTOMIZE THESE 4+1 VARS IN /etc/iiab/local_vars.yml
2019-09-02 23:57:34 +00:00
wan_ip: dhcp # wan_ip: 192.168.1.99
wan_netmask: # wan_netmask: 255.255.255.0
wan_gateway: # wan_gateway: 192.168.1.254
2020-05-09 23:57:18 +00:00
# If nec wan_nameserver can override ISP-provided DNS servers via dnsmasq:
# /etc/resolv.conf dictates which backend is used for the machine itself, so
2020-08-08 23:33:32 +00:00
# 127.0.0.1 means you get dnsmasq (so it works right away on RaspiOS) while
2020-05-09 23:57:18 +00:00
# 127.0.0.53 gives you systemd-networkd (so Ubuntu itself does NOT use this
# dnsmasq-specified upstream DNS [e.g. wan_nameserver] but its LAN clients do!)
2020-05-09 22:06:22 +00:00
wan_nameserver: # wan_nameserver: 192.168.1.254 or 8.8.8.8 or 1.1.1.1
2019-09-03 18:51:00 +00:00
wan_try_dhcp_before_static_ip: True # Facilitate field updates w/ cablemodems
2020-05-09 22:52:50 +00:00
# Details @ roles/network/templates/network/dhcpcd.conf.j2 for /etc/dhcpcd.conf
2017-05-27 18:09:50 +00:00
2018-08-30 21:15:43 +00:00
# 1-PREP
2017-10-27 09:45:34 +00:00
# SSHD runs here & also below in 4-SERVER-OPTIONS
sshd_install: True # Required by OpenVPN
sshd_enabled: True
sshd_port: 22 # Not fully functional. SEE: roles/sshd/tasks/install.yml
# IIAB-ADMIN runs here - see its vars near top of this file:
# e.g. iiab_admin_user_install, iiab_admin_user, iiab_admin_pwd_hash
2018-10-15 13:23:18 +00:00
openvpn_install: True
openvpn_enabled: False
# For /etc/iiab/openvpn_handle
2019-05-15 14:36:58 +00:00
openvpn_handle:
2018-10-15 13:23:18 +00:00
# cron seems necessary on CentOS:
openvpn_cron_enabled: False
# General OpenVPN settings
openvpn_server: xscenet.net
openvpn_server_real_ip: 3.89.148.185
2018-10-15 13:23:18 +00:00
openvpn_server_virtual_ip: 10.8.0.1
openvpn_server_port: 1194
2019-08-13 20:11:30 +00:00
# Some prefer 512MB for Zero W, others prefer 2048MB or higher for RPi 3 and 4.
# Please see recommendations at: https://itsfoss.com/swap-size/
2019-08-13 20:17:25 +00:00
pi_swap_file_size: 1024
2019-08-13 20:11:30 +00:00
2018-10-15 14:25:56 +00:00
# 2-COMMON
2018-10-15 14:25:56 +00:00
# /usr/libexec/iiab-startup.sh is much like autoexec.bat & /etc/rc.local
# It's put in place by 2-common/tasks/iiab-startup.yml at the end of Stage 2.
# 3-BASE-SERVER
2020-01-13 15:26:23 +00:00
# 2020-09-24: MySQL / MariaDB is MANDATORY but still evolving - please see:
# https://github.com/iiab/iiab/blob/master/roles/mysql/tasks/install.yml
# https://github.com/iiab/iiab/blob/master/roles/3-base-server/tasks/main.yml
# THESE 2 LEGACY VARS ARE PRESERVED BUT HAVE NO EFFECT:
2020-02-16 03:49:27 +00:00
mysql_install: True
mysql_enabled: True
# 2020-09-24: NGINX is MANDATORY but still evolving - please see:
# https://github.com/iiab/iiab/blob/master/roles/nginx/README.md
# https://github.com/iiab/iiab/blob/master/roles/3-base-server/tasks/main.yml
# THESE 2 LEGACY VARS ARE PRESERVED BUT HAVE NO EFFECT:
nginx_install: True
nginx_enabled: True
2020-01-13 15:55:35 +00:00
nginx_port: 80
nginx_interface: 0.0.0.0
nginx_conf_dir: /etc/nginx/conf.d
2020-01-13 15:55:35 +00:00
nginx_log_dir: /var/log/nginx
2020-02-16 03:49:27 +00:00
#
# For schools that use WordPress/Nextcloud/Moodle/PBX intensively:
2020-02-16 03:49:27 +00:00
nginx_high_php_limits: False
# WARNING: Enabling this might cause excess use of RAM/disk or other resources!
# SO AFTER INSTALLING IIAB, VERIFY THAT THESE 5 SETTINGS...
2020-05-29 09:31:24 +00:00
# https://github.com/iiab/iiab/blob/master/roles/www_options/tasks/main.yml#L52-L66
2020-02-16 03:49:27 +00:00
# ...ARE SUITABLE FOR YOUR HARDWARE, for: /etc/php/<VERSION>/fpm/php.ini
# Make this False to disable http://box/common/services/power_off.php button:
apache_allow_sudo: True
# See also Apache vars {default_language, language_priority} @ top of this file
#
# 2020-09-24: BOTH VALUES BELOW ARE IGNORED as Apache is installed on demand as
# a dependency -- by CUPS, Elgg, Lokole, Moodle, Node-RED, PBX &/or phpMyAdmin
2020-09-24 13:06:33 +00:00
apache_install: False
2020-01-13 15:26:23 +00:00
apache_enabled: False
2020-01-13 15:55:35 +00:00
#
# NGINX proxies to Apache for legacy IIAB services, using:
apache_port: 8090
apache_interface: 127.0.0.1 # 2020-01-13: Var unused
2018-08-30 21:15:43 +00:00
2017-05-27 18:09:50 +00:00
# 4-SERVER-OPTIONS
2017-10-11 03:46:33 +00:00
# SSHD runs here & also above in 1-PREP
2018-10-16 11:44:12 +00:00
# DNS prep (dnsmasq, named &/or dhcpd) run here. The full network stage runs
# after 9-LOCAL-ADDONS (or manually run "cd /opt/iiab/iiab; ./iiab-network")
2018-10-15 14:25:56 +00:00
squid_install: False
squid_enabled: False
2019-10-05 01:45:48 +00:00
# DansGuardian REQUIRES Squid (above) be installed & enabled.
# DansGuardian is NO LONGER AVAILABLE in Debian Buster i.e. since June 2019.
2018-10-15 14:25:56 +00:00
dansguardian_install: False
dansguardian_enabled: False
2017-05-27 18:09:50 +00:00
# Common UNIX Printing System (CUPS)
2019-01-03 18:08:57 +00:00
cups_install: False
cups_enabled: False
0.3 patch1 (#1377) * expand zim_versions_idx to include menuItem name, mediaCount, articleCount, size * create a stub menuItem if none exists * remember to change consumer of zim_version_idx in iiab-admin * comment out some debugging prints * do not change the name of a variable in iiab.ini * consistent variable names for *_enabled * start work on menus for enabled iiab roles * changes to display cups in home menu * remove reference to admin console which may not be installed * print error message * dict.get errors * handle undefined menuItem" * handle undefined menuItem again * some work on logos * break out the zim_versions_idx routines for use by update_menus in admin-console * remove old menuDef creation code * new variable names for zim_versions_idx * missing the tags data in zim_versions_idx * un-break-apart iiab-make-kiwix-lib.py * return an empty string * make size human_readable * getting console and iiab to work together on menus * add the new zim_date field to zim_versions_idx * get the latest into repo * found lost code iiab-make-kiwix-lib.py * Create Lokole admin user during setup * Add requested content to lokole readme Per iiab/iiab#1293 * Update default password * Add Lokole-IIAB user manual * Update default_vars.yml * Update local_vars_min.yml * Update local_vars_min.yml * Update local_vars_medium.yml * Update local_vars_min.yml * Update default_vars.yml * Update local_vars_big.yml * Update local_vars_medium.yml * Update default_vars.yml * Update default_vars.yml * Update local_vars_min.yml * Update local_vars_medium.yml * Update local_vars_big.yml * Update default_vars.yml * Update default_vars.yml * Update local_vars_big.yml * Update local_vars_medium.yml * Update local_vars_min.yml * Update default_vars.yml * Update local_vars_big.yml * Update local_vars_medium.yml * Update local_vars_min.yml * Change admin username to uppercase * Revert "Lokole: change admin to Admin per IIAB app norms" * Update main.yml * Update README.rst * Update capture-wsgi.py * Update main.yml * Update main.yml * Update default_vars.yml * Update local_vars_big.yml * Update local_vars_medium.yml * Update local_vars_min.yml * Update main.yml * Update main.yml * Update main.yml * Update main.yml * Update default_vars.yml * Update local_vars_big.yml * Update local_vars_medium.yml * Update local_vars_min.yml * Address TODOs in Lokole documentation See https://github.com/ascoderu/opwen-webapp/issues/81 * Update main.yml * Update local_vars_big.yml * Update local_vars_medium.yml * Update local_vars_big.yml * Update local_vars_min.yml * Update default_vars.yml * expand zim_versions_idx to include menuItem name, mediaCount, articleCount, size * create a stub menuItem if none exists * remember to change consumer of zim_version_idx in iiab-admin * comment out some debugging prints * do not change the name of a variable in iiab.ini * consistent variable names for *_enabled * start work on menus for enabled iiab roles * changes to display cups in home menu * remove reference to admin console which may not be installed * print error message * dict.get errors * handle undefined menuItem" * handle undefined menuItem again * some work on logos * break out the zim_versions_idx routines for use by update_menus in admin-console * remove old menuDef creation code * new variable names for zim_versions_idx * missing the tags data in zim_versions_idx * un-break-apart iiab-make-kiwix-lib.py * return an empty string * make size human_readable * getting console and iiab to work together on menus * add the new zim_date field to zim_versions_idx * get the latest into repo * found lost code iiab-make-kiwix-lib.py
2019-01-10 22:26:47 +00:00
cups_port: 631
2019-03-05 19:05:01 +00:00
# Samba. Do a security audit seriously before deploying this.
samba_install: False
samba_enabled: False
2019-05-15 14:36:58 +00:00
samba_udp_ports: "137:138"
samba_tcp_mports: "139,445"
2019-03-05 19:07:36 +00:00
shared_dir : "{{ content_base }}/public" # /library/public
2020-02-13 20:00:54 +00:00
# USB_LIB
2017-05-27 18:09:50 +00:00
usb_lib_install: True
usb_lib_enabled: True
2018-10-16 11:44:12 +00:00
# Show entire contents of USB sticks/drives (at http://box/usb)
iiab_usb_lib_show_all: True
2017-05-27 18:09:50 +00:00
# Toggle iiab-refresh-wiki-docs scraping for offline docs (http://box/info)
nodocs: False
2017-05-27 18:09:50 +00:00
2018-08-30 21:15:43 +00:00
2017-10-11 03:46:33 +00:00
# 5-XO-SERVICES
# Lesser-supported XO services need additional testing. Please contact
2017-10-11 03:46:33 +00:00
# http://lists.laptop.org/pipermail/server-devel/ if you're able to help test.
# UNMAINTAINED since about 2012-2017
xo_services_install: False # 2020-01-23: UNUSED
xo_services_enabled: False # 2020-01-23: Used in idmgr/tasks/main.yml & iiab-admin-console/roles/console/files/htmlf/20-configure.html
2017-10-11 03:46:33 +00:00
# UNMAINTAINED since about 2012-2017
activity_server_install: False # 2020-01-23: Used in 5-xo-services/tasks/main.yml (originally defined in activity-server/defaults/main.yml)
activity_server_enabled: False # 2020-01-23: Used in activity-server/tasks/main.yml (originally defined in activity-server/defaults/main.yml)
2017-10-11 03:46:33 +00:00
# UNMAINTAINED since about 2012-2017: consider 'ejabberd' in Stage 6-GENERIC-APPS below?
ejabberd_xs_install: False # 2020-01-23: Used in 5-xo-services/tasks/main.yml & roles/ejabberd_xs/tasks/main.yml
ejabberd_xs_enabled: False # 2020-01-23: Used in roles/ejabberd_xs/tasks/main.yml
2017-10-11 03:46:33 +00:00
# UNMAINTAINED since about 2012-2017: change calibre_port from 8080 to 8010 below, if you use idmgr
idmgr_install: False # 2020-01-23: Used in 5-xo-services/tasks/main.yml
idmgr_enabled: False # 2020-01-23: UNUSED
2017-10-11 03:46:33 +00:00
2017-05-27 18:09:50 +00:00
2018-08-30 21:15:43 +00:00
# 6-GENERIC-APPS
2018-08-27 20:16:42 +00:00
# UNMAINTAINED as of September 2020
azuracast_install: False
azuracast_enabled: False # This var is currently IGNORED
2019-06-19 06:42:54 +00:00
azuracast_http_port: 10080
azuracast_https_port: 10443
#
2020-02-16 04:40:03 +00:00
# AzuraCast needs many ports in the 8000:8100 range by default, but IIAB
# services conflict with those ports so this variable below sets a sane prefix.
2019-11-19 13:18:48 +00:00
# e.g. setting the below variable to 10 will result in port ranges 10000-10100
2019-06-23 10:26:52 +00:00
# being reserved for AzuraCast:
2019-06-19 06:42:54 +00:00
azuracast_port_range_prefix: 10
2020-01-21 16:54:33 +00:00
# UNMAINTAINED as of January 2020: https://github.com/iiab/iiab/issues/2056
dokuwiki_install: False
dokuwiki_enabled: False
2019-12-29 22:49:42 +00:00
dokuwiki_url: /dokuwiki
2017-10-11 03:46:33 +00:00
2020-01-21 16:54:33 +00:00
# UNMAINTAINED as of November 2019
ejabberd_install: False
ejabberd_enabled: False
2019-01-03 18:08:57 +00:00
elgg_install: False
2017-05-27 18:09:50 +00:00
elgg_enabled: False
# elgg_mysql_password: $6$iiab51$jeTwnATcbaa92xo0QBTgjLBU.5aVDDrbKeNyyC99R/TAWz6pvfzj.L7lfnOVVjD78nxqT.gkNn6XZmuRV0W3o1
2017-05-27 18:09:50 +00:00
elgg_mysql_password: elgg4kids
2019-03-08 06:44:07 +00:00
# Gitea (lightweight self-hosted "GitHub") from https://gitea.io
2019-03-02 08:16:12 +00:00
gitea_install: False
gitea_enabled: False
2019-11-28 11:08:43 +00:00
gitea_url: /gitea
gitea_port: 61734
2017-05-27 18:09:50 +00:00
2019-01-03 19:41:40 +00:00
# Lokole (email for rural communities) from https://ascoderu.ca
2019-01-03 18:08:57 +00:00
lokole_install: False
2018-11-04 05:26:15 +00:00
lokole_enabled: False
2017-05-27 18:09:50 +00:00
2020-01-21 17:02:52 +00:00
mediawiki_install: False
mediawiki_enabled: False
2019-01-15 21:20:30 +00:00
# MQTT pub-sub broker for IoT on Raspberry Pi etc
mosquitto_install: False
mosquitto_enabled: False
mosquitto_port: 1883
# 2020-09-24: BOTH VALUES BELOW ARE IGNORED as Node.js is installed on demand
# as a dependency -- by Node-RED, Sugarizer &/or Internet Archive
2020-09-22 02:21:41 +00:00
nodejs_install: False
nodejs_enabled: False
2019-01-29 15:47:25 +00:00
# Node.js version used by roles/nodejs/tasks/main.yml for 3 roles:
# nodered (Node-RED), pbx (Asterix, FreePBX) & sugarizer (Sugarizer)
2019-12-21 16:31:06 +00:00
nodejs_version: 12.x # was 8.x until 2019-02-02, was 10.x until 2019-12-21
2019-01-29 15:23:29 +00:00
2019-01-15 21:20:30 +00:00
# Flow-based visual programming for wiring together IoT hardware devices etc
nodered_install: False
nodered_enabled: False
nodered_port: 1880
nodered_web_path: nodered
2018-08-30 21:15:43 +00:00
2019-09-04 19:17:03 +00:00
# Store your docs, calendar, contacts & photos on your local server not cloud!
2020-02-16 04:40:03 +00:00
# If using Nextcloud intensively, set nginx_high_php_limits further above.
2019-01-15 21:20:30 +00:00
nextcloud_install: False
nextcloud_enabled: False
2020-02-16 04:19:36 +00:00
#
# 2020-02-15: UNUSED at this time. Legacy remains from Apache:
2020-02-16 04:19:36 +00:00
# nextcloud_allow_public_ips: True
#
2019-09-05 01:40:03 +00:00
# Configuration tips for IPv4 access controls and tuning RAM/resources:
# https://github.com/iiab/iiab/blob/master/roles/nextcloud/README.md
2020-01-07 23:31:18 +00:00
#
# 2020-01-07: If installing IIAB often, download.nextcloud.com may throttle
2020-01-07 23:39:39 +00:00
# you to ~100 kbit/sec, delaying your IIAB install by an hour or more (#2112).
# Uncomment the following line to end that: (might install an older Nextcloud!)
2020-02-16 03:49:27 +00:00
# nextcloud_dl_url: http://d.iiab.io/packages/latest.tar.bz2
2019-01-15 21:20:30 +00:00
2019-02-09 18:40:17 +00:00
# A full-featured PBX (for rural telephony, etc) based on Asterisk and FreePBX.
2020-01-12 17:51:39 +00:00
# Works on Ubuntu 18.04, Debian 9 w/ Node.js 10.x. Experimental on RPi 3.
pbx_install: False
pbx_enabled: False
2019-01-19 07:47:10 +00:00
asterisk_chan_dongle: False
pbx_signaling_ports_chan_sip: "5160:5161"
pbx_signaling_ports_chan_pjsip: "5060"
pbx_data_ports: "10000:20000"
2019-06-22 17:09:12 +00:00
pbx_http_port: 83
2020-02-16 04:40:03 +00:00
# If using WordPress intensively, set nginx_high_php_limits further above.
2019-01-15 21:20:30 +00:00
wordpress_install: False
wordpress_enabled: False
2019-02-03 17:56:23 +00:00
2017-05-27 18:09:50 +00:00
# 7-EDU-APPS
2018-08-29 01:53:13 +00:00
# KA Lite - SEE THE "Transmission" BITTORRENT DOWNLOADER FURTHER BELOW, TO INSTALL THOUSANDS OF VIDEOS
2017-05-27 18:09:50 +00:00
kalite_install: True
kalite_enabled: True
2018-07-12 05:36:38 +00:00
kalite_server_port: 8008
2019-03-05 18:23:59 +00:00
kalite_root: "{{ content_base }}/ka-lite" # /library/ka-lite
2017-05-27 18:09:50 +00:00
2018-07-16 16:09:52 +00:00
kolibri_install: False
kolibri_enabled: False
2019-09-30 03:52:00 +00:00
kolibri_language: en # ar,bn-bd,en,es-es,fa,fr-fr,hi-in,mr,nyn,pt-br,sw-tz,ta,te,ur-pk,yo,zu
2018-07-17 05:11:46 +00:00
kolibri_http_port: 8009
2018-07-16 16:09:52 +00:00
# kiwix_install: True is REQUIRED, if you install IIAB's Admin Console
kiwix_install: True
kiwix_enabled: True
kiwix_port: 3000
2019-03-05 18:23:59 +00:00
iiab_zim_path: "{{ content_base }}/zims" # /library/zims
2020-07-15 20:05:19 +00:00
kiwix_incl_apk: False
kiwix_apk_url: /software/kiwix
kiwix_apk_src: https://download.kiwix.org/release/kiwix-android/kiwix.apk
# 2020-09-24: BOTH VALUES BELOW ARE IGNORED as PostgreSQL is installed on
# demand as a dependency -- by Moodle &/or Pathagar
postgresql_install: False
postgresql_enabled: False
moodle_install: False
moodle_enabled: False
2020-02-16 04:40:03 +00:00
# If using Moodle intensively, set nginx_high_php_limits further above.
# Regional OSM vector maps use far less disk space than bitmap/raster versions.
# Instructions: https://github.com/iiab/iiab/wiki/IIAB-Maps
osm_vector_maps_install: True
osm_vector_maps_enabled: False
iiab_map_url : http://download.iiab.io/content/OSM/vector-tiles/maplist/hidden
vector_map_path: "{{ content_base }}/www/osm-vector-maps" # /library/www/osm-vector-maps
# MongoDB (/library/dbdata/mongodb) greatly enhances the Sugarizer experience.
2020-02-04 23:19:44 +00:00
# This role was formerly installed by roles/sugarizer/meta/main.yml
#
# 2020-09-24: BOTH VALUES BELOW ARE IGNORED as MongoDB is installed on demand
# as a dependency -- by Sugarizer
2020-09-22 02:16:15 +00:00
mongodb_install: False
# 'mongodb_enabled: False' MAY work when Sugarizer is disabled. Required by
# mongodb/tasks/enable.yml to shut down the service and log status, but that is
# misleading as Sugarizer starts mongodb's systemd service on its own, due to
# 'Requires=mongodb.service' within /etc/systemd/system/sugarizer.service
2019-01-31 06:26:32 +00:00
mongodb_enabled: False
mongodb_port: 27018
# roles/sugarizer/meta/main.yml auto-invokes 2 above prereqs: mongodb & nodejs
2018-07-23 14:45:29 +00:00
# Might stall MongoDB on Power Failure: github.com/xsce/xsce/issues/879
# Sugarizer 1.0.1+ strategies to solve? github.com/iiab/iiab/pull/957
# 2020-09-22: Both vars WERE IGNORED on Deb 10 (MongoDB) but no longer? #1437
2019-01-03 18:08:57 +00:00
sugarizer_install: False
2017-05-27 18:09:50 +00:00
sugarizer_enabled: False
2018-05-21 23:28:21 +00:00
sugarizer_port: 8089
2017-05-27 18:09:50 +00:00
2018-08-30 21:15:43 +00:00
2017-05-27 18:09:50 +00:00
# 8-MGMT-TOOLS
2018-08-31 07:46:04 +00:00
# Transmission is a BitTorrent downloader for large Content Packs etc
2019-01-03 18:08:57 +00:00
transmission_install: False
transmission_enabled: False
transmission_username: Admin
transmission_password: changeme
2018-08-31 07:46:04 +00:00
# Transmission download directory & general owner/group
transmission_download_dir: "{{ content_base }}/transmission/" # /library/transmission/
transmission_user: debian-transmission
transmission_group: root
# Monitor downloads at http://box:9091 or http://box:9091/transmission using Admin/changeme
transmission_http_port: 9091
transmission_url : "/transmission/"
transmission_peer_port: 51413
# Provision Transmission with torrent(s) from http://pantry.learningequality.org/downloads/ka-lite/0.17/content/
transmission_provision: True
transmission_kalite_version: 0.17
2019-03-05 19:18:35 +00:00
# A. UNCOMMENT LANGUAGE(S) IN /etc/iiab/local_vars.yml TO DOWNLOAD KA Lite VIDEOS TO /library/transmission
2018-08-31 07:46:04 +00:00
transmission_kalite_languages:
2018-10-14 00:44:59 +00:00
#- english
2018-08-31 07:46:04 +00:00
#- french
#- hindi
#- portugal-portuguese
#- brazilian-portuguese
#- spanish
#- swahili
# B. Monitor BitTorrent downloads at http://box:9091 using Admin/changeme
# until the download is confirmed complete (can take hours if not days!)
# C. Carefully move all videos/thumbnails into /library/ka-lite/content
# (DO NOT OVERWRITE SUBFOLDERS assessment, locale, srt !)
# D. Log in to KA Lite at http://box:8008/updates/videos/ using Admin/changeme
# then click "Scan content folder for videos" (can take many minutes!)
# E. READ "KA Lite Administration: What tips & tricks exist?" AT http://FAQ.IIAB.IO
2018-08-30 21:15:43 +00:00
awstats_install: True
2019-01-03 18:08:57 +00:00
awstats_enabled: True
2018-08-30 21:15:43 +00:00
# 2020-09-22 WARNING: both vars are IGNORED on Debian 10 due to: iiab/iiab#1849
2018-08-30 21:15:43 +00:00
monit_install: False
monit_enabled: False
watchdog:
- sshd
- idmgr
- ejabberd
- httpd
- postgresql
- squid
2020-02-14 04:38:58 +00:00
munin_install: False
munin_enabled: False
2018-08-30 21:15:43 +00:00
# Handy for maintaining tables, but DANGEROUS if not locked down
phpmyadmin_install: False
phpmyadmin_enabled: False
2020-02-14 04:38:58 +00:00
vnstat_install: False
vnstat_enabled: False
2018-08-30 21:15:43 +00:00
# 9-LOCAL-ADDONS
# 2020-09-24: BOTH VALUES BELOW ARE IGNORED as Yarn is installed on demand as a
# dependency -- by Internet Archive
2020-09-24 13:06:33 +00:00
yarn_install: False
2020-02-04 23:19:44 +00:00
yarn_enabled: False
# Internet Archive Offline / Decentralized Web - create your own offline
# version (http://box:4244 or later http://box/archive?) arising from digital
# library https://dweb.archive.org
internetarchive_install: False
internetarchive_enabled: False
internetarchive_port: 4244 # for http://box:4244
# Minetest is an open source clone of the Minecraft building blocks game
minetest_install: False
minetest_enabled: False
minetest_port: 30000
minetest_server_admin: Admin
minetest_default_game: carbone-ng # only carbone-ng and minetest are supported
minetest_flat_world: False
2018-08-30 21:15:43 +00:00
# Calibre E-Book Library
# WARNING: CALIBRE INSTALLS GRAPHICAL LIBRARIES SIMILAR TO X WINDOWS & OPENGL
# ON (HEADLESS, SERVER, LITE) OS'S THAT DON'T ALREADY HAVE THESE INSTALLED.
2018-10-13 17:49:54 +00:00
calibre_install: False
calibre_enabled: False
2018-08-30 21:15:43 +00:00
# vars/raspbian-9.yml tries the .deb upgrade of Calibre, overriding this default:
calibre_via_debs: False
calibre_unstable_debs: False
# vars/<most-OS's>.yml use Calibre's python installer/upgrader (x86_64), overriding this default:
calibre_via_python: False
2018-10-13 17:52:07 +00:00
# Change calibre_port to 8010 if you're using XO laptops needing above idmgr ?
2018-08-30 21:15:43 +00:00
calibre_port: 8080
2019-03-05 18:58:16 +00:00
# http://box:8080 & http://box:8080/mobile WORK FOR NOW, but short/mnemonic
# URL's like http://box/calibre DON'T YET WORK -- BOOKS RARELY DISPLAY:
calibre_web_path: calibre #NEEDS WORK: https://github.com/iiab/iiab/issues/529
2019-07-14 14:54:27 +00:00
# Avoid URL collisions w/ calibreweb_url1, calibreweb_url2, calibreweb_url3 below!
2018-08-30 21:15:43 +00:00
2018-09-12 18:05:53 +00:00
# WARNING: Calibre-Web (below) depends on Calibre's own /usr/bin/ebook-convert
2018-09-12 18:13:52 +00:00
# program, so we recommend you also install Calibre (above!)
2018-09-12 18:05:53 +00:00
2018-09-12 18:08:00 +00:00
# Calibre-Web alternative to Calibre, offers a clean/modern UX
2019-01-03 18:08:57 +00:00
calibreweb_install: False
calibreweb_enabled: False
2019-07-14 14:47:14 +00:00
calibreweb_port: 8083 # PORT VARIABLE HAS NO EFFECT (as of January 2019)
2018-08-30 21:15:43 +00:00
# http://box/books works. Add {box/libros, box/livres, box/livros, box/liv} etc?
2019-07-14 14:47:14 +00:00
calibreweb_url1: /books # For SHORT URL http://box/books (English)
calibreweb_url2: /libros # For SHORT URL http://box/libros (Spanish)
calibreweb_url3: /livres # For SHORT URL http://box/livres (French)
2018-08-30 21:15:43 +00:00
calibreweb_home: "{{ content_base }}/calibre-web" # /library/calibre-web
2019-05-18 23:11:57 +00:00
# =============================================================================
# UNMAINTAINED LEGACY VARIABLES: YOU'RE TAKING BIG RISKS IF YOU USE ANY HERE...
2019-09-27 16:32:50 +00:00
# CONSIDER THESE NEW OPENSTREETMAP (OSM) APPROACHES INSTEAD:
2018-09-20 00:07:22 +00:00
#
2019-09-27 16:32:50 +00:00
# 2019: https://github.com/iiab/iiab/wiki/IIAB-Maps SEE ABOVE osm_vector_maps_*
# 2018: http://download.iiab.io/content/OSM/vector-tiles/
# 2017: http://oer2go.org/viewmod/en-worldmap-10
2018-09-20 14:22:38 +00:00
#
2019-09-27 16:34:39 +00:00
# Unmaintained
2018-09-20 00:07:22 +00:00
# osm_install: False
# osm_enabled: False
# Changed in June 2017, from the original:
# iiab_install: True
# iiab_enabled: False
2019-01-03 20:20:50 +00:00
# Unmaintained
2018-08-30 21:15:43 +00:00
# docker_install: False
# docker_enabled: False
2017-05-27 18:09:50 +00:00
# THOSE ABOVE WERE STILL OCCASIONALLY USED AS OF NOVEMBER 2019.
# =============================================================================
# THOSE BELOW WERE *NOT* USED FOR YEARS, AS OF NOVEMBER 2019.
# Unmaintained
# authserver_install: False
# authserver_enabled: False
# Unmaintained (better to install from http://teamviewer.com or prep scripts at http://download.iiab.io)
# teamviewer_install: False
# teamviewer_enabled: False
2019-01-03 20:20:50 +00:00
# Unmaintained
2018-08-30 21:15:43 +00:00
# schooltool_install: False
# schooltool_enabled: False
2017-08-31 20:20:02 +00:00
2019-01-03 20:20:50 +00:00
# Unmaintained
2018-08-30 21:17:25 +00:00
# debian_schooltool_install: False
# debian_schooltool_enabled: False
2019-01-03 20:20:50 +00:00
# Unmaintained (consider Calibre or Calibre-Web above?)
2018-08-30 20:44:10 +00:00
# pathagar_install: False
# pathagar_enabled: False
2019-01-03 20:20:50 +00:00
# Unmaintained
2018-08-21 15:24:49 +00:00
# sugar_stats_install: False
# sugar_stats_enabled: False
2019-01-03 20:20:50 +00:00
# Unmaintained
2018-08-21 15:24:49 +00:00
# xovis_install: False
# xovis_enabled: False
# xovis_target_host: "127.0.0.1:5984"
# xovis_deployment_name: olpc
# xovis_db_name: xovis
# xovis_db_user: admin
# xovis_db_password: admin
# xovis_root: "/opt/xovis"
# xovis_backup_dir: "/library/users"
# xovis_chart_heading: "My School: Usage Data Visualization"
2019-01-03 20:20:50 +00:00
# Unmaintained
2018-08-30 23:03:39 +00:00
# owncloud_install: False
# owncloud_enabled: False
2019-01-03 20:20:50 +00:00
# Unmaintained
2017-10-27 00:21:31 +00:00
# ajenti_install: False
# ajenti_enabled: False
2017-08-31 20:20:02 +00:00
2019-01-03 20:20:50 +00:00
# Unmaintained
# rachel_install: False
# rachel_enabled: False
# rachel_content_found: False
# #rachel_url: /rachel
# rachel_doc_root: "{{ doc_root }}/modules"
2019-05-18 23:11:57 +00:00
# =============================================================================
2018-08-21 15:24:49 +00:00
# OS-DEPENDENT VARS: TURN OFF ALL VARS BELOW AND THEN THE CORRECT
# /opt/iiab/iiab/vars/<OS>.yml WILL TURN ON WHAT'S APPROPRIATE. See "How This
# Works" ~30 lines below, and https://github.com/iiab/iiab/wiki/IIAB-Platforms
2017-10-11 13:56:55 +00:00
2019-01-14 13:57:47 +00:00
# Wide to narrow (insofar as poss)
2020-09-02 01:28:19 +00:00
is_debuntu: False # Covers all 4: Ubuntu, Linux Mint, Debian, Raspberry Pi OS (Raspbian)
2020-09-02 01:28:19 +00:00
is_ubuntu: False # Covers: Ubuntu, Linux Mint
2020-01-13 15:26:23 +00:00
is_ubuntu_20: False
is_ubuntu_19: False
is_ubuntu_18: False
2019-01-13 12:45:08 +00:00
is_ubuntu_17: False
2018-07-20 02:18:34 +00:00
is_ubuntu_16: False
2020-09-02 01:28:19 +00:00
is_linuxmint: False # Subset of is_ubuntu
is_linuxmint_20: False
2020-09-02 01:28:19 +00:00
is_debian: False # Covers both: Debian, Raspberry Pi OS (Raspbian)
2018-07-20 02:18:34 +00:00
is_debian_10: False
is_debian_9: False
is_debian_8: False
2020-09-02 01:28:19 +00:00
is_raspbian: False # Covers both: RPi HW + non-RPi HW versions of Raspberry Pi OS (Raspbian)
is_raspbian_10: False
2019-01-13 12:45:08 +00:00
is_raspbian_9: False
is_raspbian_8: False
2017-07-17 19:20:46 +00:00
2019-05-18 23:11:57 +00:00
is_redhat: False # Not well supported as of 2019, see: https://github.com/iiab/iiab/issues/1434
is_centos: False
2019-01-13 12:45:08 +00:00
is_centos_7: False
is_fedora: False
is_fedora_22: False
is_fedora_18: False
2018-08-30 23:03:39 +00:00
# How This Works:
#
# 1. /opt/iiab/iiab/iiab-install copies /opt/iiab/iiab/scripts/local_facts.fact
# to /etc/ansible/facts.d/local_facts.fact
2018-08-30 23:03:39 +00:00
# 2. Ansible runs /etc/ansible/facts.d/local_facts.fact to identify the OS
# 3. The correct /opt/iiab/iiab/vars/<OS>.yml is then invoked by any the
# following high-level scripts in /opt/iiab/iiab for IIAB operators:
2020-09-02 18:32:20 +00:00
# ./iiab-install (uses iiab-stages.yml)
# ./iiab-network (uses iiab-network.yml)
# ./runrole (uses run-one-role.yml)
# 4. Likewise behind the scenes:
# ./iiab-configure (uses iiab-from-cmdline.yml)
# Admin Console (uses iiab-from-console.yml)
#
# More details, including Order of Execution and Precedence:
# https://github.com/iiab/iiab/wiki/IIAB-Variables