Merge pull request #393 from holta/master

Making default_vars.yml dramatically more readable

vars/default_vars.yml

@@ -1,6 +1,7 @@
 # WARNING: DO NOT MODIFY THIS FILE.
 # CHANGES WILL BE LOST IF YOU DO A GIT PULL OR FETCH.
-# Instead put changes in local_vars.yml which is not tracked by git.
+# Instead put changes in local_vars.yml which is not tracked by git:
+# http://wiki.iiab.io/local_vars.yml
 
 # By convention we use True/False to indicate boolean constants.
 
@@ -17,7 +18,7 @@ yum_packages_dir: "{{ iiab_base }}/yum-packages"
 downloads_dir: "{{ iiab_base }}/downloads"
 iiab_download_url: http://download.iiab.io/packages
 
-#Configuration File(s)
+# Configuration File(s)
 iiab_config_file: /etc/iiab/iiab.ini
 service_filelist: "{{ iiab_config_file }}"
 
@@ -44,8 +45,10 @@ iiab_domain: lan
 lan_ip: 172.18.96.1
 lan_netmask: 255.255.224.0
 
-#Read docs/NETWORKING.rst
+# Read https://github.com/iiab/iiab/wiki/IIAB-Networking
-# Gateway  mode
+# Also readable offline @ http://box/info/IIAB-Networking.html 
+
+# Gateway mode
 iiab_lan_enabled: True
 iiab_wan_enabled: True
 ssh_port: 22
@@ -53,8 +56,8 @@ gui_wan: True
 adm_cons_force_ssl: False
 adm_cons_allow_downloads: False
 
-# Internal Wifi Access Point
+# Internal Wi-Fi Access Point
-# Values are used if there is an internal wifi adapter and hostapd is enabled
+# Values are used if there is an internal Wi-Fi adapter and hostapd is enabled
 # The platform variable adapts install to specific hardware (raspberry pi=rpi2)
 hostapd_enabled: True
 host_ssid: "Internet in a Box"
@@ -63,7 +66,7 @@ host_channel: 6
 hostapd_secure: False
 hostapd_password: changeme
 
-#intended for developers
+# Intended for developers
 exFAT_enabled: False
 user_wan_iface: auto
 user_lan_iface: auto
@@ -87,7 +90,7 @@ wan_nameserver:
 
 # 3-BASE
 
-# apache
+# Apache
 allow_apache_sudo: False
 
 # dhcpd
@@ -99,16 +102,16 @@ named_install: True
 named_enabled: True
 block_DNS: False
 
-# dansguardian
+# DansGuardian
 dansguardian_install: False
 dansguardian_enabled: False
 
-# squid
+# Squid
 squid_install: False
 squid_enabled: False
 
-# wondershaper
+# Wonder Shaper
-# unmaintained and high-risk: https://github.com/iiab/iiab/pull/382
+# Unmaintained as of October 2017: https://github.com/iiab/iiab/pull/382
 wondershaper_install: False
 wondershaper_enabled: False
 
@@ -118,34 +121,34 @@ gw_block_https: False
 iiab_gateway_enabled: True
 
 # Home page
-# Default to the gui where the selection is made or override in localvars
+# Default to the gui where the selection is made or override in local_vars.yml
 iiab_home_url: /home
 
-# you can change iiab_home_url in local_vars in order to get a different home page
+# You can change iiab_home_url in local_vars.yml in order to get a different home page.
-# these could be one of the following (assuming they are enabled):
+# For example one of the following: (assuming they are enabled)
 
-#iiab_home_url: /home
+# iiab_home_url: /home
-#iiab_home_url: /xs-portal - the alternate home page
+# iiab_home_url: /xs-portal - the alternate home page
-#iiab_home_url: /wordpress
+# iiab_home_url: /wordpress
-#iiab_home_url: /wiki - either dokuwiki or mediawiki
+# iiab_home_url: /wiki - either dokuwiki or mediawiki
 
 # 4-SERVER-OPTIONS
 
 # sshd
 sshd_enabled: True
 
-# openvpn
+# OpenVPN
 vpn_presence: xscenet.net
 openvpn_server_port: 1194
 openvpn_cron_enabled: False
 openvpn_install: True
 openvpn_enabled: False
 
