Skip to content

Commit c484477

Browse files
authored
docs: standardize gitlab documentation (#1023)
- Swap scopes order to match GitLab UI - Update casing to match https://github.com/GitCredentialManager/git-credential-manager/blob/main/docs/configuration.md
2 parents b8f58dd + cf55a1c commit c484477

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

docs/gitlab.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
Git Credential Manager supports [gitlab.com][gitlab] out the box.
44

5-
## Using on a another instance
5+
## Using on another instance
66

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

1010
1. [Create an OAuth application][gitlab-oauth]. This can be at the user, group
1111
or instance level. Specify a name and use a redirect URI of `http://127.0.0.1/`.
12-
_Unselect_ the 'Confidential' option. Set the 'write_repository' and
13-
'read_repository' scopes.
12+
_Unselect_ the 'Confidential' option. Set the 'read_repository' and
13+
'write_repository' scopes.
1414
1. Copy the application ID and configure
15-
`git config --global credential.https://gitlab.example.com.GitLabDevClientId <APPLICATION_ID>`
15+
`git config --global credential.https://gitlab.example.com.gitLabDevClientId <APPLICATION_ID>`
1616
1. Copy the application secret and configure
17-
`git config --global credential.https://gitlab.example.com.GitLabDevClientSecret
17+
`git config --global credential.https://gitlab.example.com.gitLabDevClientSecret
1818
<APPLICATION_SECRET>`
19-
1. Configure authentication modes to include 'browser'
19+
1. Optional if you want to force browser auth:
2020
`git config --global credential.https://gitlab.example.com.gitLabAuthModes browser`
2121
1. For good measure, configure
2222
`git config --global credential.https://gitlab.example.com.provider gitlab`.
@@ -27,8 +27,8 @@ This may be necessary to recognise the domain as a GitLab instance.
2727
### Clearing config
2828

2929
```console
30-
git config --global --unset-all credential.https://gitlab.example.com.GitLabDevClientId
31-
git config --global --unset-all credential.https://gitlab.example.com.GitLabDevClientSecret
30+
git config --global --unset-all credential.https://gitlab.example.com.gitLabDevClientId
31+
git config --global --unset-all credential.https://gitlab.example.com.gitLabDevClientSecret
3232
git config --global --unset-all credential.https://gitlab.example.com.provider
3333
```
3434

@@ -39,23 +39,23 @@ instances, provided by community member [hickford](https://github.com/hickford/)
3939

4040
```console
4141
# https://gitlab.freedesktop.org/
42-
git config --global credential.https://gitlab.freedesktop.org.gitlabdevclientid 6503d8c5a27187628440d44e0352833a2b49bce540c546c22a3378c8f5b74d45
43-
git config --global credential.https://gitlab.freedesktop.org.gitlabdevclientsecret 2ae9343a034ff1baadaef1e7ce3197776b00746a02ddf0323bb34aca8bff6dc1
42+
git config --global credential.https://gitlab.freedesktop.org.gitLabDevClientId 6503d8c5a27187628440d44e0352833a2b49bce540c546c22a3378c8f5b74d45
43+
git config --global credential.https://gitlab.freedesktop.org.gitLabDevClientSecret 2ae9343a034ff1baadaef1e7ce3197776b00746a02ddf0323bb34aca8bff6dc1
4444
# https://gitlab.gnome.org/
45-
git config --global credential.https://gitlab.gnome.org.gitlabdevclientid adf21361d32eddc87bf6baf8366f242dfe07a7d4335b46e8e101303364ccc470
46-
git config --global credential.https://gitlab.gnome.org.gitlabdevclientsecret cdca4678f64e5b0be9febc0d5e7aab0d81d27696d7adb1cf8022ccefd0a58fc0
45+
git config --global credential.https://gitlab.gnome.org.gitLabDevClientId adf21361d32eddc87bf6baf8366f242dfe07a7d4335b46e8e101303364ccc470
46+
git config --global credential.https://gitlab.gnome.org.gitLabDevClientSecret cdca4678f64e5b0be9febc0d5e7aab0d81d27696d7adb1cf8022ccefd0a58fc0
4747
# https://invent.kde.org/
48-
git config --global credential.https://invent.kde.org.gitlabdevclientid cd7cb4342c7cd83d8c2fcc22c87320f88d0bde14984432ffca07ee24d0bf0699
49-
git config --global credential.https://invent.kde.org.gitlabdevclientsecret 9cc8440b280c792ac429b3615ae1c8e0702e6b2479056f899d314f05afd94211
48+
git config --global credential.https://invent.kde.org.gitLabDevClientId cd7cb4342c7cd83d8c2fcc22c87320f88d0bde14984432ffca07ee24d0bf0699
49+
git config --global credential.https://invent.kde.org.gitLabDevClientSecret 9cc8440b280c792ac429b3615ae1c8e0702e6b2479056f899d314f05afd94211
5050
# https://salsa.debian.org/
51-
git config --global credential.https://salsa.debian.org.gitlabdevclientid 213f5fd32c6a14a0328048c0a77cc12c19138cc165ab957fb83d0add74656f89
52-
git config --global credential.https://salsa.debian.org.gitlabdevclientsecret 3616b974b59451ecf553f951cb7b8e6e3c91c6d84dd3247dcb0183dac93c2a26
51+
git config --global credential.https://salsa.debian.org.gitLabDevClientId 213f5fd32c6a14a0328048c0a77cc12c19138cc165ab957fb83d0add74656f89
52+
git config --global credential.https://salsa.debian.org.gitLabDevClientSecret 3616b974b59451ecf553f951cb7b8e6e3c91c6d84dd3247dcb0183dac93c2a26
5353
# https://gitlab.haskell.org/
54-
git config --global credential.https://gitlab.haskell.org.gitlabdevclientid 57de5eaab72b3dc447fca8c19cea39527a08e82da5377c2d10a8ebb30b08fa5f
55-
git config --global credential.https://gitlab.haskell.org.gitlabdevclientsecret 5170a480da8fb7341e0daac94223d4fff549c702efb2f8873d950bb2b88e434f
54+
git config --global credential.https://gitlab.haskell.org.gitLabDevClientId 57de5eaab72b3dc447fca8c19cea39527a08e82da5377c2d10a8ebb30b08fa5f
55+
git config --global credential.https://gitlab.haskell.org.gitLabDevClientSecret 5170a480da8fb7341e0daac94223d4fff549c702efb2f8873d950bb2b88e434f
5656
# https://code.videolan.org/
57-
git config --global credential.https://code.videolan.org.gitlabdevclientid f35c379241cc20bf9dffecb47990491b62757db4fb96080cddf2461eacb40375
58-
git config --global credential.https://code.videolan.org.gitlabdevclientsecret 631558ec973c5ef65b78db9f41103f8247dc68d979c86f051c0fe4389e1995e8
57+
git config --global credential.https://code.videolan.org.gitLabDevClientId f35c379241cc20bf9dffecb47990491b62757db4fb96080cddf2461eacb40375
58+
git config --global credential.https://code.videolan.org.gitLabDevClientSecret 631558ec973c5ef65b78db9f41103f8247dc68d979c86f051c0fe4389e1995e8
5959
```
6060

6161
See also [issue #677](https://github.com/GitCredentialManager/git-credential-manager/issues/677).
@@ -74,7 +74,7 @@ If you have a preferred authentication mode, you can specify
7474
[credential.gitLabAuthModes][config-gitlab-auth-modes]:
7575

7676
```console
77-
git config --global credential.gitlabauthmodes browser
77+
git config --global credential.gitLabAuthModes browser
7878
```
7979

8080
## Caveats

0 commit comments

Comments
 (0)