> For the complete documentation index, see [llms.txt](https://docs.terrakube.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.terrakube.io/2.34.0/getting-started/user-management/docker-desktop.md).

# GitHub (Docker Desktop)

Sign in to Terrakube with GitHub accounts, using a GitHub organization's teams as Terrakube groups. This example runs on the Kubernetes cluster in Docker Desktop but the Dex configuration is the same on any cluster.

### Requirements

* A GitHub organization with a team for your Terrakube administrators (for example `TERRAKUBE_ADMIN`) and members added to it.
* [Docker Desktop](https://www.docker.com/products/docker-desktop/) with Kubernetes enabled and the [NGINX ingress controller](https://kubernetes.github.io/ingress-nginx/deploy/#docker-desktop).
* A storage backend and the Terrakube Helm repository; see [Helm Chart](/2.34.0/getting-started/deployment/helm-chart.md).

### Create a GitHub OAuth app

In GitHub, create an OAuth app (**Settings → Developer settings → OAuth Apps**) with the authorization callback URL `https://<your API domain>/dex/callback`. Copy the client ID and generate a client secret.

### Values

Replace the `<<CHANGE_THIS>>` values. GitHub groups are written `OrganizationName:TeamName`.

```yaml
security:
  useOpenLDAP: false
  adminGroup: "MyOrg:TERRAKUBE_ADMIN"
  patSecret: "<<CHANGE_THIS>>"       # 32 characters, see Token Security
  internalSecret: "<<CHANGE_THIS>>"  # 32 characters, see Token Security
  dexClientId: "github"
  dexClientScope: "email openid profile offline_access groups"

dex:
  config:
    issuer: https://terrakube-api.example.com/dex
    storage:
      type: memory
    oauth2:
      responseTypes: ["code", "token", "id_token"]
    web:
      allowedOrigins: ['*']
    staticClients:
    - id: github
      name: github
      public: true
      redirectURIs:
      - 'https://terrakube-ui.example.com'
      - 'http://localhost:10001/login'
      - 'http://localhost:10000/login'
      - '/device/callback'
    connectors:
    - type: github
      id: github
      name: GitHub
      config:
        clientID: "<<CHANGE_THIS>>"
        clientSecret: "<<CHANGE_THIS>>"
        redirectURI: "https://terrakube-api.example.com/dex/callback"
        loadAllGroups: true

ingress:
  ui:
    domain: "terrakube-ui.example.com"
  api:
    domain: "terrakube-api.example.com"
  registry:
    domain: "terrakube-reg.example.com"
```

Add your [storage backend](/2.34.0/getting-started/deployment/storage-backend.md) and [database](/2.34.0/getting-started/deployment/database-backend.md), then install:

```bash
helm install terrakube terrakube-repo/terrakube -n terrakube --values values.yaml
```

Sign in at the UI domain. Members of your administrator team can create organizations; give other teams access with [Team Management](/2.34.0/set-up/organizations/team-management.md), naming each Terrakube team after the GitHub team in the same `OrganizationName:TeamName` form.

For more on the connector, see the [Dex GitHub connector](https://dexidp.io/docs/connectors/github/) and [User Authentication (Dex)](/2.34.0/getting-started/deployment/user-authentication-dex.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.terrakube.io/2.34.0/getting-started/user-management/docker-desktop.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
