Merge pull request hestiacp#1695 from hestiacp/fastcgi-cache

Improvements to FastCGI cache

Author: Kristan Kenney

bin/v-add-web-domain-fast-cgi-cache bin/v-add-fastcgi-cachebin/v-add-web-domain-fast-cgi-cache renamed to bin/v-add-fastcgi-cache

@@ -1,12 +1,12 @@
 #!/bin/bash
-# info: Adding fast cgi nginx support
+# info: Add FastCGI nginx support
 # options: USER DOMAIN [DEBUG]
 # labels: hestia web
 #
-# example: v-add-web-domain-fast-cgi-cache user domain.tld
+# example: v-add-fastcgi-cache user domain.tld
 #
-# Function enables fast cgi support for Nginx
-# Add "yes" as last parameter append debug information to response headers
+# The function enables FastCGI cache for nginx
+# Add "yes" as last parameter to append debug information to response headers
 
 
 #----------------------------------------------------------#
@@ -45,16 +45,16 @@ check_hestia_demo_mode
 # Load domain data
 parse_object_kv_list $(grep "DOMAIN='$domain'" $USER_DATA/web.conf)
 
-# Check if web server is NGINX standalone
+# Check if nginx is not in proxy mode
 if [ "$WEB_SYSTEM" != 'nginx' ]; then
-    echo "Error: NGINX not in Stand Alone mode"
+    echo "Error: nginx is in proxy mode"
     exit $E_NOTEXIST
 fi
 
-
 if ! grep --quiet "forcessl" $HESTIA/data/templates/web/nginx/default.tpl; then
     $BIN/v-update-web-templates
 fi
+
 fastcgi="$HOMEDIR/$user/conf/web/$domain/$WEB_SYSTEM.fastcgi_cache.conf"
 no_cache='$no_cache'
 cookie_session='$cookie_session'
@@ -63,9 +63,11 @@ status='$upstream_cache_status'
 
 cat << EOF > $fastcgi
     fastcgi_cache $domain;
-    fastcgi_no_cache $no_cache;
+    fastcgi_cache_valid 200 2m;
+    fastcgi_cache_valid 301 302 10m;
+    fastcgi_cache_valid 404 10m;
     fastcgi_cache_bypass $no_cache;
-    fastcgi_cache_bypass $cookie_session $http_x_update;
+    fastcgi_no_cache $no_cache;  
 EOF
 
 if [ ! -z "$debug" ]; then
@@ -75,18 +77,18 @@ fi
 chown root:$user $fastcgi
 chmod 640 $fastcgi
 
-str="fastcgi_cache_path /var/cache/nginx/php-fpm/$domain levels=2" 
-str="$str keys_zone=$domain:10m inactive=60m max_size=512m;" 
-conf='/etc/nginx/conf.d/01_fast_cgi_caching_pool.conf'
-if [ -e "$conf" ]; then
+str="fastcgi_cache_path /var/cache/nginx/micro/$domain levels=1:2" 
+str="$str keys_zone=$domain:10m max_size=512m inactive=30m;" 
+conf='/etc/nginx/conf.d/fastcgi_cache_pool.conf'
+if [ -f "$conf" ]; then
     if [ -z "$(grep "=${domain}:" $conf)" ]; then
         echo "$str" >> $conf
     fi
 else
     echo "$str" >> $conf
 fi
 
-mkdir -p /var/cache/nginx/php-fpm/$domain
+mkdir -p /var/cache/nginx/micro/$domain
 
 #----------------------------------------------------------#
 #                       Hestia                             #
@@ -96,15 +98,15 @@ if [ -z "$FASTCGI" ]; then
     add_object_key "web" 'DOMAIN' "$domain" 'FASTCGI_CACHE' 'ALIAS'
 fi
 
-# Set FASTCGI flag to enabled
+# Set FastCGI cache flag to enabled
 update_object_value 'web' 'DOMAIN' "$domain" '$FASTCGI_CACHE' 'yes'
 
 # Restart web server
 $BIN/v-restart-web
