Installing RedmineShop Plugins¶

All RedmineShop plugins follow the standard Redmine plugin installation process. This guide assumes you have a running self-hosted Redmine instance with shell access.

Prerequisites¶

• Redmine 5.x or 6.x with a configured database
• Ruby 3.1+ and Bundler installed on the host
• SSH or shell access to your Redmine server
• A valid license key (from your account page after purchase)

Step 1 — Download the plugin¶

After purchasing, download the plugin archive from your account page on redmineshop.com. Verify the SHA-256 checksum provided in your download email before extracting.

Step 2 — Extract to the plugins directory¶

cd /path/to/redmine
unzip redmine_sso_saml-1.0.0.zip -d plugins/

The extracted folder must keep its original name — do not rename it.

Step 3 — Install gem dependencies¶

bundle install --without development test

Step 4 — Run database migrations¶

RAILS_ENV=production bundle exec rake redmine:plugins:migrate

Step 5 — Restart Redmine¶

# systemd / Puma
sudo systemctl restart redmine

Docker Compose¶
docker compose restart redmine

Step 6 — Activate the plugin¶

Go to Administration → Plugins. Click Configure next to the plugin and enter your license key.

Docker-specific setup¶

If your Redmine runs in Docker, copy the plugin into the container, then run migrations inside it:

docker cp plugins/redmine_sso_saml redmine_web:/usr/src/redmine/plugins/

docker exec redmine_web bundle install --without development test

docker exec -e RAILS_ENV=production redmine_web bundle exec rake redmine:plugins:migrate

docker restart redmine_web

Uninstalling safely¶

Always run the down migration before removing the plugin directory:

RAILS_ENV=production bundle exec rake redmine:plugins:migrate VERSION=0 NAME=redmine_sso_saml

rm -rf plugins/redmine_sso_saml

bundle install

Need help? Open a request on the support page.