Skip to content

Files

Latest commit

9a72d1e · Nov 14, 2024

History

History
74 lines (48 loc) · 3.23 KB

README.md

File metadata and controls

74 lines (48 loc) · 3.23 KB

HedgeDoc plugin for Redmine

Rate at redmine.org Run Rubocop Run Brakeman Run Tests

Features

  • Show list of own HedgeDoc pads in Redmine
  • Show HedgeDoc pads in Redmine projects, if pad name has redmine identifier as prefix. Eg. MyProject: MyPad

Redmine Requirements

  • Redmine version >= 6
  • Redmine Plugin: additionals
  • Ruby version >= 3.1

HedgeDoc Requirements

  • HedgeDoc version: all
  • E-Mail authentification

Installation

Install redmine_hedgedoc plugin for Redmine

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

Restart Redmine (application server) and you should see the plugin show up in the Plugins page.

Configuration

Redmine needs access to HedgeDoc database. Add in your config/database.yml an paragraph names "hedgedoc", e.g.

hedgedoc:
  adapter: postgresql
  database: hedgedoc
  host: localhost
  username: hedgedoc
  password: hedgedoc
  encoding: utf8
  schema_search_path: public

Uninstall

Uninstall redmine_hedgedoc

cd $REDMINE_ROOT
rm -rf plugins/redmine_hedgedoc

Restart Redmine (application server)

License

This plugin is licensed under the terms of GNU/GPL v2. See LICENSE for details.

Redmine Copyright

The redmine_hedgedoc is a plugin extension for Redmine Project Management Software, whose Copyright follows. Copyright (C) 2006- Jean-Philippe Lang

Redmine is a flexible project management web application written using Ruby on Rails framework. More details can be found in the doc directory or on the official website http://www.redmine.org

This program 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 program 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.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.