---
title: Charmhub | Deploy GitHub runner using Charmhub - The Open Operator Collection
description: Deploy the latest version of GitHub runner on any cloud.
url: https://charmhub.io/github-runner/docs/reference-token-scopes
---

# GitHub runner

[Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps")

* [Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps")

Platform:

24.04

22.04

20.04

stable 24801f1f

```
juju deploy github-runner
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

---

#### Contacts

##### Maintainers

+ [Launchpad Team](https://launchpad.net/~canonical-is-devops)

* [Submit a bug](https://github.com/canonical/github-runner-operator/issues)

---

Share your thoughts on this charm with the community on discourse.

[Join the discussion](https://discourse.charmhub.io/)

# Token scopes

In order to use the GitHub runner charm, a personal access token with the necessary permissions
is required.

## [Fine grained access token scopes](https://charmhub.io/github-runner/docs/reference-token-scopes#p-31897-fine-grained-access-token-scopes)

**Note**: In addition to having a token with the necessary permissions, the user who owns the
token also must have admin access to the organisation or repository.

### [Organizational runners](https://charmhub.io/github-runner/docs/reference-token-scopes#p-31897-organizational-runners)

The following are the permissions scopes required for the GitHub runners when registering as an
organisational runner.

Organisation:

* Self-hosted runners: read & write

Repository:

* Actions: read (required if COS integration is enabled and private repositories exist)
* Administration: read

### [Repository runners](https://charmhub.io/github-runner/docs/reference-token-scopes#p-31897-repository-runners)

The following are the permissions scopes required for the GitHub runners when registering as an
repository runner.

* Actions: read (required if COS integration is enabled and the repository is private)
* Administration: read & write
* Metadata: read

## [Personal access token scopes](https://charmhub.io/github-runner/docs/reference-token-scopes#p-31897-personal-access-token-scopes)

Depending on whether the charm is used for GitHub organisations or repositories, the following scopes
should be selected when creating a personal access token.

### [Organizational runners](https://charmhub.io/github-runner/docs/reference-token-scopes#p-31897-organizational-runners)

To use this charm for GitHub organisations, the following scopes should be selected:

* `repo`
* `admin:org`

### [Repository runners](https://charmhub.io/github-runner/docs/reference-token-scopes#p-31897-repository-runners)

To use this charm for GitHub repositories, the following scopes should be selected:

* `repo`

---