-check_result $? "Web restart failed" > /dev/null
+check_result $? "Web server restart failed" > /dev/null
 
 # Logging
-log_history "enabled fast cgi support for $domain"
+log_history "Enabled FastCGI cache for $domain"
 log_event "$OK" "$ARGUMENTS"
 
 exit

bin/v-delete-web-domain-fast-cgi-cache bin/v-delete-fastcgi-cachebin/v-delete-web-domain-fast-cgi-cache renamed to bin/v-delete-fastcgi-cache

@@ -1,11 +1,12 @@
 #!/bin/bash
-# info: remove fast cgi nginx support
+# info: Remove FastCGI nginx support
 # options: USER DOMAIN [RESTART]
 # labels: hestia web
 #
-# example: v-delete-web-domain-fast-cgi-cache user domain.tld
+# example: v-delete-fastcgi-cache user domain.tld
 #
-# The function removes fast cgi cache.
+# The function enables FastCGI cache for nginx
+
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
@@ -41,16 +42,25 @@ check_hestia_demo_mode
 # Load domain data
 parse_object_kv_list $(grep "DOMAIN='$domain'" $USER_DATA/web.conf)
 
-# Remove fast cgi configs
+# Remove FastCGI cache configuration
 if [ -f $HOMEDIR/$user/conf/web/$domain/$WEB_SYSTEM.fastcgi_cache.conf ]; then
-    rm -f $HOMEDIR/$user/conf/web/$domain/$WEB_SYSTEM.fastcgi_cache.conf
+    rm -rf $HOMEDIR/$user/conf/web/$domain/$WEB_SYSTEM.fastcgi_cache.conf
+fi
+
+conf='/etc/nginx/conf.d/fastcgi_cache_pool.conf'
+if [ -f "$conf" ]; then
+    sed -i "/fastcgi_cache $domain;/d" $conf
+    if [ ! -s "$conf" ]; then
+        rm -rf $conf
+    fi
 fi
 
-# Delete cache folder on disabling
-if [ -d /var/cache/nginx/php-fpm/$domain ]; then
-    rm -rf /var/cache/nginx/php-fpm/$domain
+# Delete FastCGI cache folder
+if [ -d /var/cache/nginx/micro/$domain ]; then
+    rm -rf /var/cache/nginx/micro/$domain
 fi
 
+
 #----------------------------------------------------------#
 #                       Hestia                             #
 #----------------------------------------------------------#
@@ -62,14 +72,14 @@ fi
 # Set FASTCGI flag to disabled
 update_object_value 'web' 'DOMAIN' "$domain" '$FASTCGI_CACHE' ''
 
-# Restart services if requested
+# Restart web server
 if [ ! -z "$restart" ]; then
     $BIN/v-restart-web
-    check_result $? "Web restart failed" >/dev/null
+    check_result $? "Web server restart failed" > /dev/null
 fi
 
 # Logging
-log_history "disabled fast cgi support for $domain"
+log_history "Disabled FastCGI cache for $domain"
 log_event "$OK" "$ARGUMENTS"
 
 exit

bin/v-purge-web-domain-nginx-cache bin/v-purge-nginx-cachebin/v-purge-web-domain-nginx-cache renamed to bin/v-purge-nginx-cache

@@ -1,11 +1,11 @@
 #!/bin/bash
-# info: Empty nginx cache
+# info: Purge nginx cache
 # options: USER DOMAIN MODE
 # labels: hestia web
 #
-# example: v-purge-web-domain-nginx-cache user domain.tld proxy
+# example: v-purge-nginx-cache user domain.tld proxy
 #
-# The function clears Nginx cache.
+# The function purges nginx cache.
 
 #----------------------------------------------------------#
 #                    Variable&Function                     #
@@ -34,34 +34,35 @@ is_object_valid 'web' 'DOMAIN' "$domain" "$FASTCGI_CACHE"
 # Perform verification if read-only mode is enabled
 check_hestia_demo_mode
 
-
 #----------------------------------------------------------#
 #                       Action                             #
 #----------------------------------------------------------#
 
 # Load domain data
 parse_object_kv_list $(grep "DOMAIN='$domain'" $USER_DATA/web.conf)
 
