---
title: GitHub verbinden
description: "Verbinde dein GitHub-Repository mit Jamdesk für automatische Bereitstellungen bei Pushes – mit App-Installation, Repository-Auswahl und Branch-Konfiguration."
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

Jamdesk integriert sich in GitHub, um deine Dokumentation bei jedem Push von Änderungen automatisch bereitzustellen.

Die Screenshots zeigen die Benutzeroberfläche auf Englisch.

<Note>
Weitere Informationen dazu, wie die GitHub App und die Verknüpfung mit einem persönlichen Konto zusammenarbeiten, findest du unter [GitHub-Integration verstehen](/de/integrations/github).
</Note>

## GitHub-App installieren

Wenn du dich zum ersten Mal bei Jamdesk anmeldest, wirst du aufgefordert, die Jamdesk GitHub App zu installieren. Diese App ermöglicht:

- **Repository-Zugriff** – Inhalte deiner Dokumentation lesen
- **Webhooks** – Builds bei Pushes auslösen
- **Commit-Status** – Build-Status für Commits anzeigen

### Berechtigungen

Die Jamdesk GitHub App fordert folgende Berechtigungen an:

| Berechtigung | Zweck |
|------------|---------|
| Repository-Inhalte (Lesen) | Dokumentationsdateien klonen und lesen |
| Metadaten (Lesen) | Repositories und Branches auflisten |
| Webhooks | Push-Benachrichtigungen empfangen |

<Note>
Jamdesk greift nur auf Repositories zu, für die du ausdrücklich Zugriff gewährt hast. Du kannst den Zugriff jederzeit in deinen GitHub-Einstellungen ändern.
</Note>

## Repository verbinden

<Steps>
  <Step title="Repository auswählen">
    Klicke beim Erstellen oder Bearbeiten eines Projekts auf **Connect Repository**.

    Wähle ein Repository aus, in dem die GitHub App installiert ist.
  </Step>

  <Step title="Branch auswählen">
    Wähle den bereitzustellenden Branch:

    - **main** oder **master** – Am häufigsten für Produktionsdokumentation
    - **docs** – Wenn du deine Dokumentation in einem separaten Branch verwaltest
    - Beliebiger Branch – Für Vorschau-Bereitstellungen
  </Step>

  <Step title="Pfad zur Dokumentation angeben">
    Wenn sich deine `docs.json` nicht im Stammverzeichnis des Repositorys befindet, gib den Pfad an:

    ```bash
    docs/           # Docs in a subdirectory
    packages/docs/  # Monorepo with docs package
    ```

    Lass das Feld leer, wenn sich `docs.json` im Stammverzeichnis befindet.
  </Step>
</Steps>

Nach der Verbindung zeigt dein Projekt-Dashboard das verknüpfte Repository und den Branch:

<img src="/images/dashboard/github-connected.webp" alt="Dashboard mit verbundenem GitHub-Repository, dem Status-Badge „Linked“, dem Repository-Namen und dem Branch" style={{ display: 'block', margin: '0 auto', maxWidth: '500px' }} />

## Automatische Bereitstellungen

Nach der Verbindung löst jeder Push zu deinem konfigurierten Branch einen Build aus:

```bash
git add .
git commit -m "Update API documentation"
git push origin main
```

Builds sind in der Regel nach 30–90 Sekunden abgeschlossen. Den Status kannst du im Dashboard oder beim GitHub-Commit anzeigen.

## Repositories ändern

So verbindest du ein anderes Repository:

1. Gehe zu **Settings** → **Repository**
2. Klicke auf **Change Repository**
3. Wähle das neue Repository und den Branch aus

<Warning>
Das Ändern von Repositories kann sich auf deine live geschaltete Dokumentation auswirken. Das neue Repository muss eine gültige Jamdesk-Konfiguration enthalten.
</Warning>

## Zugriff auf die GitHub App verwalten

Lege fest, auf welche Repositories Jamdesk zugreifen kann:

1. Gehe zu [github.com/settings/installations](https://github.com/settings/installations)
2. Suche **Jamdesk** in der Liste
3. Klicke auf **Configure**
4. Wähle unter „Repository access“ bestimmte Repositories oder alle Repositories aus

### Organisations-Repositories

Bei Organisations-Repositories muss ein Organisationsadministrator die Installation der GitHub App genehmigen:

1. Fordere die Installation über dein Jamdesk-Dashboard an
2. Ein Administrator erhält eine Benachrichtigung in GitHub
3. Nach der Genehmigung werden Organisations-Repositories in der Repository-Auswahl angezeigt

## Persönliches Konto verknüpfen

Für eine zuverlässige Zuordnung von Builds verknüpfst du dein persönliches GitHub-Konto in **User Settings**:

1. Klicke auf deinen Avatar → **User Settings**
2. Suche den Abschnitt **GitHub Account**
3. Klicke auf **Link GitHub Account**

Dies ist unabhängig von der GitHub App und stellt sicher, dass deine Commits korrekt dir zugeordnet werden. [Mehr erfahren](/de/integrations/github#persönliches-github-konto-benutzerebene).

## Fehlerbehebung

### Repository wird nicht angezeigt

- Überprüfe, ob die GitHub App im Repository installiert ist
- Vergewissere dich bei Organisations-Repositories, dass ein Administrator den Zugriff genehmigt hat
- Aktualisiere die Repository-Liste im Dashboard

### Builds werden nicht ausgelöst

- Überprüfe, ob der Webhook in den Repository-Einstellungen aktiv ist
- Vergewissere dich, dass du auf den konfigurierten Branch pushst
- Suche in GitHub nach Fehlern bei der Webhook-Zustellung

### Fehler wegen verweigerter Berechtigung

- Autorisiere die GitHub App in deinen GitHub-Einstellungen erneut
- Stelle sicher, dass das Repository für die Jamdesk App zugänglich ist

<Note>
  Ausführlichere Informationen zur Fehlerbehebung findest du unter [GitHub-Integration verstehen](/de/integrations/github).
</Note>

## Wie geht es weiter?

<Columns cols={2}>
  <Card title="Create a Project" icon="plus" href="/de/setup/creating-projects">
    Richte ein neues Jamdesk-Projekt ein
  </Card>
  <Card title="Directory Structure" icon="folder-tree" href="/de/setup/directory-structure">
    Organisiere deine Dokumentation für eine skalierbare Struktur
  </Card>
</Columns>