Skip to content

Latest commit

 

History

History
94 lines (76 loc) · 4.53 KB

gitlab.md

File metadata and controls

94 lines (76 loc) · 4.53 KB

GitLab support

Git Credential Manager supports gitlab.com out the box.

Using on a another instance

To use on another instance, eg. https://gitlab.example.com requires setup and configuration:

  1. Create an OAuth application. This can be at the user, group or instance level. Specify a name and use a redirect URI of http://127.0.0.1/. Unselect the 'Confidential' option. Set the 'write_repository' and 'read_repository' scopes.
  2. Copy the application ID and configure git config --global credential.https://gitlab.example.com.GitLabDevClientId <APPLICATION_ID>
  3. Copy the application secret and configure git config --global credential.https://gitlab.example.com.GitLabDevClientSecret <APPLICATION_SECRET>
  4. Configure authentication modes to include 'browser' git config --global credential.https://gitlab.example.com.gitLabAuthModes browser
  5. For good measure, configure git config --global credential.https://gitlab.example.com.provider gitlab. This may be necessary to recognise the domain as a GitLab instance.
  6. Verify the config is as expected git config --global --get-urlmatch credential https://gitlab.example.com

Clearing config

    git config --global --unset-all credential.https://gitlab.example.com.GitLabDevClientId
    git config --global --unset-all credential.https://gitlab.example.com.GitLabDevClientSecret
    git config --global --unset-all credential.https://gitlab.example.com.provider

Config for popular instances

For convenience, here are the config commands for several popular GitLab instances, provided by community member hickford:

# https://gitlab.freedesktop.org/
git config --global credential.https://gitlab.freedesktop.org.gitlabdevclientid 6503d8c5a27187628440d44e0352833a2b49bce540c546c22a3378c8f5b74d45
git config --global credential.https://gitlab.freedesktop.org.gitlabdevclientsecret 2ae9343a034ff1baadaef1e7ce3197776b00746a02ddf0323bb34aca8bff6dc1
# https://gitlab.gnome.org/
git config --global credential.https://gitlab.gnome.org.gitlabdevclientid adf21361d32eddc87bf6baf8366f242dfe07a7d4335b46e8e101303364ccc470
git config --global credential.https://gitlab.gnome.org.gitlabdevclientsecret cdca4678f64e5b0be9febc0d5e7aab0d81d27696d7adb1cf8022ccefd0a58fc0
# https://salsa.debian.org/
git config --global credential.https://salsa.debian.org.gitlabdevclientid 213f5fd32c6a14a0328048c0a77cc12c19138cc165ab957fb83d0add74656f89
git config --global credential.https://salsa.debian.org.gitlabdevclientsecret 3616b974b59451ecf553f951cb7b8e6e3c91c6d84dd3247dcb0183dac93c2a26
# https://gitlab.haskell.org/
git config --global credential.https://gitlab.haskell.org.gitlabdevclientid 57de5eaab72b3dc447fca8c19cea39527a08e82da5377c2d10a8ebb30b08fa5f
git config --global credential.https://gitlab.haskell.org.gitlabdevclientsecret 5170a480da8fb7341e0daac94223d4fff549c702efb2f8873d950bb2b88e434f
# https://code.videolan.org/
git config --global credential.https://code.videolan.org.gitlabdevclientid f35c379241cc20bf9dffecb47990491b62757db4fb96080cddf2461eacb40375
git config --global credential.https://code.videolan.org.gitlabdevclientsecret 631558ec973c5ef65b78db9f41103f8247dc68d979c86f051c0fe4389e1995e8

See also issue #677.

Preferences

Select an authentication method for 'https://gitlab.com/':
  1. Web browser (default)
  2. Personal access token
  3. Username/password
option (enter for default):

If you have a preferred authentication mode, you can specify credential.gitLabAuthModes:

git config --global credential.gitlabauthmodes browser

Caveats

Improved support requires changes in GitLab. Please vote for these issues if they affect you:

  1. No support for OAuth device authorization (necessary for machines without web browser): GitLab issue 332682
  2. Only domains with prefix gitlab. are recognised as GitLab remotes: GitLab issue 349464
  3. Username/password authentication is suggested even if disabled on server: GitLab issue 349463