ingress addition

scrutiny/CHANGELOG.md

@@ -1,7 +1,9 @@
 - Removed full access flag
 - Improved code for local devices scanning after first installation
 - Solved an issue that made a blank screen on mobile devices
+- Implementation of Ingress with/without ssl
 
 ## 27b923b5-ls11
+
 - Enables PUID/GUID options
-- Daily update of values 
+- Daily update of values

scrutiny/Dockerfile

@@ -6,26 +6,34 @@ FROM ${BUILD_FROM}${BUILD_UPSTREAM}
 # Copy root filesystem
 COPY rootfs /
 
+# Base system
+ARG BASHIO_VERSION=0.13.0
+ARG TEMPIO_VERSION=2021.01.0
+ARG BUILD_ARCH
+
 RUN \
+# Install script
     chmod a+x /run.sh \
     \
-    # Install bashio
+# Add apps
     && apk add --no-cache \
     jq \
     curl \
     cifs-utils \
+    nginx \
     \
-    && curl -J -L -o /tmp/bashio.tar.gz \
+# Install tempio
-    "https://github.com/hassio-addons/bashio/archive/v0.10.1.tar.gz" \
+    && curl -L -f -s -o /usr/bin/tempio \
-    && mkdir /tmp/bashio \
+        "https://github.com/home-assistant/tempio/releases/download/${TEMPIO_VERSION}/tempio_${BUILD_ARCH}" \
-    && tar zxvf \
+    && chmod a+x /usr/bin/tempio \
-    /tmp/bashio.tar.gz \
-    --strip 1 -C /tmp/bashio \
     \
+# Install bashio
+    && mkdir -p /tmp/bashio \
+    && curl -L -f -s "https://github.com/hassio-addons/bashio/archive/v${BASHIO_VERSION}.tar.gz" \
+        | tar -xzf - --strip 1 -C /tmp/bashio \
     && mv /tmp/bashio/lib /usr/lib/bashio \
     && ln -s /usr/lib/bashio/bashio /usr/bin/bashio \