-# samba
+# Samba. Take a security audit seriously before deploying this.
 samba_install: False
 samba_enabled: False
 
-# postgresql
+# PostgreSQL
 postgresql_install: False
 postgresql_enabled: False
 
@@ -157,11 +160,11 @@ authserver_enabled: False
 usb_lib_install: True
 usb_lib_enabled: True
 
-# docker
+# Docker
 docker_install: False
 docker_enabled: False
 
-# Common UNIX printing system
+# Common UNIX Printing System
 cups_install: True
 cups_enabled: False
 
@@ -181,14 +184,15 @@ ejabberd_enabled: False
 ejabberd_xs_install: False
 ejabberd_xs_enabled: False
 
-# idmgr and activity-server
+# idmgr
 idmgr_install: False
 idmgr_enables: False
 
+# activity-server
 activity_server_install: False
 activity_server_enabled: False
 
-# xovis
+# XOVis
 xovis_install: False
 xovis_enabled: False
 xovis_target_host: "127.0.0.1:5984"
@@ -208,17 +212,18 @@ sugar_stats_enabled: False
 
 # 6-GENERIC-APPS
 
-# MYSQL
+# MySQL
 mysql_install: True
 mysql_enabled: False
 # password is fixmysql
 # mysql_root_password: $6$iiab51$3ICIW0CLWxxMW2a3yrHZ38ukZItD5tcadL4rWcE9D.qIGStxhh8rRsaSxoj3b.MYxI/VRDNjpzSYK/V6zkWFI0
 mysql_root_password: fixmysql
 
+# Handy for maintaining tables, but DANGEROUS if not locked down
 phpmyadmin_install: False
 phpmyadmin_enabled: False
 
-# ELGG
+# Elgg
 elgg_install: True
 elgg_enabled: False
 # elgg_mysql_password: $6$iiab51$jeTwnATcbaa92xo0QBTgjLBU.5aVDDrbKeNyyC99R/TAWz6pvfzj.L7lfnOVVjD78nxqT.gkNn6XZmuRV0W3o1
@@ -228,11 +233,15 @@ elgg_mysql_password: elgg4kids
 owncloud_install: False
 owncloud_enabled: False
 
+# Nextcloud
+nextcloud_install: True
+nextcloud_enabled: False
+
 # WordPress
 wordpress_install: True
 wordpress_enabled: False
 
-# Dokuwiki
+# DokuWiki
 dokuwiki_install: False
 dokuwiki_enabled: False
 
@@ -265,7 +274,7 @@ rachel_content_found: False
 #rachel_url: /rachel
 rachel_doc_root: "{{ doc_root}}/modules"
 
-# Kiwix-Serve
+# Kiwix-serve
 kiwix_install: True
 kiwix_port: 3000
 kiwix_serve_enabled: False
@@ -282,17 +291,17 @@ kalite_server_port: 8008
 kalite_enabled: False
 kalite_cron_enabled: False
 
-#Sugarizer
+# Sugarizer
 sugarizer_install: True
 sugarizer_enabled: False
 
 # 8-MGMT-TOOLS
 
-# munin
+# Munin
 munin_install: True
 munin_enabled: False
 
-# monit
+# Monit
 monit_install: False
 monit_enabled: False
 watchdog:
@@ -303,30 +312,32 @@ watchdog:
   - postgresql
   - squid
 
-# vnstat
+# vnStat
 vnstat_install: True
 vnstat_enabled: False
 
-# awstats -- sumarizes http access logs
+# AWStats -- sumarizes http access logs
 awstats_install: True
 awstats_enabled: False
 
-# schooltool
+# SchoolTool
 schooltool_install: False
 schooltool_enabled: False
 
-# ajenti
+# Ajenti
 ajenti_install: False
 ajenti_enabled: False
 
-# teamviewer
+# TeamViewer - unmaintained (better to install from http://teamviewer.com)
 teamviewer_install: False
 teamviewer_enabled: False
 
-# =====================================================================
+# Toggle iiab-refresh-wiki-docs scraping for offline docs (http://box/info)
-# Platforms - turn all off and let <OS>.yml turn on as appropriate
 nodocs: False
 
+# ================================================================
+# Platforms - turn all off and let <OS>.yml turn on as appropriate
+
 # wide to narrow
 is_debuntu: False
 is_ubuntu: False