Skip to content

Redmine plugin that adds SAML authentication to Redmine

License

Notifications You must be signed in to change notification settings

alphanodes/redmine_saml

Repository files navigation

Redmine OmniAuth SAML plugin

This plugins adds SAML authentication support for Redmine based on OmniAuth authentication framework with omniauth-saml.

Run Linters Run Brakeman Tests

Requirements

  • Redmine >= 5.0
  • Ruby `>= 2.7
  • Redmine plugins: additionals

Installing

You can first take a look at general instructions for plugins here.

cd $REDMINE
git clone https://github.com/alphanodes/additionals.git plugins/additionals
git clone https://github.com/alphanodes/redmine_saml.git plugins/redmine_saml
# copy configuration to config/initializers/ - could be any file name
cp plugins/redmine_saml/contrib/sample_saml_initializers.rb config/initializers/saml.rb
# make your saml configuration in this file!!!
vim config/initializers/saml.rb
bundle install
bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Restart your Redmine application server. Finaly you need to configure some minor options for the plugin to work, in "Administration" > "Plugins" > "Configure" on the SAML plugin line.

For more information about configuration options, see https://github.com/omniauth/omniauth-saml#options

Uninstall

cd $REDMINE_ROOT
bundle exec rake redmine:plugins:migrate NAME=redmine_saml VERSION=0 RAILS_ENV=production
rm -rf plugins/redmine_saml public/plugin_assets/redmine_saml

Support & contribution

If you have any wishes or improvements, PRs are welcome! If you have any wishes or improvements, PRs are welcome!

We only provide commercial support by alphanodes.com for our hosting customers.

Credits

Its a fork of

Many thanks to them!