iiab/roles/nginx/README.md

### Transition to NGINX

1. Initial testing strategy (December 2019 - February 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) &mdash; creating "Shims" for each IIAB App/Service in *Section iii.* below.

   Until "Native" NGINX is later implemented for that IIAB App/Service &mdash; 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 of IIAB App/Service migrations as of 2020-09-24:

   1. These support "Native" NGINX but ***NOT*** Apache
      * Admin Console
      * captiveportal
      * IIAB documentation (http://box/info)
      * osm-vector-maps
      * OER2Go/RACHEL 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, try setting your *primary web server* to Apache using `apache_install: True` and `apache_enabled: True` (and `nginx_enabled: False` to disable NGINX) 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) before you install IIAB.  You may also need to run `cd /opt/iiab/iiab; ./runrole httpd` since this has been removed from [roles/3-base-server/tasks/main.yml](https://github.com/iiab/iiab/blob/master/roles/3-base-server/tasks/main.yml)-->
      * awstats
      * calibre-web
      * gitea
      * kiwix
      * kolibri
      * mediawiki
      * munin
      * nextcloud
      * sugarizer
      * wordpress

   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/3-base-server/tasks/main.yml#L11](../3-base-server/tasks/main.yml#L11) for a list of IIAB Apps/Services that auto-enable Apache.
      * cups [*, shim not yet in place.]
      * elgg
      * lokole
      * moodle
      * nodered

   4. These each run their own web server or non-web / backend services, e.g. off of their own [unique port(s)](https://github.com/iiab/iiab/wiki/IIAB-Networking#list-of-ports--services) (IIAB home pages link directly to these destinations).  In future we'd like mnemonic URL's for all of these: (e.g. http://box/calibre, http://box/archive, http://box/kalite)
      * bluetooth
      * calibre (menu goes directly to port 8080)
      * internetarchive (menu goes directly to port 4244, [PR #2120](https://github.com/iiab/iiab/pull/2120)) [*]
      * kalite (menu goes directly to ports 8006-8008)
      * minetest
      * mosquitto
      * openvpn
      * pbx [*, requires Apache for now, as in Section iii.]
      * phpmyadmin [*, requires Apache for now, as in Section iii.]
      * samba
      * sshd
      * transmission
      * vnstat

[*] The 4 above starred roles could use improvement, as of 2020-09-24.
oversignts and corrections -- most now seem to work on rpi 2019-10-15 23:47:49 +00:00			`### Transition to NGINX`
Update roles/nginx/README.md 2020-01-11 17:48:09 +00:00
Revise roles/nginx/README.md 2020-02-01 23:52:23 +00:00			`1. Initial testing strategy (December 2019 - February 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.`
Update nginx/README.md 2020-01-23 23:10:53 +00:00
Update nginx/README.md 2020-01-23 23:48:37 +00:00			`Until "Native" NGINX is later implemented for that IIAB App/Service — allowing it to move up to Section ii. below.`
Update nginx/README.md 2020-01-23 23:10:53 +00:00
			`And potentially later moving it up to Section i. if its Apache support is dropped!`
Clarify roles/nginx/README.md 2020-01-24 16:45:57 +00:00
			`(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))`
Doc tweaks @ roles/nginx/README.md 2020-01-12 06:57:00 +00:00
Update roles/nginx/README.md 2020-01-11 17:48:09 +00:00			`2. Without PHP available via FastCGI, any function at all for PHP-based applications validates NGINX.`
Doc tweaks @ roles/nginx/README.md 2020-01-12 06:57:00 +00:00
Clarify NGINX README, default_vars, 4-server-options 2020-09-25 00:40:36 +00:00			`3. Current state of IIAB App/Service migrations as of 2020-09-24:`
Doc tweaks @ roles/nginx/README.md 2020-01-12 06:57:00 +00:00
Update nginx/README.md 2020-01-23 23:48:37 +00:00			`1. These support "Native" NGINX but *NOT* Apache`
Update roles/nginx/README.md 2020-01-11 17:59:05 +00:00			`* Admin Console`
Update nginx/README.md 2020-01-23 23:10:53 +00:00			`* captiveportal`
Revise roles/nginx/README.md 2020-02-01 23:52:23 +00:00			`* IIAB documentation (http://box/info)`
Update roles/nginx/README.md 2020-01-11 17:48:09 +00:00			`* osm-vector-maps`
Revise roles/nginx/README.md 2020-02-01 23:52:23 +00:00			`* OER2Go/RACHEL modules`
Change usb_lib (typo, old) to usb_lib (new) in NGINX doc 2020-03-26 19:00:16 +00:00			`* usb_lib`
Doc tweaks @ roles/nginx/README.md 2020-01-12 06:57:00 +00:00
Clarify NGINX README, default_vars, 4-server-options 2020-09-25 00:40:36 +00:00			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, try setting your primary web server to Apache using `apache_install: True` and `apache_enabled: True` (and `nginx_enabled: False` to disable NGINX) 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) before you install IIAB. You may also need to run `cd /opt/iiab/iiab; ./runrole httpd` since this has been removed from [roles/3-base-server/tasks/main.yml](https://github.com/iiab/iiab/blob/master/roles/3-base-server/tasks/main.yml)-->
Update nginx/README.md 2020-01-23 23:10:53 +00:00			`* awstats`
Update roles/nginx/README.md 2020-01-11 17:48:09 +00:00			`* calibre-web`
			`* gitea`
Revise roles/nginx/README.md 2020-02-14 01:59:44 +00:00			`* kiwix`
Update roles/nginx/README.md 2020-01-11 17:48:09 +00:00			`* kolibri`
Update nginx/README.md 2020-01-23 23:10:53 +00:00			`* mediawiki`
			`* munin`
Nextcloud tuneup for NGINX 2020-02-16 03:49:27 +00:00			`* nextcloud`
Update roles/nginx/README.md 2020-01-11 17:48:09 +00:00			`* sugarizer`
Update nginx/README.md 2020-01-23 23:10:53 +00:00			`* wordpress`
Doc tweaks @ roles/nginx/README.md 2020-01-12 06:57:00 +00:00
Further reduce dependency on Apache 2020-05-20 23:38:09 +00:00			`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/3-base-server/tasks/main.yml#L11](../3-base-server/tasks/main.yml#L11) for a list of IIAB Apps/Services that auto-enable Apache.`
			`* cups [*, shim not yet in place.]`
Update roles/nginx/README.md 2020-01-11 17:48:09 +00:00			`* elgg`
			`* lokole`
			`* moodle`
Update nginx/README.md 2020-01-23 23:10:53 +00:00			`* nodered`
Doc tweaks @ roles/nginx/README.md 2020-01-12 06:57:00 +00:00
Revise roles/nginx/README.md 2020-02-05 00:55:15 +00:00			`4. These each run their own web server or non-web / backend services, e.g. off of their own [unique port(s)](https://github.com/iiab/iiab/wiki/IIAB-Networking#list-of-ports--services) (IIAB home pages link directly to these destinations). In future we'd like mnemonic URL's for all of these: (e.g. http://box/calibre, http://box/archive, http://box/kalite)`
9 core roles check their vars + 3 roles record to iiab_state.yml 2020-09-22 05:04:06 +00:00			`* bluetooth`
Update roles/nginx/README.md 2020-04-30 00:15:50 +00:00			`* calibre (menu goes directly to port 8080)`
Modularize roles/openvpn 2020-02-17 04:33:09 +00:00			`* internetarchive (menu goes directly to port 4244, [PR #2120](https://github.com/iiab/iiab/pull/2120)) [*]`
Simplify roles/kalite by isolating bitrot 2020-02-18 01:00:17 +00:00			`* kalite (menu goes directly to ports 8006-8008)`
9 core roles check their vars + 3 roles record to iiab_state.yml 2020-09-22 05:04:06 +00:00			`* minetest`
			`* mosquitto`
Modularize roles/openvpn 2020-02-17 04:33:09 +00:00			`* openvpn`
roles/nginx/README.md readability tweaks 2020-08-29 03:48:45 +00:00			`* pbx [*, requires Apache for now, as in Section iii.]`
Clarify NGINX README, default_vars, 4-server-options 2020-09-25 00:40:36 +00:00			`* phpmyadmin [*, requires Apache for now, as in Section iii.]`
Samba role standardized/modularized, for runrole etc 2020-09-21 14:21:48 +00:00			`* samba`
Clarify NGINX README, default_vars, 4-server-options 2020-09-25 00:40:36 +00:00			`* sshd`
9 core roles check their vars + 3 roles record to iiab_state.yml 2020-09-22 05:04:06 +00:00			`* transmission`
			`* vnstat`
Revise roles/nginx/README.md 2020-02-05 00:55:15 +00:00
Clarify NGINX README, default_vars, 4-server-options 2020-09-25 00:40:36 +00:00			`[*] The 4 above starred roles could use improvement, as of 2020-09-24.`