Development version

This documentation is for a Forgejo version which is not yet released.

To read the documentation for the released version of Forgejo, navigate to the latest version.

Deploy Keys

Deploy key are private/public key pairs bound to a specific repository. They are used to grant access via ssh to the repository from an external source, like a build server or CI.

To add a deploy key, you need to go to the repository’s Settings > Deploykey page and add a new deploy key.

Deploy key settings

Permissions

  • Read Only: Deploy key can only read from the repository
  • Read/Write: Grant write access to the repository. Furthermore, one can remove the following writing permission:
    • Write Code: Allow deploy key to push commits to the repository code
    • Write Tags: Allow deploy key to push tags to the repository

Deploy key permissions

For example, disabling write to code permission can be useful for securing release pipelines, allowing them to tag a release but ensuring, the CI cannot accidentally change any code.

Deploy key permissions