Documentation - Redmine Legal Notes¶

Provide legal notes about your Redmine service

Redmine Legal Notes is a plugin which displays legal notice and data privacy policy on dedicated pages or links to remote pages. It also allows the administrator to configure a data policy consent field on the registration page.

• Table of contents
• Documentation - Redmine Legal Notes
  • Getting Started
    • Dependencies
    • Downloading the plugin
    • Restart Redmine
    • Initial configuration
    • User data privacy consent
    • Link to external Pages
  • 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 5.0.z
• Advanced Plugin Helper 0.4.z
• Redmine Base Deface master

Downloading the plugin¶

Navigate into the plugins directory of your Redmine instance.

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

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

Restart Redmine¶

Navigate into your Redmine 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

Initial configuration¶

You should now be able to see the plugin list in Administration -> Plugins and configure the newly installed plugin.

Choose by clicking on the respective tab what you like to edit. Then, write your
legal notes in the systems markup language and save them.

Finally, click on the respective link in the footer to see your legal note page.

User data privacy consent¶

When you like your users to consent to your data privacy policy you can enable the checkbox above
the data privacy policy text area and type in an appropriate text.

The consent field will appear on the register page and in the user account.

Link to external Pages¶

Make sure that the text area above the field for links to external pages is empty!

The same is possible for a remote data privacy policy.

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 Legal Notes.

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

Licence¶

Copyright © 2020-2025 Liane Hampe (liaham@xmera.de), xmera.

The Redmine Legal Notes 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.