smoebody / redmine_saml

Redmine plugin that adds SAML authentication to Redmine

Redmine OmniAuth SAML plugin

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

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/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

Support & contribution

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

Credits

Its a fork of

• https://github.com/chrodriguez/redmine_omniauth_saml
• https://github.com/jbbarth/redmine_omniauth_cas

Many thanks to them!