Welcome to Additionals Plugin for Redmine

Additionals is a Redmine plugin for customizing Redmine, providing wiki macros and act as a library/function provider for other Redmine plugins.

• Redmine.org plugin page: https://www.redmine.org/plugins/additionals
• Github: https://github.com/alphanodes/additionals

Requirements

| Name | requirement | | -------------------|----------------------------------| | Redmine version | >= 6.1 | | Ruby version | >= 3.2 | | Database version | MySQL >= 8.0 or PostgreSQL >= 14 |

NOTE: If you use MySQL, make sure all database tables using the same storage engine (InnoDB is recommended) and character set (utf8mb4 is recommended). NOTE: For more information use the official Redmine install documentation

Installation

Install additionals plugin for Redmine.

  cd $REDMINE_ROOT
  git clone -b stable https://github.com/alphanodes/additionals.git plugins/additionals
  bundle config set --local without 'development test'
  bundle install
  bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Restart your application server (apache with passenger, nginx with passenger, unicorn, puma, etc.) and additionals is ready to use.

More information about installation of Redmine plugins, you can find in the official Redmine plugin documentation.

Update

Update additionals plugin.

  cd $REDMINE_ROOT/plugins/additionals
  git pull
  cd ../..
  bundle install
  bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Restart your application server (apache with passenger, nginx with passenger, unicorn, puma, etc.) and additionals is ready to use.

Uninstall

Uninstall additionals plugin.

  cd $REDMINE_ROOT
  bundle exec rake redmine:plugins:migrate NAME=additionals VERSION=0 RAILS_ENV=production

Features

• Dashboard (Drag&Drop) Support
• Text for login page
• Global footer for all projects
• Welcome text for login page
• Global sidebar content support
• Note for new issues above issue content (e.g. for guidelines)
• PDF for wiki pages
• Wiki macros for:
  • asciinema
  • attachment_link
  • cryptocompare
  • date
  • fa
  • gihub gist
  • google_docs
  • gmap
  • gps
  • group_users
  • iframe
  • last_updated_at
  • last_updated_by
  • members
  • meteoblue
  • new_issue
  • projects
  • recently_updated
  • reddit
  • redmine.org issue and wiki page (redmine_issue and reminde_wiki)
  • slideshare
  • twitter
  • user
  • vimeo
  • youtube
• macro list with all available macros at /help/macros included documentation
• macro button for wiki toolbar with available macros with project and permission context support
• option to remove "Help" from top menu
• disable (hide) modules for projects
• open external urls in new window
• smiley/emoji legacy support
• anonymize referrer for external urls
• hide role in project memberbox
• limitation of the number of attachments that are displayed as a preview in the issue
• Auto watch option Issues assigned to me
• change issue author
• create issue on user profile
• "assign to me" link on issue
• change issue state on sidebar
• configurable issue rules
  • freeze closed issue
  • change assigned_to automatically, if issue status changes
  • assigned_to has changed, but status change is required, too

NOTE: We reserve the right to remove certain functions again. This is the case, for example, if a function has been included in Redmine Core or conflict with it.

Developer features

As Redmine does not support asset pipeline, we need to install Javascript plugins as Redmine plugins to load them globally.

If no common files are used as library plugin, every plugin has to deliver the same files. And if more than one version of a library is delivered with each Redmine plugin, there is a problem.

Therefore if developer uses this plugin for the provided libraries, everything works smoothly. Don't worry, if you only need a subset of the provided libraries. If you do not load a library, it is not used.

It provides :

• Chart.js
• Chart.js Plugin annotation 3.0.1
• Chart.js Plugin colorschemes 0.4.0 (patched for chartjs 3)
• Chart.js Plugin datalabels 2.2.0
• Chart.js Plugin matrix 2.0.1
• d3 7.9.0
• d3plus 2.0.3
• FontAwesome 5.15.4
• mermaid 11.13.0
• moment 2.30.1 (used by Chart.js)
• Select2 4.0.13
• Sortable 1.15.6

And a set of various Rails helper methods (see below).

It provides the following Rails helper methods :

Libraries assets loader

   additionals_library_load(module_name)

This method loads all JS and CSS files needed by the required module.

The following modules are available :

• chartjs
• chartjs_colorschemes
• chartjs_datalabels
• clipboardjs
• d3
• d3plus
• font_awesome
• mermaid
• select2

Redmine Plugins, which are using additionals

• additional_tags
• redmine_automation
• redmine_db
• redmine_devops
• redmine_git_hosting
• redmine_hedgedoc
• redmine_hrm
• redmine_omniauth_saml
• redmine_passwords
• redmine_issue_view_columns
• redmine_privacy_terms
• redmine_reporting
• redmine_servicedesk
• redmine_sudo
• redmine_wiki_guide

If you know other plugins, which are using additionals, please let us know or create a PR.

You need a feature

additionals is Open-source and it is available at https://github.com/alphanodes/additionals

Contributing

You can help to improve the plugin by providing pull requests of changes or features you want. Thank you for your interest and help.

All contributions to this project are licensed under the terms of GNU/GPL v2. See LICENSE for details.

Comercial feature development

The plugin is maintained by AlphaNodes for free as far as possible. In case you want a feature, which is not available and you are not capable of implementing it yourself, you can request this feature from AlphaNodes.

We are an Open-source_ service company from Munich. Among other things, we offer commercial plugin development (e.g. implementation function request, expansion of functionality, etc). In case the requested plugin changes still fit to the plugin purpose. Please, contact us in case you are interested in commercial plugin development.

Additionals plugin manual

The plugin configuration takes place in the administration area by a user with administration permission. Go to Plugins / Additionals to open it.

The additionals plugin configuration is divided into several sections, described below.

General section

The general section tab allows you to define some special behaviours for your Redmine installation.

Contents

The following plugin options are available to be edited by users with administration rights in the area Contents:

• Text for login page

  • This section is for a short information on the login page below the Redmine login mask. For example who to contact in order to get Redmine access.

• Global sidebar

  • Place your global information here, if needed. Use wiki links or available macros that can be seen by every one.

• Project wide footer

  • In case you want to put some information about your company or for your imprint. Here you can also use wiki syntax for structuring your text.

Settings

And the following options can be edited by users with administratios rights in the area Settings:

• Open external URLs

  • Activate the option Open external URLs in order to open those URLs in a new window or browser tab if someone wants to visit them.

• Go to top Link

  • Add "Go to top" link. If you have a lot of long pages, it is enabling users to easily return to the top of a page.

• Emoji support

  • Activate this option if you want to convert emojis in text. For more info on Emoji-Browser support read more here. Have a look at the Emoji cheat sheet for avail