-# Empty Fast CGI Cache 
-if [ -d /var/cache/nginx/php-fpm/$domain ]; then
-    rm -fr /var/cache/nginx/php-fpm/$domain/*
+# Purge nginx FastCGI cache
+if [ -d /var/cache/nginx/micro/$domain ]; then
+    rm -rf /var/cache/nginx/micro/$domain
 fi
-# Empty Proxy Cache
+
+# Purge nginx proxy cache
 if [ -d /var/cache/nginx/$domain ]; then
-    rm -fr /var/cache/nginx/$domain/*
+    rm -rf /var/cache/nginx/$domain
 fi
+
 #----------------------------------------------------------#
 #                       Hestia                             #
 #----------------------------------------------------------#
 
 # Restart services if requested
 if [ ! -z "$restart" ]; then
     $BIN/v-restart-web
-    check_result $? "Web restart failed" >/dev/null
+    check_result $? "Web restart failed" > /dev/null
 fi
 
 # Logging
-log_history "purged nginx cache for $domain"
+log_history "Purged nginx cache for $domain"
 log_event "$OK" "$ARGUMENTS"
 
-exit
+exit

install/deb/nginx/nginx.conf

@@ -123,21 +123,21 @@ http {
     error_page 410 /error/410.html;
     error_page 500 501 502 503 504 505 /error/50x.html;
 
-    # Cache settings
+    # Proxy cache
     proxy_cache_path /var/cache/nginx levels=2 keys_zone=cache:10m inactive=60m max_size=1024m;
     proxy_cache_key "$host$request_uri $cookie_user";
     proxy_temp_path  /var/cache/nginx/temp;
     proxy_ignore_headers Expires Cache-Control;
     proxy_cache_use_stale error timeout invalid_header http_502;
     proxy_cache_valid any 1d;
 
-    # FastCGI Cache settings
-    fastcgi_cache_path /var/cache/nginx/php-fpm levels=2 keys_zone=fcgi_cache:10m inactive=60m max_size=1024m;
-    fastcgi_cache_key "$host$request_uri $cookie_user";
-    fastcgi_temp_path  /var/cache/nginx/temp;
-    fastcgi_ignore_headers Expires Cache-Control;
-    fastcgi_cache_use_stale error timeout invalid_header;
-    fastcgi_cache_valid any 1d;
+    # FastCGI cache
+    fastcgi_cache_path /var/cache/nginx/micro levels=1:2 keys_zone=microcache:10m max_size=1024m inactive=30m;
+    fastcgi_cache_key "$scheme$request_method$host$request_uri";
+    fastcgi_cache_methods GET HEAD;
+    fastcgi_cache_use_stale updating error timeout invalid_header http_500 http_503;
+    fastcgi_ignore_headers Cache-Control Expires Set-Cookie;
+    add_header X-FastCGI-Cache $upstream_cache_status;
 
     # Cache bypass
     map $http_cookie $no_cache {

install/upgrade/versions/1.4.0.sh

@@ -6,16 +6,16 @@
 #######                      Place additional commands below.                   #######
 #######################################################################################
 
-# Allow Fast CGI Cache to be enabled for Nginx Standalone
+# Add support for nginx FastCGI cache (standalone)
 if [ -e "/etc/nginx/nginx.conf" ]; then
     check=$(cat /etc/nginx/nginx.conf | grep 'fastcgi_cache_path');
     if [ -z "$check" ]; then 
-        echo "[ * ] Enabling Nginx FastCGI cache support..."
-        sed  -i 's/# Cache bypass/# FastCGI Cache settings\n    fastcgi_cache_path \/var\/cache\/nginx\/php-fpm levels=2\n    keys_zone=fcgi_cache:10m inactive=60m max_size=1024m;\n    fastcgi_cache_key \"$host$request_uri $cookie_user\";\n    fastcgi_temp_path  \/var\/cache\/nginx\/temp;\n    fastcgi_ignore_headers Expires Cache-Control;\n    fastcgi_cache_use_stale error timeout invalid_header;\n    fastcgi_cache_valid any 1d;\n\n    # Cache bypass/g' /etc/nginx/nginx.conf
+        echo "[ * ] Enabling nginx FastCGI cache support..."
+        sed  -i 's/# Cache bypass/# FastCGI cache\n    fastcgi_cache_path \/var\/cache\/nginx\/micro levels=1:2 keys_zone=microcache:10m max_size=1024m inactive=30m;\n    fastcgi_cache_key \"$scheme$request_method$host$request_uri\";\n    fastcgi_cache_methods GET HEAD;\n    fastcgi_cache_use_stale updating error timeout invalid_header http_500 http_503;\n    fastcgi_ignore_headers Cache-Control Expires Set-Cookie;\n    add_header X-FastCGI-Cache \$upstream_cache_status;\n\n    # Cache bypass/g' /etc/nginx/nginx.conf
     fi
 fi
 
-# Populating HELO/SMTP Banner for existing ip's
+# Populating HELO/SMTP Banner for existing IPs
 if [ "$MAIL_SYSTEM" == "exim4" ]; then
     source $HESTIA/func/ip.sh
 
@@ -109,15 +109,15 @@ fi
 # New configuration value for enforcing subdomain ownership
 check=$(cat $HESTIA/conf/hestia.conf | grep 'ENFORCE_SUBDOMAIN_OWNERSHIP');
 if [ -z "$check" ]; then 
-    echo "[ * ] Setting ENFORCE_SUBDOMAIN_OWNERSHIP to no"
+    echo "[ * ] Setting ENFORCE_SUBDOMAIN_OWNERSHIP to no..."
     echo "ENFORCE_SUBDOMAIN_OWNERSHIP='no'" >> $HESTIA/conf/hestia.conf
 fi
 
 # New API feature to set allowed IPs
 if [ "$api" = "yes" ]; then
     check=$(cat $HESTIA/conf/hestia.conf | grep 'API_ALLOWED_IP');
     if [ -z "$check" ]; then 
-        echo "[ * ] Setting API_ALLOWED_IP to allow-all"
+        echo "[ * ] Setting API_ALLOWED_IP to allow-all..."
         echo "API_ALLOWED_IP='allow-all'" >> $HESTIA/conf/hestia.conf
     fi
 else

web/delete/web/cache/index.php

@@ -19,7 +19,7 @@
 if (!empty($_GET['domain'])) {
     $v_username = escapeshellarg($user);
     $v_domain = escapeshellarg($_GET['domain']);
-    exec (HESTIA_CMD."v-purge-web-domain-nginx-cache ".$v_username." ".$v_domain, $output, $return_var);
+    exec (HESTIA_CMD."v-purge-nginx-cache ".$v_username." ".$v_domain, $output, $return_var);
     check_return_code($return_var,$output);
 }
 $_SESSION['ok_msg'] = _('Nginx cache has been successfully purged');

web/edit/web/index.php

@@ -328,14 +328,14 @@
         unset($output);
     }
 
-    //Add / Delete caching support
+    // Enable/Disable nginx cache
     if (($_SESSION['WEB_SYSTEM'] == 'nginx') && ($v_nginx_cache != $_POST['v_nginx_cache'] ) && (empty($_SESSION['error_msg']))) {
         if ( $_POST['v_nginx_cache'] == 'yes' ) {
-           exec (HESTIA_CMD."v-add-web-domain-fast-cgi-cache ".$v_username." ".escapeshellarg($v_domain), $output, $return_var);
+           exec (HESTIA_CMD."v-add-fastcgi-cache ".$v_username." ".escapeshellarg($v_domain), $output, $return_var);
            check_return_code($return_var,$output);
            unset($output); 
         } else {
-            exec (HESTIA_CMD."v-delete-web-domain-fast-cgi-cache ".$v_username." ".escapeshellarg($v_domain), $output, $return_var);
+            exec (HESTIA_CMD."v-delete-fastcgi-cache ".$v_username." ".escapeshellarg($v_domain), $output, $return_var);
             check_return_code($return_var,$output);
             unset($output); 
         }