Documentation - Redmine Cookie Consent¶

Inform users about the use of cookies in Redmine

Redmine Cookie Consent is a Redmine plugin which informs your visitors about the usage of cookies in your Redmine instance.

• Table of contents
• Documentation - Redmine Cookie Consent
  • Getting Started
    • Downloading the plugin
    • Restart Redmine
    • Initial configuration
  • Plugin Usage
  • Custom Text
  • Changelog
  • Licence

Getting Started¶

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

Downloading the plugin¶

Navigate into the plugins directory of your Redmine instance.

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

cd (REDMINE_ROOT_DIR)/plugins
git clone -b master https://github.com/xmera-circle/redmine_cookie_consent.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

Initial configuration¶

There is nothing to configure in the admin area yet. That is, the color scheme is fix and reflects Redmine default colors.

When you like to change the text message, refer to the Custom Text section.

Plugin Usage¶

Visit any page of your Redmine instance. You should see the pop up window in the bottom left corner.

Since Redmine comes with essential cookies only, there are no cookies to choose between. Your visitors could either click the 'OK'-Button or start to scroll the page. In both cases the pop up window will disapear.

Custom Text¶

Redmine Cookie Consent comes pre-configured w.r.t. a text message. When it does not fit your needs, you can change it. For doing so, you need to dive a little bit into the codebase.

Navigate into the plugin directory and find the YAML file with your favorite language. Currently, we support
German (de.yml) and English (en.yml).

cd (REDMINE_ROOT_DIR)/plugins/redmine_cookie_consent/config/locales

Open the respective file and change the phrases if you prefer another text for your visitors.

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 Cookie Consent.

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

Licence¶

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

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.