Lint jupyterhub-nginx.conf & nginx.conf etc, for maintainability

roles/jupyterhub/tasks/enable-or-disable.yml

@@ -18,7 +18,7 @@
   when: not jupyterhub_enabled
 
 
-- name: 'Install from template: {{ nginx_conf_dir }}/jupyterhub-nginx.conf'
+- name: "Install from template: {{ nginx_conf_dir }}/jupyterhub-nginx.conf"
   template:
     src: jupyterhub-nginx.conf
     dest: "{{ nginx_conf_dir }}/"

roles/jupyterhub/tasks/install.yml

@@ -16,11 +16,11 @@
 - name: Make the directories to hold JupyterHub config
   file:
     state: directory
-    path: '{{ item }}'
+    path: "{{ item }}"
   with_items:
-    - '{{ jupyterhub_venv }}/etc/jupyter'
-    - '{{ jupyterhub_venv }}/etc/jupyterhub'
-    - '{{ jupyterhub_venv }}/etc/systemd'
+    - "{{ jupyterhub_venv }}/etc/jupyter"
+    - "{{ jupyterhub_venv }}/etc/jupyterhub"
+    - "{{ jupyterhub_venv }}/etc/systemd"
 
 - name: Use npm to install configurable-http-proxy
   npm:
@@ -28,7 +28,7 @@
     global: yes
     state: latest
 
-- name: 'Use pip to install into a virtual environment: {{ jupyterhub_venv }}'
+- name: "Use pip to install into a virtual environment: {{ jupyterhub_venv }}"
   pip:
     name:
       - pip
@@ -45,12 +45,12 @@
     extra_args: "--no-cache-dir"
   when: internet_available
 
-- name: 'Install from template: {{ jupyterhub_venv }}/etc/jupyterhub/jupyterhub_config.py'
+- name: "Install from template: {{ jupyterhub_venv }}/etc/jupyterhub/jupyterhub_config.py"
   template:
     src: jupyterhub_config.py
-    dest: '{{ jupyterhub_venv }}/etc/jupyterhub/'
+    dest: "{{ jupyterhub_venv }}/etc/jupyterhub/"
 
-- name: 'Install from template: /etc/systemd/system/jupyterhub.service'
+- name: "Install from template: /etc/systemd/system/jupyterhub.service"
   template:
     src: jupyterhub.service
     dest: /etc/systemd/system/

roles/jupyterhub/templates/jupyterhub-nginx.conf

@@ -4,10 +4,10 @@ location   /jupyterhub {
     proxy_set_header Host $host;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header X-NginX-Proxy true;
-    }
+}
 
 # Managing WebHook/Socket requests between hub user servers and external proxy
-    location ~* /(api/kernels/[^/]+/(channels|iopub|shell|stdin)|terminals/websocket)/? {
+location ~* /(api/kernels/[^/]+/(channels|iopub|shell|stdin)|terminals/websocket)/? {
     proxy_pass http://127.0.0.1:8000;
     proxy_set_header X-Real-IP $remote_addr;
     proxy_set_header Host $host;
@@ -19,8 +19,9 @@ location   /jupyterhub {
     proxy_set_header Connection $connection_upgrade;
     proxy_set_header X-Scheme $scheme;
     proxy_buffering off;
-    }
-    # Managing requests to verify letsencrypt host
-    location ~ /.well-known {
+}
+
+# Managing requests to verify letsencrypt host
+location ~ /.well-known {
     allow all;
-    }
+}

roles/nginx/templates/nginx.conf.j2

@@ -53,7 +53,6 @@ http {
     log_format scripts '$request > $document_root$fastcgi_script_name $fastcgi_path_info';
     access_log {{ nginx_log_dir }}/scripts.log scripts;
 
-
     ##
     # Gzip Settings
     ##
@@ -68,6 +67,9 @@ http {
     # gzip_http_version 1.1;
     # gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;
 
+    # 2021-04-17: STANZA BELOW THANKS TO @georgejhunt FOR http://box/jupyterhub
+    # SEE ALSO IIAB's: roles/jupyterhub/templates/jupyterhub-nginx.conf
+
     # top-level http config for websocket headers
     # If Upgrade is defined, Connection = upgrade
     # If Upgrade is empty, Connection = close
@@ -80,18 +82,15 @@ http {
     # Virtual Host Configs
     ##
 
-
     # include a server file which in turn includes conf.d/*
     include /etc/nginx/server.conf;
 
     # include other sites
     include /etc/nginx/sites-enabled/*.conf;
 
-
     # define the upstream backend fastcgi for php
     upstream php {
         server  unix:/run/php/php{{ php_version }}-fpm.sock;
     }
            
 }
-