Documentation - Redmine Dashboards¶

Individual dashboards on the start page

Redmine Dashboards allows an authorized user to predefine dashboards on the start page.

• Table of contents
• Documentation - Redmine Dashboards
  • Getting Started
    • Dependencies
    • Downloading the plugin
    • Restart Redmine
  • How to add a new block
    • Model
  • Uninstall
  • Changelog
  • Licence

Getting Started¶

This quick introduction shows you the most convenient way for trying out the plugin with your Redmine instance.

Dependencies¶

To run the plugin you need the following dependencies installed:

• Redmine 6.0.z
• Advanced Plugin Helper 0.6.z .

Downloading the plugin¶

Navigate into the plugins directory of your Redmine instance.

Download the latest development state as redmine_dashboards folder
into your plugin directory.

cd (REDMINE_ROOT_DIR)/plugins
git clone -b main https://github.com/xmera-circle/redmine_dashboards.git

Restart Redmine¶

Navigate into the root directoy.

Run the restart Rake task. This will touch restart.txt in order to force Redmine's application server to restart and load
everything from scratch. This will register the new plugin.

cd (REDMINE_ROOT_DIR)
rake restart

How to add a new block¶

Adding a new block requires 4 steps:

1. Create the model file in app/blocks
2. Register it in lib/redmine_dashboards.rb in #instanciate_blocks
3. Update the German and English locales in config/locales
4. Create the view files _<block_name>.html.erb & _<block_name>_settings.html.erb

Model¶

The model file should consist of the following methods:

1. register_type: The block type, usually the name in lower snake case
2. register_label: The locale key used to display the block name
3. register_specs: Specs for the block itself. Can include certain keys like permission which defines which users can create the block, max_frequency which defines how often the block can appear on a dashboard etc.
4. register_settings: Attributes used in the settings partial. The attributes require an attr_accesor to be correctly set by the settings.

Uninstall¶

In order to uninstall the plugin you need to undo the migration first:

bundle exec rake redmine:plugins:migrate NAME=redmine_dashboards VERSION=0

Changelog¶

Every release comes along with a list of notable changes in order to make it easier to follow up on the progress of Redmine Dashboards.

All those changes are documented in source:CHANGELOG.md.

Licence¶

Copyright © 2020-2021 Alexander Meindl https://github.com/alexandermeindl, alphanodes.
Copyright © 2021-2025 Liane Hampe (liaham@xmera.de), xmera Solutions GmbH.

This plugin is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This plugin is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.