Merge pull request #1463 from holta/readmes-0-init-and-network

New READMEs for roles/0-init & roles/network

roles/0-init/README.rst

@@ -0,0 +1,9 @@
+=============
+0-init README
+=============
+
+For a higher-level view, please see `IIAB Installation <https://github.com/iiab/iiab/wiki/IIAB-Installation>`_ and http://FAQ.IIAB.IO
+
+This 0th stage literally sets the stage for Internet-in-a-Box (IIAB) installation, prior to Ansible running `Stages 1-to-9 <.>`_ and then the `network <network>`_ stage.
+
+This serves to confirm low-level Ansible facts from the OS — e.g. for housekeeping tasks related to TZ (time zone), hostname, FQDN (fully-qualified domain name), unusual systemwide dependencies etc — and whether Internet is live so that IIAB installation can proceed.

roles/0-init/tasks/main.yml

@@ -102,12 +102,14 @@
 # We decided to enable mysql unconditionally.
 #  when: elgg_enabled or rachel_enabled or owncloud_enabled or phpmyadmin_enabled or wordpress_enabled or iiab_menu_install
 
-# Late 2017: Had commented out MongoDB on a trial basis, for a more basic/lightweight Sugarizer, per https://github.com/iiab/iiab/pull/427
-- name: Turn on both vars for MongoDB if sugarizer_enabled
-  set_fact:
-    mongodb_install: True
-    mongodb_enabled: True
-  when: sugarizer_enabled
+# MongoDB is auto-included by Sugarizer as of Feb 2019, thanks to: roles/sugarizer/meta/main.yml
+#
+## Late 2017: Had commented out MongoDB on a trial basis, for a more basic/lightweight Sugarizer, per https://github.com/iiab/iiab/pull/427
+#- name: Turn on both vars for MongoDB if sugarizer_enabled
+#  set_fact:
+#    mongodb_install: True
+#    mongodb_enabled: True
+#  when: sugarizer_enabled
 
 # There might be other db's
 - name: Turn on both vars for PostgreSQL if moodle_enabled or pathagar_enabled

roles/network/README.rst

@@ -0,0 +1,23 @@
+==============
+Network README
+==============
+
+This is run by Ansible after it has installed the core of Internet-in-a-Box (IIAB) and its apps/services.
+
+Specifically, this 'network' stage is run:
+
+- automatically during IIAB installation, after /opt/iiab/iiab/iiab-install has run `Stages 0-to-9 <.>`_ (thanks to `iiab-stages.yml <../iiab-stages.yml>`_)
+- automatically by IIAB's Admin Console (http://box/admin) if you click ``Configure`` menu -> ``Install Configured Options`` — this is similar to the above, but only runs Stage 0, then Stage 4-to-9, and then finally this 'network' stage (thanks to `iiab-from-console.yml <../iiab-from-console.yml>`_)
+- or manually, if you run ``cd /opt/iiab/iiab`` then `./iiab-network <../iiab-network>`_ (which is much the same as running ``./runrole network``)
+
+For more info, please see:
+
+- https://github.com/iiab/iiab/wiki/IIAB-Networking
+- http://FAQ.IIAB.IO including answers to common questions like:
+
+  - How do I provide Wi-Fi (wireless) to all my kids?
+  - Can I create a Wi-Fi hotspot using an old laptop?
+  - How do I change the wireless network name?
+  - Can I name my server something other than http://BOX.LAN ?
+  - How do I set a static IP Address?
+  - Any other networking tips?