Skip to content
This repository has been archived by the owner on Feb 4, 2023. It is now read-only.

tofi86/redmine_maintenance_mode

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Redmine Maintenance Mode plugin

Plugin to prevent users from using Redmine while system operations are being done.

Only administrators have access to the redmine system during maintenance time whereas a configurable maintenance notice is shown to other users. Also, login for normal users is blocked!

You can also schedule maintenance windows. Users will then be notified in advance with a configurable banner message. If maintenance time has come, system will be put in maintenance mode automatically. This will log out non-admin users and prevent them from logging back in.

Be aware that this plugin only blocks non-admin users from the system, while the redmine rails stack is still running! It will NOT shut down redmine!

  • This plugin is tested with Redmine v3.0 - v3.4, v4.0
    • See branch redmine-2.x for a Redmine 2.4+ compatible version of the plugin
  • This plugin is listed in the redmine.org plugin repository

Installation

  • This plugin requires the "Redmine Base Deface"-Plugin!
    • Make sure you got it installed before installing or upgrading the maintenance mode plugin...
  • Clone or download this repo into your redmine_root/plugins/ folder
$ git clone https://github.com/tofi86/redmine_maintenance_mode.git
  • You have to run the plugin rake task to provide the assets (from the Redmine root directory):
$ rake redmine:plugins:migrate RAILS_ENV=production
  • Restart redmine

Upgrade from plugin version 1.x

  • change to the plugin directory in redmine_root/plugins/redmine_maintenance_mode
  • update the git repository by running
$ git pull
  • change back to the plugins directory redmine_root/plugins/
  • Install the "Redmine Base Deface"-Plugin
    • it's needed for easier adjustments in the view templates to display the maintenance messages
$ git clone https://github.com/jbbarth/redmine_base_deface.git
  • change to your redmine root directory and run the following commands:
$ bundle install
$ rake redmine:plugins:migrate RAILS_ENV=production
  • Restart redmine

License

redmine_maintenance_mode plugin is released under the MIT License.

About

Plugin to prevent users from using Redmine while system operations are being done.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 46.3%
  • HTML 29.3%
  • JavaScript 18.5%
  • CSS 5.9%