Start FileCloud FREE Trial
Log in

Run FileCloud In Maintenance Mode

You might need to run FileCloud server needs in maintenance mode when:

  • Upgrading the server
  • Applying patches
  • Troubleshooting issues

During these situations it will be preferable to run FileCloud in maintenance mode.

(warning)  When run in maintenance mode, the following conditions apply:

  • User interactions with the site will not be allowed
  • Admin interactions can still be performed


To run FileCloud Server in maintenance mode:


Setup Maintenance Mode Rules

Step 1:

Edit the following htaccess file in your FileCloud installation and add the following lines to the top of the file (right after the line RewriteEngine On ).

HTAccess FileLocation
Main .htaccess file

WWWROOT/.htaccess
For example,

  • in Windows, C:\xampp\htdocs\.htaccess
  • in Linux, /var/www/.htaccess

 

In versions of FileCloud prior to 20.2 do the same for the sub .htaccess file under core folder:

Open the file WWWROOT/core/.htaccess

  • in Windows, C:\xampp\htdocs\core\.htaccess
  • in Linux, /var/www/core/.htaccess
HTAccess rules
RewriteEngine On
#maint mode
RewriteCond %{DOCUMENT_ROOT}/resources/ui/maintenance/maintenance.html -f
RewriteCond %{DOCUMENT_ROOT}/resources/ui/maintenance/maintenance.enable -f
RewriteCond %{REQUEST_URI} !/resources/ui/maintenance/
RewriteCond %{REQUEST_URI} !^/ui/admin/
RewriteRule ^.*$ /resources/ui/maintenance/maintenance.html [R=503,L]
ErrorDocument 503 /resources/ui/maintenance/maintenance.html


Step 2 :

Edit the main htaccess file an uncomment the following line:

HTAccess FileLocationUncomment line
Main .htaccess file

WWWROOT/.htaccess
For example,

  • in Windows, C:\xampp\htdocs\.htaccess
  • in Linux, /var/www/.htaccess
RewriteCond %{REQUEST_FILENAME} !-f

Enabling Maintenance Mode

Now that the rules for maintenance mode has been setup, FileCloud can be switched to maintenance mode, by creating the following files.


FileLocationRemarks
maintenance.enable

WWWROOT/resources/ui/maintenance/maintenance.enable


For example,

  • in Windows, C:\xampp\htdocs\resources\ui\maintenance\maintenance.enable
  • in Linux, /var/www/resources/ui/maintenance/maintenance.enable
This can be an empty file.
maintanence.html

WWWROOT/resource/ui/maintenance/maintenance.html


For example,

  • in Windows, C:\xampp\htdocs\resources\ui\maintenance\maintenance.html
  • in Linux, /var/www/resources/ui/maintenance/maintenance.html

    The customized message can be specified in the maintenance.html file
File containing custom html messages for maintenance mode


(lightbulb) Customizing the Maintenance Mode Notification Page

FileCloud maintenance mode notification page can be customized by editing the file WWWROOT/resource/ui/maintenance/maintenance.html. Any logos and css files that needs to be used in the html page can be placed under the same folder and referenced.


FileCloud maintenance mode can be switched off by deleting the file following you created:

$ WWWROOT/resource/ui/maintenance/maintenance.enable