Skip to content

Add docs for Git credentials & new repo restrictions #2753

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions src/pages/docs/infrastructure/git-credentials/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
layout: src/layouts/Default.astro
pubDate: 2025-06-23
modDate: 2025-06-23
title: Git credentials
icon: fa-solid fa-key
description: How to work with Git credentials.
navOrder: 35
---

Git credentials allow you to define your Git authentication credentials once, and reuse them across projects.

You can manage your Git credentials by navigating to **Manage ➜ Git Credentials** in the Octopus Web Portal:

:::figure
![The Git credentials area of Octopus Deploy](/docs/infrastructure/git-credentials/images/git-credentials.png)
:::

## Edit your Git credentials

To edit individual environments, click the Git credential name. From here, it is possible to edit the name, description, change the username and password, set repository restrictions, or delete the Git credential.

## Git credential permissions

You can control who has access to view and edit Git credentials by assigning users to Teams and assigning roles to those teams. For more information, see the section on [managing users and teams](/docs/security/users-and-teams).

## Repository Restrictions

You can optionally restrict the Git credential to specified repository URL's. These can be complete repository URL’s or you can add a wildcard at the end to include everything under that path.

:::figure
![The Git credentials area of Octopus Deploy](/docs/infrastructure/git-credentials/images/git-credential-details.png)
:::

## Older versions

```markdown
Repository Restrictions is a new feature currently rolling out in Octopus Cloud. This property will be missing in versions earlier than 2025.3.
```

## Links

[Github issue](https://github.com/OctopusDeploy/Issues/issues/9471)