Skip to content

alphanodes/redmine_hedgedoc

Repository files navigation

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 >= 5
  • Redmine Plugin: additionals
  • Ruby version >= 2.7.0

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 install --without development test
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)