Prehľad

Túto príručku použite, ak ste správca pracovného priestoru ChatGPT a nastavujete šablónu aplikácie GitHub Enterprise pre svoju organizáciu. Šablóna nie je finálna aplikácia, ktorú členovia používajú. Je to postup nastavenia, ktorý po zadaní požadovanej konfigurácie GitHub Enterprise vytvorí koncept aplikácie špecifický pre pracovný priestor.

Pre GitHub Enterprise nastavenie pripojí ChatGPT k hostiteľovi GitHub Enterprise vašej organizácie. Vytvoríte aplikáciu GitHub App, zaregistrujete URL adresu spätného volania ChatGPT, vygenerujete prihlasovacie údaje a potom tieto hodnoty vložíte do postupu nastavenia šablóny ChatGPT. Keď ChatGPT vytvorí koncept aplikácie, môžete ho publikovať a spravovať ako ostatné aplikácie pracovného priestoru.

Čo nastavujete

V ChatGPT vytvárate aplikáciu GitHub Enterprise špecifickú pre pracovný priestor. Aplikácia používa:

• Aplikáciu GitHub App zaregistrovanú na vašom hostiteľovi GitHub Enterprise.

• ID klienta a tajný kľúč klienta aplikácie GitHub App pre autorizáciu používateľov cez OAuth.

• Súkromný kľúč aplikácie GitHub App, aby ChatGPT mohol vydávať inštalačné tokeny pre operácie s repozitármi.

• Tajný kľúč webhooku a URL adresu webhooku, aby GitHub Enterprise mohol odosielať udalosti inštalácie a repozitára späť do ChatGPT.

• Názov hostiteľa GitHub Enterprise, napríklad github.example.com.

Vytvorte aplikáciu GitHub App, nie samostatnú aplikáciu GitHub OAuth App. Nastavenie šablóny ChatGPT vyžaduje prihlasovacie údaje aplikácie GitHub App, súkromný kľúč a nastavenia webhooku.

Skôr než začnete

Potrebujete:

• Prístup správcu alebo vlastníka pracovného priestoru ChatGPT.

• Prístup správcu GitHub Enterprise alebo vlastníka organizácie, ktorý môže vytvárať a inštalovať aplikácie GitHub Apps.

• Iba názov hostiteľa GitHub Enterprise, bez https:// alebo cesty.

• Rozhodnutie, ktoré akcie repozitára má ChatGPT podporovať, napríklad vyhľadávanie repozitárov iba na čítanie, workflowy žiadostí o zlúčenie, workflowy problémov, úpravy súborov, GitHub Actions alebo širšie workflowy Codex.

• Bezpečné miesto na prácu so súkromným kľúčom aplikácie GitHub App a tajným kľúčom klienta.

Nechajte ChatGPT a GitHub Enterprise otvorené na samostatných kartách. URL adresu spätného volania si nevymýšľajte. Skopírujte presnú URL adresu spätného volania zobrazenú v ChatGPT.

Hodnoty na prípravu

• Názov hostiteľa GitHub Enterprise: napríklad github.example.com.

• URL adresa spätného volania: skopírujte ju z postupu nastavenia šablóny ChatGPT.

• ID klienta aplikácie GitHub App.

• Tajný kľúč klienta aplikácie GitHub App.

• PEM súkromného kľúča aplikácie GitHub App.

• Tajný kľúč webhooku vygenerovaný službou ChatGPT.

• URL adresa webhooku vygenerovaná po vytvorení konceptu aplikácie v ChatGPT.

Spustite nastavenie šablóny v ChatGPT

1. V ChatGPT prepnite na pracovný priestor, v ktorom má byť aplikácia dostupná.

2. Otvorte Nastavenia pracovného priestoru > Aplikácie.

3. Vyberte Adresár.

4. Vyhľadajte GitHub Enterprise.

5. Vyberte šablónu aplikácie GitHub Enterprise a spustite nastavenie.

6. Zadajte jasný názov a opis aplikácie, napríklad GitHub Enterprise alebo GitHub Enterprise – Engineering.

7. Zadajte názov hostiteľa GitHub Enterprise, napríklad github.example.com.

8. Skopírujte URL adresu spätného volania zobrazenú v ChatGPT. Nechajte túto kartu otvorenú.

9. Skopírujte vygenerovaný tajný kľúč webhooku, ak sa počas nastavenia zobrazí.

Príklad URL adresy spätného volania: https://chatgpt.com/connector/oauth/<callback_id>

Neodstraňujte ID spätného volania, nepridávajte koncovú lomku ani ho nenahrádzajte všeobecnou URL adresou ChatGPT.

Vytvorte aplikáciu GitHub App v GitHub Enterprise

1. Otvorte svojho hostiteľa GitHub Enterprise, napríklad https://github.example.com.

2. Prejdite do organizácie alebo účtu, ktorý má aplikáciu vlastniť.

3. Otvorte Settings > Developer settings > GitHub Apps.

4. Vyberte New GitHub App.

5. Zadajte jasný názov aplikácie, napríklad ChatGPT GitHub Enterprise Connector.

6. Zadajte URL adresu domovskej stránky. Ak neexistuje vyhradená interná stránka, použite URL adresu organizácie GitHub Enterprise.

7. Do poľa Callback URL vložte presnú URL adresu spätného volania skopírovanú z ChatGPT.

8. Ponechajte možnosť Expire user authorization tokens zapnutú, pokiaľ váš bezpečnostný tím nemá konkrétny dôvod ju zmeniť.

9. Zapnite možnosť Request user authorization during installation, aby používatelia mohli autorizovať aplikáciu počas inštalácie alebo pripojenia.

10. V časti Where can this GitHub App be installed?, vyberte najužšiu možnosť, ktorá vyhovuje vášmu zavedeniu.

11. Vytvorte aplikáciu GitHub App.

Nakonfigurujte povolenia a udalosti

Vyberte minimálne povolenia potrebné pre akcie ChatGPT, ktoré plánujete povoliť.

Pre zisťovanie repozitárov a otázky a odpovede iba na čítanie začnite povoleniami na čítanie, napríklad:

• Metadata: iba na čítanie. GitHub vyžaduje metadáta pre aplikácie GitHub Apps.

• Contents: iba na čítanie, pre prístup k súborom a obsahu repozitára.

• Issues: iba na čítanie, ak je potrebné vyhľadávanie alebo čítanie problémov.

• Pull requests: iba na čítanie, ak je potrebné vyhľadávanie žiadostí o zlúčenie alebo kontext kontroly.

• Actions: iba na čítanie, ak sú potrebné stavy spustení workflowov, úlohy, denníky alebo artefakty.

Pre workflowy so zápisom pridajte povolenia na zápis len tam, kde sú potrebné, napríklad Contents, Pull requests, Issues, Actions alebo Workflows. Použite najužšie povolenia, ktoré podporujú zamýšľané akcie ChatGPT.

Udalosti webhookov by mali zodpovedať workflowom, ktoré podporujete. Bežné udalosti zahŕňajú Installation, Installation repositories, Push, Pull request, Issues, Issue comment, Workflow run a Workflow job.

Vygenerujte a skopírujte prihlasovacie údaje aplikácie GitHub App

1. V nastaveniach aplikácie GitHub App skopírujte Client ID.

2. Vygenerujte Client secret a okamžite ho skopírujte.

3. V časti Private keys vygenerujte súkromný kľúč.

4. Stiahnite súbor .pem a bezpečne ho uložte.

5. Otvorte súbor .pem lokálne a skopírujte celý text PEM vrátane úvodného a koncového riadka.

Súkromný kľúč je citlivý. Zaobchádzajte s ním ako s prihlasovacím údajom. Ak sa prezradí, vygenerujte nový súkromný kľúč, aktualizujte nastavenie aplikácie ChatGPT a odstráňte kompromitovaný kľúč v GitHub Enterprise.

Dokončite nastavenie v ChatGPT

1. Vráťte sa na kartu nastavenia šablóny ChatGPT.

2. Vložte Client ID aplikácie GitHub App do poľa OAuth client ID.

3. Vložte Client secret aplikácie GitHub App do poľa OAuth client secret.

4. Ponechajte Scopes nezmenené, pokiaľ vaša organizácia zámerne nepotrebuje prepísať predvolené hodnoty šablóny.

5. Potvrďte, že názov hostiteľa GitHub Enterprise obsahuje iba názov hostiteľa, napríklad github.example.com.

6. Vložte alebo nahrajte PEM súkromného kľúča aplikácie GitHub App do poľa GitHub App private key.

7. Potvrďte, že vygenerovaný tajný kľúč webhooku je prítomný.

8. Vytvorte koncept aplikácie.

9. Otvorte podrobnosti vytvoreného konceptu aplikácie v ChatGPT a skopírujte vygenerovanú URL adresu webhooku.

URL adresa webhooku by mala vyzerať takto: https://connectors.api.openai.org/connectors/<connector_id>/webhook

Dokončite nastavenie webhooku v GitHub Enterprise

1. Vráťte sa do nastavení aplikácie GitHub App v GitHub Enterprise.

2. Otvorte všeobecné nastavenia aplikácie GitHub App.

3. Zapnite Active webhooks, ak ešte nie sú zapnuté.

4. Vložte URL adresu webhooku ChatGPT do poľa Webhook URL.

5. Vložte tajný kľúč webhooku ChatGPT do poľa Webhook secret.

6. Ponechajte overovanie SSL zapnuté.

7. Potvrďte, že odoberané udalosti webhooku zodpovedajú povoleniam a akciám, ktoré ste povolili.

8. Uložte zmeny.

Publikujte a spravujte aplikáciu v ChatGPT

Vytvorenie konceptu aplikácie ju automaticky nesprístupní členom. Po kontrole konceptu:

1. Publikujte koncept aplikácie.

2. Potvrďte, že sa aplikácia zobrazuje v časti Nastavenia pracovného priestoru > Aplikácie > Povolené.

3. Nakonfigurujte Prístup používateľov pre roly, ktoré ju majú používať.

4. Skontrolujte Riadenie akcií pre akcie čítania a zápisu.

5. Skontrolujte Povolenia aplikácie a vyberte, kedy sa má ChatGPT opýtať členov pred použitím aplikácie.

6. Požiadajte povoleného testovacieho používateľa, aby otvoril Aplikácie v ChatGPT a potvrdil, že sa aplikácia zobrazuje.

Tieto povolenia aplikácie sa vzťahujú na konverzácie ChatGPT. Agenti pracovného priestoru používajú ovládacie prvky pre jednotlivých agentov nastavené tvorcom agenta na určenie, ktoré akcie aplikácie sú dostupné a kedy sú koncoví používatelia požiadaní o ich schválenie. Informácie o správaní agentov nájdete tu: Agenti pracovného priestoru ChatGPT pre Enterprise a Business.

Nainštalujte a otestujte aplikáciu GitHub App

1. V GitHub Enterprise nainštalujte aplikáciu GitHub App v organizácii alebo účte.

2. Vyberte všetky repozitáre alebo vybrané repozitáre podľa pravidiel pracovného priestoru.

3. Spustite tok pripojenia z ChatGPT ako povolený používateľ.

4. Po výzve autorizujte aplikáciu GitHub App.

5. Najprv spustite malú akciu čítania, napríklad výpis dostupných repozitárov alebo načítanie známej žiadosti o zlúčenie.

6. Ak sú povolené akcie zápisu, pred širším zavedením ich otestujte v nízkorizikovom repozitári.

Názov hostiteľa a správanie OAuth

ChatGPT používa názov hostiteľa na odvodenie koncových bodov GitHub Enterprise. Zadajte iba hostiteľa, napríklad github.example.com alebo octocorp.ghe.com.

Nezadávajte cestu API, cestu repozitára ani github.com, pokiaľ to nie je presný hostiteľ GitHub Enterprise pre túto aplikáciu.

Riešenie problémov

• Nesúlad URI presmerovania: potvrďte, že URL adresa spätného volania aplikácie GitHub App sa presne zhoduje s URL adresou spätného volania zobrazenou v ChatGPT.

• ChatGPT nemôže vytvoriť alebo uložiť koncept aplikácie: potvrďte, že sú vyplnené všetky povinné polia vrátane názvu hostiteľa, OAuth client ID, OAuth client secret, súkromného kľúča a tajného kľúča webhooku.

• Autentifikácia je úspešná, ale volania repozitára zlyhávajú: potvrďte, že aplikácia GitHub App je nainštalovaná a má prístup k repozitáru.

• API vracia 403 alebo nedostatočné povolenia: pridajte chýbajúce povolenie aplikácie GitHub App a požiadajte vlastníka inštalácie, aby schválil aktualizované povolenia, ak sa zobrazí výzva.

• Nezobrazujú sa žiadne repozitáre: potvrďte, že inštalácia aplikácie zahŕňa očakávané repozitáre a používateľ autorizujúci v ChatGPT k nim má prístup.

• Doručenia webhooku zlyhávajú: potvrďte, že URL adresa webhooku a tajný kľúč webhooku zodpovedajú hodnotám z ChatGPT, ponechajte overovanie SSL zapnuté a uistite sa, že hostiteľ GitHub Enterprise môže dosiahnuť connectors.api.openai.org.

• Chyby súkromného kľúča: potvrďte, že bol skopírovaný celý obsah PEM vrátane úvodného a koncového riadka.

Referencie

• Dokumentácia GitHub: Registrácia aplikácie GitHub App

• Dokumentácia GitHub: O URL adrese spätného volania autorizácie používateľa

• Dokumentácia GitHub: Výber povolení pre aplikáciu GitHub App

• Dokumentácia GitHub: Používanie webhookov s aplikáciami GitHub Apps

• Dokumentácia GitHub: Správa súkromných kľúčov pre aplikácie GitHub Apps