Skip to content

Commit

Permalink
docs: add FAQ entry about (un)configure commands
Browse files Browse the repository at this point in the history
Add an entry in the FAQs about what the `configure` and `unconfigure`
commands actually do to your Git configuration.
  • Loading branch information
mjcheetham committed Aug 3, 2023
1 parent 4c3a5bc commit b61a0d9
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,51 @@ demonstration purposes).
5. Re-authorizing the application with the new scope (GCM should automatically
initiate this flow for you next time access is requested).

### Q: What do the `configure` and `unconfigure` commands do?

#### `configure`

The `configure` command will set up Git to use GCM exclusively as the credential
helper. The `configure` command is automatically called by the installers for
Windows and macOS, but you can also run it manually.

It will also set Git to provide the full remote URL (including path) to
credential helpers for Azure Repos remotes using the `dev.azure.com` URL format.
This is required in order to be to able to correctly identify the correct
authority for that Azure DevOps organization.

Specifically, the `configure` command will modify your user Git configuration to
include the following lines:

```ini
[credential]
helper =
helper = <path-to-gcm>
[credential "https://dev.azure.com"]
useHttpPath = true
```

..where `<path-to-gcm>` is the absolute path to the GCM executable.

The empty `helper =` line makes sure that existing credential helpers that may
be set in the system Git configuration are not used. For more details see the
[credential.helper][helper-config-docs].

If you pass the `--system` option, the `configure` command will instead modify
the system Git configuration. This is useful if you want to set up GCM for all
users on a machine.

#### `unconfigure`

This command essentially undoes what the `configure` command does. It will check
your Git configuration for the lines added by the `configure` command and remove
them. The `unconfigure` command is run by the uninstaller for Windows and the
uninstall script on macOS.

On Windows, if run with the `--system` option, the `unconfigure` command will
also ensure that the `credential.helper` setting in the system Git configuration
is not removed and is left as `manager`, the default set by Git for Windows.

[autodetect]: autodetect.md
[azure-ssh]: https://docs.microsoft.com/en-us/azure/devops/repos/git/use-ssh-keys-to-authenticate?view=azure-devops
[bitbucket-ssh]: https://confluence.atlassian.com/bitbucket/ssh-keys-935365775.html
Expand All @@ -251,6 +296,7 @@ initiate this flow for you next time access is requested).
[gitlab-apps]: https://gitlab.com/-/profile/applications
[gitlab-oauthapp-revoke]: ./img/gitlab-oauthapp-revoke.png
[gitlab-oauthapp-revoked]: ./img/gitlab-oauthapp-revoked.png
[helper-config-docs]: https://git-scm.com/docs/gitcredentials#Documentation/gitcredentials.txt-helper
[multiple-users]: multiple-users.md
[netconfig-http-proxy]: netconfig.md#http-proxy
[linux-uninstall-from-src]: ./linux-fromsrc-uninstall.md
Expand Down
1 change: 1 addition & 0 deletions src/osx/Installer.Mac/resources/en.lproj/conclusion.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ <h2>Uninstall</h2>
<h2>Resources</h3>
<ul>
<li><a href="https://aka.ms/gcm">Project homepage</a></li>
<li><a href="https://aka.ms/gcm/faq">Frequently asked questions</a></li>
<li><a href="https://aka.ms/gcm/config">Configuration options</a></li>
</ul>
</div>
Expand Down
1 change: 1 addition & 0 deletions src/osx/Installer.Mac/resources/en.lproj/welcome.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ <h2>Installation notes</h2>
<h2>Learn more</h2>
<ul>
<li><a href="https://aka.ms/gcm">Project homepage</a></li>
<li><a href="https://aka.ms/gcm/faq">Frequently asked questions</a></li>
</ul>
</div>
</body>
Expand Down

0 comments on commit b61a0d9

Please sign in to comment.