Merge pull request #2196 from holta/quick-doc-clean

Quick doc clean for NGINX, PostgreSQL, MongoDB, Node.js

roles/mongodb/defaults/main.yml

@@ -1,4 +1,18 @@
-# mongodb_install: False
+# MongoDB (/library/dbdata/mongodb) greatly enhances the Sugarizer experience.
+# The roles/mongodb playbook (was?) invoked by roles/sugarizer/meta/main.yml
+
+# 2020-01-23: mongodb_install is completely ignored as MongoDB is installed on
+# demand as a dependency -- by Sugarizer -- but for now we set fake value
+# 'mongodb_install: True' for 'mongodb_installed is defined' tests e.g. in
+# 0-init/tasks/validate_vars.yml
+
+# mongodb_install: True
+
+# FYI 'mongodb_enabled: False' works 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
+
 # mongodb_enabled: False
 
 # mongodb_port: 27018

roles/nginx/README.md

@@ -1,14 +1,16 @@
 ### Transition to NGINX
 
-1. Initial testing strategy is to move NGINX to port 80, and proxy everything to Apache on port 8090 — creating "Shims" for each IIAB App/Service in *Section iii.* below.
+1. Initial testing strategy (December 2019 - January 2020) is to move NGINX to [port 80](https://github.com/iiab/iiab/wiki/IIAB-Networking#list-of-ports--services), and proxy everything to Apache on [port 8090](https://github.com/iiab/iiab/wiki/IIAB-Networking#list-of-ports--services) — creating "Shims" for each IIAB App/Service in *Section iii.* below.
 
    Until "Native" NGINX is later implemented for that IIAB App/Service — allowing it to move up to *Section ii.* below.
 
    And potentially later moving it up to *Section i.* if its Apache support is dropped!
+   
+   (Background: IIAB Apps/Services are generally [Ansible roles](https://github.com/iiab/iiab/wiki/IIAB-Contributors-Guide#ansible) that live in [/opt/iiab/iiab/roles](https://github.com/iiab/iiab/tree/master/roles))
 
 2. Without PHP available via FastCGI, any function at all for PHP-based applications validates NGINX.
 
-3. Current state IIAB App/Service migrations as of 2020-01-23...
+3. Current state of IIAB App/Service migrations as of 2020-01-24:
 
    1. These support "Native" NGINX but ***NOT*** Apache
       * Admin Console
@@ -17,7 +19,7 @@
       * RACHEL-like modules
       * usb-lib
 
-   2. These support "Native" NGINX ***AND*** Apache, a.k.a. "dual support" for legacy testing (if suitable "Shims" from *Section iii.* below are preserved!)  Both "Native" NGINX and "Shim" proxying from NGINX to Apache port 8090 *cannot be enabled simultaneously* for these IIAB Apps/Service.  But if you want to attempt their "Shim" proxying legacy testing mode, [auto-enable Apache](../0-init/tasks/main.yml#L40-L44) by setting `nginx_enabled: False` in [/etc/iiab/local_vars.yml](http://wiki.laptop.org/go/IIAB/FAQ#What_is_local_vars.yml_and_how_do_I_customize_it.3F)
+   2. These support "Native" NGINX ***AND*** Apache, a.k.a. "dual support" for legacy testing (if suitable "Shims" from *Section iii.* below are preserved!)  Both "Native" NGINX and "Shim" proxying from NGINX to Apache port 8090 *cannot be enabled simultaneously* for these IIAB Apps/Service.  But if you want to attempt their "Shim" proxying legacy testing mode, change your *primary web server* over to Apache by setting `nginx_enabled: False` in [/etc/iiab/local_vars.yml](http://wiki.laptop.org/go/IIAB/FAQ#What_is_local_vars.yml_and_how_do_I_customize_it.3F) (which will [auto-enable Apache](../0-init/tasks/main.yml#L40-L44) for your testing).
       * awstats
       * calibre-web
       * gitea
@@ -28,7 +30,7 @@
       * sugarizer
       * wordpress
 
-   3. These support Apache but ***NOT*** "Native" NGINX.  These use a "Shim" to [proxy_pass](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) from NGINX to Apache on port 8090.  See [roles/0-init/tasks/main.yml#L40-L44](../0-init/tasks/main.yml#L40-L44) for a list of these IIAB Apps/Services, that auto-enable Apache.
+   3. These support Apache but ***NOT*** "Native" NGINX.  They use a "Shim" to [proxy_pass](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) from NGINX to Apache on port 8090.  See [roles/0-init/tasks/main.yml#L40-L44](../0-init/tasks/main.yml#L40-L44) for a list of these IIAB Apps/Services, that auto-enable Apache.
       * dokuwiki ([#2056](https://github.com/iiab/iiab/issues/2056))
       * elgg
       * lokole

roles/nodejs/defaults/main.yml

@@ -0,0 +1,15 @@
+# 2020-01-23: nodejs_install is completely ignored as Node.js is installed on
+# demand as a dependency -- by Node-RED, Sugarizer and/or Internet Archive --
+# but for now we set fake value 'nodejs_install: True' for
+# 'nodejs_installed is defined' tests e.g. in 0-init/tasks/validate_vars.yml
+
+# nodejs_install: True
+# nodejs_enabled: False
+
+# Node.js version used by roles/nodejs/tasks/main.yml for 3 roles:
+# nodered (Node-RED), pbx (Asterix, FreePBX) & sugarizer (Sugarizer)
+
+# nodejs_version: 12.x    # was 8.x until 2019-02-02, was 10.x until 2019-12-21
+
+# All above are set in: github.com/iiab/iiab/blob/master/vars/default_vars.yml
+# If nec, change them by editing /etc/iiab/local_vars.yml prior to installing!

roles/postgresql/defaults/main.yml

@@ -1 +1,12 @@
+# 2020-01-23: postgresql_install is completely ignored as PostgreSQL is
+# installed on demand as a dependency -- by Moodle &/or Pathagar as nec --
+# but for now we set fake value 'postgresql_install: True' for
+# 'postgresql_installed is defined' tests e.g. in 0-init/tasks/validate_vars.yml
+
+# postgresql_install: True
+# postgresql_enabled: False
+
+# All above are set in: github.com/iiab/iiab/blob/master/vars/default_vars.yml
+# If nec, change them by editing /etc/iiab/local_vars.yml prior to installing!
+
 postgresql_locale: "en_US.UTF-8"

roles/postgresql/tasks/main.yml

@@ -91,6 +91,7 @@
     regexp: '^postgresql_installed'
     line: 'postgresql_installed: True'
 
+
 - name: Enable & Start 'postgresql-iiab' systemd service, if 'postgresql_enabled'
   systemd:
     name: postgresql-iiab
@@ -105,6 +106,7 @@
     enabled: no
   when: not postgresql_enabled
 
+
 - name: Add 'postgresql' variable values to {{ iiab_ini_file }}
   ini_file:
     path: "{{ iiab_ini_file }}"