SaaS-Secure.com

Administration

Getting started

Install SCM Creator, prepare its database and configuration, and enable only the providers available on your Redmine server.

Requirements

  • Redmine 6.0 or newer
  • A writable repository root and the command-line client for every enabled local SCM
  • Octokit 10 for GitHub.com support
  • A reachable VCSAdmin API v1 endpoint when using VCSAdmin Git

Install the plugin

  1. Extract the archive so the final directory is plugins/redmine_scm.
  2. Install the declared Ruby dependencies.
  3. Run the standard Redmine plugin migration.
  4. Copy the sample scm.yml into the Redmine configuration directory and adapt production paths.
  5. Restart Redmine.
bundle install
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
cp plugins/redmine_scm/config/scm.yml config/scm.yml
Upgrade note: version 2.3.5 adds no migration. Upgrades from a release before 2.3 still need the synchronization-lock migration introduced in version 2.3.0.

Enable repository providers

Open Administration → Settings → Repositories and enable only the SCM adapters configured on the server. Users also need the project-level Manage repository permission before they can create or connect repositories.

Production checklist

  • Keep credentials out of committed configuration
  • Make provider roots writable only where required
  • Configure Redmine database encryption before storing repository passwords
  • Restart Redmine after replacing plugin files or configuration

Upgrade an existing installation

  1. Back up the existing plugins/redmine_scm directory and production config/scm.yml.
  2. Replace the plugin directory; do not unpack a second copy under a different folder name.
  3. Run bundle install and the standard plugin migration command. It is safe when no new migration is pending.
  4. Compare the new sample configuration with the production file instead of overwriting production paths or environment-backed credentials.
  5. Restart every Redmine application process and background worker that loads plugins.

Version 2.3.5 needs no migration when upgrading from 2.3.4. Installations older than 2.3.0 must still apply the VCSAdmin synchronization-lock migration before using VCSAdmin Git.

Confirm the installation

  • Open Administration → Plugins and confirm that SCM Creator is listed with the expected version.
  • Open Administration → Settings → Repositories and enable only providers whose binaries, roots, or remote services are configured.
  • Use a test project and an account with Manage repository permission to verify the relevant repository form.
  • Use the provider's connection-test action before saving credentials where one is available.
Do not modify Redmine core files. If the plugin does not appear after installation, first check the final directory name, file ownership, bundle output, Redmine logs, and whether all application processes were restarted.