Project

General

Profile

Plugins Directory » Maintenance Mode Plugin

 Author: Tobias Fischer
Website: https://github.com/tofi86/redmine_maintenance_mode
Code repository: https://github.com/tofi86/redmine_maintenance_mode.git
Registered on: 2014-07-14 (over 10 years ago)
Current version: 2.2.0
Compatible with: Redmine 4.1.x, 4.0.x, 3.4.x, 3.3.x, 3.2.x, 3.1.x, 3.0.x
User ratings:   (9)

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

Only already logged-in administrators have access to the Redmine system during maintenance time whereas a configurable maintenance notice is shown to "normal" users.

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!

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

See branch redmine-2.x for a Redmine 2.4+ compatible version of the plugin

Installation notes

  • 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
Atom

Changelog

2.2.0 (2019-02-09)

Compatible with Redmine 4.1.x, 4.0.x, 3.4.x, 3.3.x, 3.2.x, 3.1.x, 3.0.x.

  • Support for Redmine 4 with Rails 5
  • New locale French fr (Thanks to Florian Judith)

See branch redmine-2.x for a Redmine 2.4+ compatible version of the plugin

2.1.0 (2017-07-27)

Compatible with Redmine 3.4.x, 3.3.x, 3.2.x, 3.1.x, 3.0.x, 2.6.x, 2.5.x, 2.4.x.

  • Support for Redmine 3.4
  • Add "Maintenance Mode" as a separate entry in admin menu
  • New translations Simplified Chinese (zh) and Czech (cs)

2.0.1 (2015-02-10)

Compatible with Redmine 3.3.x, 3.2.x, 3.1.x, 3.0.x, 2.6.x, 2.5.x, 2.4.x.

Features

  • maintenance messages support text formatting in textile or markdown style
    • depending on the global redmine setting
  • block all public pages and redirect to login
  • display additional hint in the login window -> admin only during maintenance
  • support for the redmine_sudo plugin

Under the hood

  • use 'deface' gem/plugin for views

IMPORTANT!!! Upgrade from previous plugin versions

  • 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

1.1.0 (2014-08-08)

Compatible with Redmine 2.6.x, 2.5.x, 2.4.x.

This fixes issues for accidentally logged out admin users which couldn't log in anymore during maintenance time

1.0.1 (2014-07-15)

Compatible with Redmine 2.5.x.

Bugfix release

1.0.0 (2014-07-14)

Compatible with Redmine 2.5.x.

Initial release

User ratings

  by Nikos Karavasilis about 4 years ago

  by Giovanni Novelli almost 7 years ago

Working plugin

  by Eric Feyzullov almost 8 years ago

great

  by Thierry Brochu over 9 years ago

Excellent, simple, and it works!!

  by Jan Jiránek over 9 years ago

Excellent plugin!

  by Maicon Zucco almost 10 years ago

Great! Thanks!

  by Francisco Lopez almost 10 years ago

Works great

  by Marco Lima almost 10 years ago

Really useful, thank you!

  by Lajish Lakshmanan about 10 years ago

Very useful and highly intended plugin. Thanks Tobias..!!