Note |
---|
Note This page describes the functionality as of MettleCI Workbench version XXX 1280 onwards. |
Warning |
---|
Warning Upgrading MettleCI Workbench from a version of Workbench prior to XXX to a version post XXX 1280 will result in a breaking change for anyone customers using git Git over HTTPS. |
...
stored under the |
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 by modifying . These are configured in the config.yml
file as shown below:
Code Block |
---|
...
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.
Info |
---|
The Workbench Setup Wizard will automatically generate this file for you with newer versions of workbench. If you are upgrading from an older version of Workbench, you will need to create this file yourself. |
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
...
Go to your mettle home directory
Code Block $> cd /opt/dm/mci
...
Create the file where the keystore password will be saved
Code Block $> touch .secrets/git-credentials-keystore-password
...
Edit the file with your preferred editor and enter a new password
Code Block $> vim .secrets/git-credentials-keystore-password thisisasecurepassword
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:
...
Info |
---|
Tip |