Skip to content

Commit 29404a2

Browse files
committed
docs: clarify registry settings for sysadmins and ordering
Clarify that the new registry settings are aimed at enterprises and system administrators, _and_ that the settings are at the lowest precedence; they can always be overridden by the user.
1 parent 052ad43 commit 29404a2

File tree

3 files changed

+25
-20
lines changed

3 files changed

+25
-20
lines changed

docs/configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[Git Credential Manager Core](usage.md) works out of the box for most users.
44

55
Git Credential Manager Core (GCM Core) can be configured using Git's configuration files, and follows all of the same rules Git does when consuming the files.
6+
67
Global configuration settings override system configuration settings, and local configuration settings override global settings; and because the configuration details exist within Git's configuration files you can use Git's `git config` utility to set, unset, and alter the setting values. All of GCM Core's configuration settings begin with the term `credential`.
78

89
GCM Core honors several levels of settings, in addition to the standard local \> global \> system tiering Git uses.

docs/enterprise-config.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,45 @@ different mechanisms. In order of preference, those mechanisms are:
88
1. Repository/local configuration (`.git/config`)
99
2. User/global configuration (`$HOME/.gitconfig` or `%HOME%\.gitconfig`)
1010
3. Installation/system configuration (`etc/gitconfig`)
11-
3. Operating system specific configuration store
11+
3. Enterprise system administrator defaults
12+
4. Compiled default values
1213

1314
This model largely matches what Git itself supports, namely environment
1415
variables that take precedence over Git configuration files.
1516

16-
The addition of the operating system specific configuration store enables system
17-
administrators to configure defaults for many settings that may be required in
18-
an enterprise or corporate setting.
17+
The addition of the enterprise system administrator defaults enables those
18+
administrators to configure many GCM settings using familiar MDM tooling, rather
19+
than having to modify the Git installation configuration files.
1920

20-
---
21+
### User Freedom
2122

22-
**Important:** We believe the user should _always_ be at liberty to configure
23+
We believe the user should _always_ be at liberty to configure
2324
Git and GCM exactly as they wish. By prefering environment variables and Git
24-
configuration files over OS store values, these only act as _default values_
25+
configuration files over system admin values, these only act as _default values_
2526
that can always be overriden by the user in the usual ways.
2627

27-
---
28-
2928
## Windows
3029

3130
Default setting values come from the Windows Registry, specifically the
32-
`HKEY_LOCAL_MACHINE` hive under the following key:
31+
following keys:
32+
33+
**32-bit Windows**
3334

3435
```text
35-
SOFTWARE\GitCredentialManager\Configuration
36+
HKEY_LOCAL_MACHINE\SOFTWARE\GitCredentialManager\Configuration
37+
```
38+
39+
**64-bit Windows**
40+
41+
```text
42+
HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\GitCredentialManager\Configuration
3643
```
3744

38-
By using the Windows Registry system administrators can use Group Policy to
45+
> GCM Core is a 32-bit executable on Windows. When running on a 64-bit
46+
installation of Windows registry access is transparently redirected to the
47+
`WOW6432Node` node.
48+
49+
By using the Windows Registry, system administrators can use Group Policy to
3950
easily set defaults for GCM Core's settings.
4051

4152
The names and possible values of all settings under this key are the same as
@@ -44,13 +55,6 @@ those of the [Git configuration](configuration.md) settings.
4455
The type of each registry key can be either `REG_SZ` (string) or `REG_DWORD`
4556
(integer).
4657

47-
**Note:** GCM Core is a 32-bit executable on Windows. When running on a 64-bit
48-
installation of Windows registry access is transparently redirected to the
49-
`WOW6432Node`. This means the actual registry key on 64-bit Windows is:
50-
51-
```text
52-
HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\GitCredentialManager\Configuration
53-
```
5458

5559
## macOS/Linux
5660

docs/environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[Git Credential Manager Core](usage.md) works out of the box for most users. Configuration options are available to customize or tweak behavior.
44

5-
Git Credential Manager Core (GCM Core) can be configured using environment variables. **Environment variables take precedence over [configuration](configuration.md) options**. System administrators may also configure [default values](enterprise-config.md) for many settings used by GCM Core.
5+
Git Credential Manager Core (GCM Core) can be configured using environment variables. **Environment variables take precedence over [configuration](configuration.md) options and enterprise system administrator [default values](enterprise-config.md)**.
66

77
For the complete list of environment variables GCM Core understands, see the list below.
88

0 commit comments

Comments
 (0)