Page Comparison

Data Migrators recommend using the SSH protocol for authentication between MettleCI Workbench and your remote Git repositories as it is easier to manage access in a uniform manner across multiple remote Git repository hosts (Github, Bitbucket, Gitlab, etc). SSH keys also tend to be more secure than username/password credentials.

In the event that you need to use Git over HTTPS rather than SSH you can configure MettleCI Workbench to store a set of username/password credentials for each user which will be used for all Git HTTPS requests. These are configured in the config.yml file as shown below:

...
gitAuthentication:
  sshKey: "/opt/dm/mci/workbench.key"
  httpsEnabled: true
  httpsCredentialsStore:
    path: /opt/dm/mci/.secrets/git-credentials.p12
    password: ${file:UTF-8:/opt/dm/mci/.secrets/git-credentials-keystore-password}
...

The git credentials will be stored in a keystore that requires a password. This password should be store in a file in the .secrets directory and that file should be referenced in the config.yml file, as shown above.

1. In order to create the password file make sure to login as the mciworkb user. (If you running are on Microsoft Windows you can skip this)

   Code Block
   $> sudo su - mciworkb

2. Go to your mettle home directory

   Code Block
   $> cd /opt/dm/mci

3. Create the file where the keystore password will be saved

   Code Block
   $> touch .secrets/git-credentials-keystore-password

4. Edit the file with your preferred editor and enter a new password

   Code Block
   $> vim .secrets/git-credentials-keystore-password thisisasecurepassword

5. MettleCI Workbench will need to be restarted after saving changes to config.yml.

When HTTPS is enabled, each user can add their git credentials on the Profile page which they can access from the menu in the top right corner of Workbench:

Image Removed

Image Added

You can then enter Git HTTPS or SSH repository URLS in the project registration page. The ssh or https credentials will be used depending on the configured Git protocol, any username shown in the URL will be ignored and overridden by the settings included in config.yml: