Schnellstart

CodeDoc AI for Confluence, in etwa 5 Minuten verbunden.

Vor dem Start: Du benötigst einen Zugriffstoken deines Git-Hostingdienstes mit read (Lesen) als Zugriffsrecht. Mehr brauchen Blöcke nicht. KI-Seiten sind optional. Beim ersten CodeDoc-Aufruf durch einen Confluence-Administrator führt ein kurzer Assistent durch beide Schritte.
Auf dieser Seite
  1. Git-Anbieter verbinden
  2. Ersten Synchronisierungsblock hinzufügen
  3. KI-Seiten (optional)
  4. Zugriffskontrolle · Nächste Schritte

1. Git-Anbieter verbinden

CodeDoc liest nur Dateien; es schreibt nie in deine Repositories. Der Token liegt verschlüsselt in deiner Confluence-Website (Forge-Geheimnisspeicher) und wird nie erneut angezeigt. Öffne die Schritte deines Anbieters:

GitHub: Fine-grained-Zugriffstoken
  1. Gehe zu github.com/settings/personal-access-tokens/new.
  2. Gib dem Token einen Namen (etwa „CodeDoc AI“) und ein Ablaufdatum.
  3. Unter Repository access (Repositoryzugriff) wähle die für CodeDoc zugänglichen Repositories.
  4. Unter Repository permissions (Repositoryberechtigungen) setze Contents auf Read-only (Nur lesen).
  5. Klicke auf Generate token (Token erstellen) und kopiere ihn; er beginnt mit github_pat_ und wird nur einmal angezeigt.
  6. Wähle in CodeDoc GitHub und füge den Token ein unter Access token (Zugriffstoken) und klicke auf Connect and continue (Verbinden und fortfahren) (später unter Settings: Connect (Verbinden)). CodeDoc bestätigt das verbundene Konto.

Ein klassischer Token (ghp_) mit dem repo als Berechtigungsbereich funktioniert ebenfalls. Bei Organisationsrepositories muss die Organisation einen Fine-grained-Token möglicherweise zuerst freigeben.

GitLab: Persönlicher Zugriffstoken
  1. Gehe zu gitlab.com/-/user_settings/personal_access_tokens und klicke auf Add new token (Neuen Token hinzufügen).
  2. Wähle die Berechtigungsbereiche read_api und read_repository.
  3. Klicke auf Create personal access token (Persönlichen Zugriffstoken erstellen) und kopiere ihn; er beginnt mit glpat- und wird nur einmal angezeigt.
  4. Wähle in CodeDoc GitLab, füge den Token ein und klicke auf Connect and continue (Verbinden und fortfahren).

Gruppen- und Projektzugriffstokens mit denselben Berechtigungsbereichen funktionieren ebenfalls; Untergruppen (group/subgroup/project) werden unterstützt. Eigener GitLab-Server: siehe Own server (Eigener Server).

Bitbucket Cloud: Zugriffstoken

Repository-Zugriffstoken (ein Repository, alle Tarife):

  1. Öffne das Repository in Bitbucket → Repository settings → Access tokens.
  2. Erstelle einen Token mit der Berechtigung Repositories: Read und kopiere ihn.
  3. Wähle in CodeDoc Bitbucket Cloud, füge den Token ein und klicke auf Connect and continue (Verbinden und fortfahren).
  4. Füge das Repository hinzu unter Repositories → Add by address (Per Adresse hinzufügen) (Repositoryadresse einfügen).

Projekt- oder Workspace-Zugriffstoken (mehrere Repositories, Bitbucket Premium): Erstelle ihn in den Projekt- oder Workspace-Einstellungen → Access tokens (Zugriffstokens) mit Repositories: Read, füge ihn ebenso ein und ergänze jedes Repository über Add by address (Per Adresse hinzufügen). Bitbucket erlaubt Zugriffstokens keine Repositoryauflistung, deshalb ist Browse repositories (Repositories durchsuchen) für Bitbucket nicht verfügbar. CodeDoc prüft den Token beim Hinzufügen eines Repositories.

Keine persönlichen API-Tokens: Atlassians Sicherheitsanforderungen verbieten Marketplace-Apps das Sammeln oder Speichern von Atlassian-Kontozugangsdaten. CodeDoc akzeptiert deshalb keine persönlichen Bitbucket-API-Tokens oder App-Passwörter. Ein Repository-Token liest nur sein Repository; ergänze je Repository eine Verbindung oder nutze einen Projekt- beziehungsweise Workspace-Token.
Azure DevOps: Persönlicher Zugriffstoken
  1. Gehe zu dev.azure.com, öffne deine Organisation und dann User settings (Nutzereinstellungen) (oben rechts) → Personal access tokens (Persönliche Zugriffstokens).
  2. Klicke auf + New Token (Neuer Token), benenne ihn und setze den Berechtigungsbereich Code auf Read (Lesen).
  3. Klicke auf Create (Erstellen) und kopiere den nur einmal angezeigten Token.
  4. Wähle in CodeDoc Azure DevOps, füge den Token ein und trage deine Organization URL (Organisations-URL) (https://dev.azure.com/your-org) ein und klicke auf Connect and continue (Verbinden und fortfahren).

Die Organisations-URL ist erforderlich. Du findest sie nach Anmeldung bei Azure DevOps in der Adresszeile, etwa https://dev.azure.com/mycompany.

GitHub Enterprise oder GitLab self-managed: eigener Server
  1. Wähle in CodeDoc GitHub Enterprise (eigener Server oder ghe.com) oder GitLab self-managed und trage die Serveradresse ein, beispielsweise https://github.example.com oder https://example.com/gitlab.
  2. Klicke auf Allow access to the server (Serverzugriff erlauben). Atlassian bittet einen Website-Administrator um Freigabe von CodeDoc-Anfragen an diese Adresse.
  3. Erstelle auf deinem Server einen Token nur für Lesezugriff (GitHub Enterprise: Contents read-only oder klassischer Token mit repo; GitLab: read_api und read_repository), füge ihn ein und klicke auf Connect and continue (Verbinden und fortfahren). Nach neuer Freigabe braucht Atlassian kurz Zeit; CodeDoc versucht es automatisch erneut.
Aus Atlassians Cloud erreichbar: CodeDoc läuft auf Atlassian Forge-, nicht in deinem Netzwerk. Der Server muss per HTTPS mit öffentlichem Zertifikat erreichbar sein. Erlaube hinter einer Firewall Atlassians ausgehende IP-Adressen. Administratoren können die Freigabe unter Atlassian Administration → Connected apps → CodeDoc → Data management sehen und entfernen.

2. Ersten Synchronisierungsblock hinzufügen

Ein Synchronisierungsblock zeigt einen Wert, Abschnitt oder Code aus einer Datei auf einer Confluence-Seite und hält ihn aktuell. Ohne KI und ohne Tokenkosten.

  1. Öffne in CodeDoc Repositories und füge das Repository hinzu: Browse repositories (Repositories durchsuchen) oder Add by address (Per Adresse hinzufügen).
  2. Bearbeite eine Confluence-Seite, öffne das Makromenü mit / und wähle CodeDoc Sync Block.
  3. Füge einen Dateilink ein, etwa https://github.com/helm/examples/blob/main/charts/hello-world/Chart.yaml, und klicke auf Use link (Link verwenden). Oder wähle Repository und Datei selbst.
  4. Wähle den Inhalt: Werte (Schlüssel aus einer Liste wählen), Markdown-Abschnitt, neuester Änderungsprotokolleintrag, markierter Ausschnitt, Zeilenbereich oder vollständige Datei.
  5. Wähle den Aktualisierungszeitpunkt (bei jedem Push, täglich, wöchentlich oder manuell), prüfe die Vorschau, speichere und veröffentliche die Seite.

Der Inhalt ist normaler Seitentext und in Confluence-Suche, Export und Verlauf enthalten. Alle Details: Synchronisierungsblöcke. Für Aktualisierung bei jedem Push ergänze den CodeDoc-Webhook im Repository.

3. KI-Seiten (optional)

CodeDoc Advanced enthält Atlassian AI; es ist keine Verbindung nötig. Klicke auf Continue with Atlassian AI (Mit Atlassian AI fortfahren) im Einrichtungsassistenten (Funktionsweise des Kontingents).

Mit Standard oder für ein eigenes Modell und einen eigenen Vertrag verbinde deinen KI-Anbieter. CodeDoc ruft ihn direkt mit deinem Schlüssel auf; dein Vertrag und deine Abrechnung gelten. Du kannst überspringen und später verbinden unter Settings → Connections (Einstellungen → Verbindungen).

Anthropic (Claude)
  1. Gehe zu platform.claude.com/settings/keys, klicke auf Create Key (Schlüssel erstellen) und kopiere den Schlüssel.
  2. Wähle in CodeDoc Anthropic und füge den Schlüssel ein unter API-Schlüssel und klicke auf Connect and continue (Verbinden und fortfahren).
  3. Wähle ein Modell: Empfehlungen zuerst; suche per Eingabe alle Modelle deines Kontos.

Anthropic benötigt auch bei geringer Nutzung eine Zahlungsmethode: platform.claude.com/settings/billing.

OpenAI (GPT)
  1. Gehe zu platform.openai.com/api-keys, klicke auf + Create new secret key (Neuen geheimen Schlüssel erstellen) und kopiere ihn (nur einmal sichtbar).
  2. Wähle in CodeDoc OpenAI, füge den Schlüssel ein und klicke auf Connect and continue (Verbinden und fortfahren), dann wähle ein Modell.

Prüfe, ob dein Konto Guthaben hat: platform.openai.com/settings/organization/billing.

Google (Gemini)
  1. Gehe zu aistudio.google.com/app/apikey, klicke auf Create API key (API-Schlüssel erstellen) und wähle oder erstelle ein Google-Cloud-Projekt.
  2. Wähle in CodeDoc Google AI (Gemini), füge den Schlüssel ein und klicke auf Connect and continue (Verbinden und fortfahren), dann wähle ein Modell.

Googles kostenloser Tarif mit Anfragegrenzen eignet sich für erste Tests. Google kann darin übertragene Daten zur Produktverbesserung nutzen; verwende nur Code, den du auf diese Weise teilen darfst. Ein Schlüssel mit aktivierter Abrechnung vermeidet dies.

Kosten hängen von Modell und Dateiauswahl ab; kleinere Modelle (Claude Haiku, GPT mini, Gemini Flash) kosten einen Bruchteil großer Modelle. Setze beim Anbieter ein Ausgabenlimit. Blöcke rufen nie einen KI-Anbieter auf.

Zugriffskontrolle (optional)

Standardmäßig dürfen nur Confluence-Administratoren CodeDoc nutzen. Für andere öffne Settings → Permissions (Einstellungen → Berechtigungen) und füge Confluence-Gruppen einer von zwei Rollen hinzu:

  • Administrator: alles einschließlich Verbindungen, Repositories, Settings und Permissions.
  • Job Operator: richtet Blöcke ein und erstellt und startet KI-Seiten, darf Settings und Permissions aber nicht ändern.

Verwalte die Gruppenmitglieder in Confluence (Confluence administration → Groups); Ein- oder Austritte benötigen keine App-Änderung. Tipp: eine Gruppe wie codedoc-ai-operators für Job Operators. Seitenblöcke sind für alle Seitenleser sichtbar.

Nächste Schritte

  • Übersicht zeigt Blöcke, KI-Seiten und Handlungsbedarf auf einen Blick.
  • Synchronisierungsblöcke listet als Registerkarte jeden Block mit Seite, Quelle und Status; Update now (Jetzt aktualisieren) aktualisiert einen Block.
  • AI pages → New AI page (KI-Seiten → Neue KI-Seite) führt durch vier Schritte: Quelldateien, Inhalt (Stil, Sprache), Zielseite und Aktualisierungszeitpunkt.
  • Settings → Webhook (Einstellungen → Webhook) richtet Push-Aktualisierungen ein (erstelle dort zuerst das Webhook-Geheimnis).

Alle Details stehen in der Dokumentation. Fragen: support@janekbehrens.de.

Dokumentation · Support · Datenschutzerklärung · Impressum