Setup Access Token

This page shows how to set up an access token for your deployments.

The Git access token is used to authenticate with your Git provider (GitHub, GitLab, Bitbucket, etc.) and to clone or fetch your repositories.

You can use doco-cd without a Git access token if the repositories you want to use for your deployments are publicly accessible. However, it is still recommended to use one in that case to for example avoid rate limits.

If you set a Git access token, doco-cd will always use it to authenticate with your Git provider.

Git Providers

• GitHub
• Gitea and Forgejo
• Gitlab

GitHub

You can either use a personal access token or a GitHub App.

How to create an access token

See the GitHub docs for

• Personal access tokens.
• GitHub Apps.

Permissions

Personal access token (Classic)

• The minimum required scope is repo

Fine-grained tokens

• Repository access
  • Set to Public Repositories (read-only) for only public repositories.
  • Set to All Repositories for all repositories.
• The minimum required permissions are:
  • Contents -> Read-only
  • Metadata -> Read-only

Gitea and Forgejo

• Go to your user settings.
• Click on Applications.
• Under Generate New Token:
  • Fill in the Token Name field.
  • Set Repository and Organization Access to All
  • Open Select Permissions and set repository to Read
  • Click on Generate Token and save the token that is shown on the top of the page.

Gitlab

You can either use a personal access token, a group access token or a project access token for Gitlab.

Recommended are personal or group access tokens, as they can be used for multiple projects/repositories.

Token Permissions

• The role Reporter is sufficient (if asked).
• The minimum required scope is read_repository.

How to create an access token

See the Gitlab docs for

• Personal access tokens.
• Group access tokens.
• Project access tokens.