-    && rm -fr \
+    && rm -rf /tmp/bashio \
-    /tmp/* \
 # Allow UID and GID setting
     && sed -i 's/bash/bashio/g' /etc/cont-init.d/10-adduser \
     && sed -i 's/{PUID:-911}/(bashio::config "PUID")/g' /etc/cont-init.d/10-adduser \
@@ -37,7 +45,10 @@ RUN \
     && sed -i 's| /config| /data|g' /etc/cont-init.d/* \
     && sed -i 's| /config| /data|g' /etc/logrotate.d/scrutiny \
     && sed -i 's| /config| /data|g' /etc/crontabs/root \
+ # analyse local devices at reboot and every hours   
     && sed -i -e '$a @reboot /run.sh' /etc/crontabs/root \
-    && sed -i -e '$a 0 * * * * /run.sh' /etc/crontabs/root
+    && sed -i -e '$a 0 * * * * /run.sh' /etc/crontabs/root \
-
+ # correct url paths  
+    && grep -rl '/web/' /app/scrutiny-web/ | xargs sed -i 's|/web/|./|g'
+   
 VOLUME [ "/data" ]

scrutiny/config.json

@@ -1,29 +1,25 @@
 {
   "name": "Scrutiny",
-  "version": "27b923b5-ls11-rev4",
+  "version": "27b923b5-ls11-ingress",
   "upstream": "27b923b5-ls11",
   "slug": "scrutiny",
   "description": "Scrutiny WebUI for smartd S.M.A.R.T monitoring",
   "url": "https://github.com/AnalogJ/scrutiny",
   "startup": "services",
-  "arch": [
+  "arch": ["aarch64", "amd64", "armv7", "armhf"],
-    "aarch64",
+  "ingress": true,
-    "amd64",
+  "ingress_port": 8099,
-    "armv7",
-    "armhf"
-  ],
   "ports": {
     "8080/tcp": 8086
   },
   "ports_description": {
     "8080/tcp": "Web UI port"
   },
-  "devices": ["/dev/sda","/dev/sdb", "/dev/sda1","/dev/sdb1"],
+  "devices": ["/dev/sda", "/dev/sdb", "/dev/sda1", "/dev/sdb1"],
   "privileged": ["SYS_ADMIN", "SYS_RAWIO", "DAC_READ_SEARCH"],
   "udev": "true",
   "apparmor": "true",
-  "map": [
+  "map": [],
-  ],
   "webui": "[PROTO:ssl]://[HOST]:[PORT:8080]",
   "boot": "auto",
   "environment": {
@@ -32,10 +28,16 @@
     "SCRUTINY_COLLECTOR": "true"
   },
   "options": {
+    "ssl": false,
+    "certfile": "fullchain.pem",
+    "keyfile": "privkey.pem",
     "PUID": 0,
     "PGID": 0
   },
   "schema": {
+    "ssl": "bool",
+    "certfile": "str",
+    "keyfile": "str",
     "PUID": "int",
     "PGID": "int",
     "TZ": "str?"

scrutiny/rootfs/etc/cont-init.d/30-nginx

@@ -0,0 +1,40 @@
+#!/usr/bin/with-contenv bashio
+
+#################
+# NGINX SETTING #
+#################
+declare port
+declare certfile
+declare ingress_interface
+declare ingress_port
+declare keyfile
+
+port=$(bashio::addon.port 80)
+if bashio::var.has_value "${port}"; then
+    bashio::config.require.ssl
+
+    if bashio::config.true 'ssl'; then
+        certfile=$(bashio::config 'certfile')
+        keyfile=$(bashio::config 'keyfile')
+
+        mv /etc/nginx/servers/direct-ssl.disabled /etc/nginx/servers/direct.conf
+        sed -i "s/%%certfile%%/${certfile}/g" /etc/nginx/servers/direct.conf
+        sed -i "s/%%keyfile%%/${keyfile}/g" /etc/nginx/servers/direct.conf
+
+    else
+        mv /etc/nginx/servers/direct.disabled /etc/nginx/servers/direct.conf
+    fi
+fi
+
+ingress_port=$(bashio::addon.ingress_port)
+ingress_interface=$(bashio::addon.ip_address)
+sed -i "s/%%port%%/${ingress_port}/g" /etc/nginx/servers/ingress.conf
+sed -i "s/%%interface%%/${ingress_interface}/g" /etc/nginx/servers/ingress.conf
+
+######################
+# API URL CORRECTION #
+######################
+
+# allow true url for ingress 
+grep -rl '/api/' /app | xargs sed -i 's|/api/|api/|g' || true
+grep -rl 'api/' /app | xargs sed -i 's|api/|./api/|g' || true

scrutiny/rootfs/etc/cont-init.d/99-run

@@ -4,7 +4,5 @@
 # Data usage #
 ##############
 
-bashio::log.info "Setting permissions" 
+bashio::log.info "Setting permissions"
 chown -R abc:abc /data
-
-bashio::log.error "due to a bug in upstream image, you must use desktop mode to see the webUI"

scrutiny/rootfs/etc/nginx/includes/mime.types

@@ -0,0 +1,96 @@
+types {
+    text/html                                        html htm shtml;
+    text/css                                         css;
+    text/xml                                         xml;
+    image/gif                                        gif;
+    image/jpeg                                       jpeg jpg;
+    application/javascript                           js;
+    application/atom+xml                             atom;
+    application/rss+xml                              rss;
+
+    text/mathml                                      mml;
+    text/plain                                       txt;
+    text/vnd.sun.j2me.app-descriptor                 jad;
+    text/vnd.wap.wml                                 wml;
+    text/x-component                                 htc;
+
+    image/png                                        png;
+    image/svg+xml                                    svg svgz;
+    image/tiff                                       tif tiff;
+    image/vnd.wap.wbmp                               wbmp;
+    image/webp                                       webp;
+    image/x-icon                                     ico;
+    image/x-jng                                      jng;
+    image/x-ms-bmp                                   bmp;
+
+    font/woff                                        woff;
+    font/woff2                                       woff2;
+
+    application/java-archive                         jar war ear;
+    application/json                                 json;
+    application/mac-binhex40                         hqx;
+    application/msword                               doc;
+    application/pdf                                  pdf;
+    application/postscript                           ps eps ai;
+    application/rtf                                  rtf;
+    application/vnd.apple.mpegurl                    m3u8;
+    application/vnd.google-earth.kml+xml             kml;
+    application/vnd.google-earth.kmz                 kmz;
+    application/vnd.ms-excel                         xls;
+    application/vnd.ms-fontobject                    eot;
+    application/vnd.ms-powerpoint                    ppt;
+    application/vnd.oasis.opendocument.graphics      odg;
+    application/vnd.oasis.opendocument.presentation  odp;
+    application/vnd.oasis.opendocument.spreadsheet   ods;
+    application/vnd.oasis.opendocument.text          odt;
+    application/vnd.openxmlformats-officedocument.presentationml.presentation
+                                                     pptx;
+    application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
+                                                     xlsx;
+    application/vnd.openxmlformats-officedocument.wordprocessingml.document
+                                                     docx;
+    application/vnd.wap.wmlc                         wmlc;
+    application/x-7z-compressed                      7z;
+    application/x-cocoa                              cco;
+    application/x-java-archive-diff                  jardiff;
+    application/x-java-jnlp-file                     jnlp;
+    application/x-makeself                           run;
+    application/x-perl                               pl pm;
+    application/x-pilot                              prc pdb;
+    application/x-rar-compressed                     rar;
+    application/x-redhat-package-manager             rpm;
+    application/x-sea                                sea;
+    application/x-shockwave-flash                    swf;
+    application/x-stuffit                            sit;
+    application/x-tcl                                tcl tk;
+    application/x-x509-ca-cert                       der pem crt;
+    application/x-xpinstall                          xpi;
+    application/xhtml+xml                            xhtml;
+    application/xspf+xml                             xspf;
+    application/zip                                  zip;
+
+    application/octet-stream                         bin exe dll;
+    application/octet-stream                         deb;
+    application/octet-stream                         dmg;
+    application/octet-stream                         iso img;
+    application/octet-stream                         msi msp msm;
+
+    audio/midi                                       mid midi kar;
+    audio/mpeg                                       mp3;
+    audio/ogg                                        ogg;
+    audio/x-m4a                                      m4a;
+    audio/x-realaudio                                ra;
+
+    video/3gpp                                       3gpp 3gp;
+    video/mp2t                                       ts;
+    video/mp4                                        mp4;
+    video/mpeg                                       mpeg mpg;
+    video/quicktime                                  mov;
+    video/webm                                       webm;
+    video/x-flv                                      flv;
+    video/x-m4v                                      m4v;
+    video/x-mng                                      mng;
+    video/x-ms-asf                                   asx asf;
+    video/x-ms-wmv                                   wmv;
+    video/x-msvideo                                  avi;
+}

scrutiny/rootfs/etc/nginx/includes/proxy_params.conf

@@ -0,0 +1,15 @@
+proxy_http_version          1.1;
+proxy_ignore_client_abort   off;
+proxy_read_timeout          86400s;
+proxy_redirect              off;
+proxy_send_timeout          86400s;
+proxy_max_temp_file_size    0;
+
+proxy_set_header Accept-Encoding "";
+proxy_set_header Connection $connection_upgrade;
+proxy_set_header Host $http_host;
+proxy_set_header Upgrade $http_upgrade;
+proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+proxy_set_header X-Forwarded-Proto $scheme;
+proxy_set_header X-NginX-Proxy true;
+proxy_set_header X-Real-IP $remote_addr;

scrutiny/rootfs/etc/nginx/includes/resolver.conf

@@ -0,0 +1 @@
+resolver 127.0.0.11;

scrutiny/rootfs/etc/nginx/includes/server_params.conf

@@ -0,0 +1,6 @@
+root            /dev/null;
+server_name     $hostname;
+
+add_header X-Content-Type-Options nosniff;
+add_header X-XSS-Protection "1; mode=block";
+add_header X-Robots-Tag none;

scrutiny/rootfs/etc/nginx/includes/ssl_params.conf

@@ -0,0 +1,9 @@
+ssl_protocols TLSv1.2;
+ssl_prefer_server_ciphers on;
+ssl_ciphers ECDHE-RSA-AES256-GCM-SHA512:DHE-RSA-AES256-GCM-SHA512:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:DHE-RSA-AES256-SHA;
+ssl_ecdh_curve secp384r1;
+ssl_session_timeout  10m;
+ssl_session_cache shared:SSL:10m;
+ssl_session_tickets off;
+ssl_stapling on;
+ssl_stapling_verify on;

scrutiny/rootfs/etc/nginx/includes/upstream.conf

@@ -0,0 +1,3 @@
+upstream backend {
+    server 127.0.0.1:8080;
+}

scrutiny/rootfs/etc/nginx/nginx.conf

@@ -0,0 +1,56 @@
+# Run nginx in foreground.
+daemon off;
+
+# This is run inside Docker.
+user root;
+
+# Pid storage location.
+pid /var/run/nginx.pid;
+
+# Set number of worker processes.
+worker_processes 1;
+
+# Enables the use of JIT for regular expressions to speed-up their processing.
+pcre_jit on;
+
+# Write error log to Hass.io add-on log.
+error_log /proc/1/fd/1 error;
+
+# Load allowed environment vars
+env HASSIO_TOKEN;
+
+# Load dynamic modules.
+include /etc/nginx/modules/*.conf;
+
+# Max num of simultaneous connections by a worker process.
+events {
+    worker_connections 512;
+}
+
+http {
+    include /etc/nginx/includes/mime.types;
+
+    log_format hassio '[$time_local] $status '
+                        '$http_x_forwarded_for($remote_addr) '
+                        '$request ($http_user_agent)';
+
+    access_log              /proc/1/fd/1 hassio;
+    client_max_body_size    4G;
+    default_type            application/octet-stream;
+    gzip                    on;
+    keepalive_timeout       65;
+    sendfile                on;
+    server_tokens           off;
+    tcp_nodelay             on;
+    tcp_nopush              on;
+
+    map $http_upgrade $connection_upgrade {
+        default upgrade;
+        ''      close;
+    }
+
+    include /etc/nginx/includes/resolver.conf;
+    include /etc/nginx/includes/upstream.conf;
+
+    include /etc/nginx/servers/*.conf;
+}

scrutiny/rootfs/etc/nginx/servers/ingress.conf

@@ -0,0 +1,21 @@
+server {
+    listen %%interface%%:%%port%% default_server;
+
+    include /etc/nginx/includes/server_params.conf;
+    include /etc/nginx/includes/proxy_params.conf;
+    
+    client_max_body_size 0;
+
+    location / { 
+       add_header Access-Control-Allow-Origin *;   
+       proxy_read_timeout 30;
+       proxy_pass         http://backend/web/;
+  }
+ 
+    location /api/ { 
+       add_header Access-Control-Allow-Origin *;   
+       proxy_read_timeout 30;
+       proxy_pass         http://backend/api/;
+  }
+ 
+}

scrutiny/rootfs/etc/services.d/nginx/finish

@@ -0,0 +1,8 @@
+#!/usr/bin/execlineb -S0
+# ==============================================================================
+# Take down the S6 supervision tree when Nginx fails
+# ==============================================================================
+if { s6-test ${1} -ne 0 }
+if { s6-test ${1} -ne 256 }
+
+s6-svscanctl -t /var/run/s6/services

scrutiny/rootfs/etc/services.d/nginx/run

@@ -0,0 +1,9 @@
+#!/usr/bin/with-contenv bashio
+# ==============================================================================
+
+# Wait for transmission to become available
+bashio::net.wait_for 8080 localhost 900
+
+bashio::log.info "Starting NGinx..."
+
+exec nginx