Creează GitHub App
Acest ghid îți arată cum să îi dai serverului tău propria GitHub App. Durează aproximativ două minute, o face doar proprietarul serverului și trebuie făcut o singură dată per server.
Pentru autentificarea în propriul cont după aceea, vezi Configurează integrarea GitHub.
Ce face aplicația
Secțiune intitulată „Ce face aplicația”O singură înregistrare răspunde la două sarcini diferite:
| Sarcină | Ce răspunde | De ce contează |
|---|---|---|
| O persoană se autentifică | Client id-ul și client secret-ul aplicației | Fiecare primește propria acreditare GitHub, pe server, pe fiecare dispozitiv |
| Serverul acționează | Id-ul aplicației și cheia privată | Agenții, pipeline-urile, interogatorii și răspunsurile botului primesc tokenuri pentru câte un singur depozit |
A doua sarcină nu împrumută niciodată întreaga acreditare a unei persoane. Fiecare token pe care îl emite serverul acoperă un singur depozit și este limitat la ce poate face acolo un membru responsabil. Citirea unui depozit legat are nevoie doar de aplicație; orice scrie are nevoie de un membru care poate face push. Automatizarea nu aprobă niciodată un pull request.
Aplicația proprie a serverului se aplică doar sub Folosește aplicațiile mele. Cu Control Center Connect sau cu un Connect propriu, Connect gestionează toate benzile, inclusiv GitHub; aplicația serverului rămâne salvată, dar nefolosită, până treci înapoi. Un spațiu de lucru pe propriile aplicații (Dă unui spațiu de lucru propria aplicație) folosește aplicația proprie în locul celei a serverului, indiferent de modul serverului. O aplicație căreia îi lipsesc unele câmpuri este o eroare, nu o revenire la alternativă: autentificările GitHub sunt refuzate până când fiecare câmp este setat.
Cerințe preliminare
Secțiune intitulată „Cerințe preliminare”- Ești proprietarul serverului. Cardul Aplicații provider este invizibil pentru toți ceilalți
- Un cont GitHub. Aplicația este creată sub el
- O adresă a serverului pe care browserul tău o poate accesa. URL-ul public al serverului (sau loopback, pentru serverul propriu al unui desktop) este locul în care te trimite GitHub înapoi
Creeaz-o dintr-un singur clic
Secțiune intitulată „Creeaz-o dintr-un singur clic”- Mergi la Setări → Server → Autentificare unică și derulează până la cardul Aplicații provider
- În blocul GitHub, poți tasta opțional organizația GitHub care ar trebui să dețină aplicația în Organizație (opțional). Lasă câmpul gol ca să creezi aplicația sub propriul cont; crearea ei sub o organizație necesită un proprietar al acelei organizații
- Apasă Creează aplicația mea GitHub
- Browserul deschide GitHub cu aplicația deja completată. Apasă Create GitHub App
- GitHub te trimite înapoi la server, care stochează id-ul aplicației, cheia privată, client id-ul și client secret-ul, apoi deschide pagina de instalare a aplicației
Nimic nu se copiază de mână, iar codul de conversie merge direct de la GitHub la serverul tău. Linkul funcționează o singură dată și expiră după zece minute; dacă expiră, apasă din nou Creează aplicația mea GitHub.
Aplicația se numește Control Center <code> și cere exact ce folosește Control
Center:
| Permisiune | Acces |
|---|---|
| Metadata | Citire |
| Contents | Citire și scriere |
| Pull requests | Citire și scriere |
| Issues | Citire și scriere |
| Checks, Actions, Commit statuses | Citire |
| Organization members | Citire |
Webhook-urile sunt dezactivate: serverul interoghează periodic. Ca să muți mai târziu într-o organizație o aplicație creată sub propriul cont, folosește Transfer ownership din setările avansate ale aplicației pe GitHub.
Punct de control: blocul GitHub afișează „Serverul poate acționa ca el însuși, iar oamenii se pot autentifica.”
Instaleaz-o acolo unde sunt depozitele tale
Secțiune intitulată „Instaleaz-o acolo unde sunt depozitele tale”O aplicație înregistrată, dar neinstalată, poate autentifica oameni și nu poate citi nimic.
- Pe pagina de instalare pe care a deschis-o GitHub, alege contul sau organizația care deține depozitele tale
- Alege All repositories sau selectează depozitele pe care acest server ar trebui să le vadă
Ca să o instaleze mai târziu pe alt cont, un administrator al spațiului de lucru merge la Setări → Spațiu de lucru → Integrări, găsește Instalări ale aplicației GitHub pe cardul Aplicația GitHub, din Găzduire de cod, și apasă Instalează aplicația GitHub. Lista arată fiecare cont pe care este instalată aplicația și semnalează o instalare suspendată.
Împarte instalarea unei organizații
Secțiune intitulată „Împarte instalarea unei organizații”O organizație instalează GitHub App o singură dată. După aceea, oricine din ea care se autentifică în GitHub pe un server Control Center poate folosi instalarea, indiferent de server: al tău, al unui coleg sau al lui. Nu trebuie autorizat nimic pe fiecare server.
Fiecare token pe care îl primește un server este al persoanei autentificate, limitat la un singur depozit și la rolul ei în acel depozit, așa că nu ajunge mai departe decât ar putea ajunge ea pe GitHub. Jurnalul de audit al GitHub arată acea persoană, care acționează prin aplicație.
Ca să oprească accesul Control Center la o organizație, un proprietar al organizației elimină instalarea sau îi restrânge depozitele pe GitHub. Scoaterea unei persoane din organizație îi oprește și accesul.
Înregistreaz-o manual
Secțiune intitulată „Înregistreaz-o manual”Cardul Aplicații provider acceptă și valorile direct, pentru o aplicație pe care ai înregistrat-o singur:
| Grup | Câmpuri |
|---|---|
| Acționează ca serverul | App id și Cheie privată (întregul .pem, inclusiv liniile BEGIN și END) |
| Autentificarea oamenilor | Client id și Client secret. URL-uri de callback arată URL-ul de înregistrat, întocmai |
| Conversații de pull request | Login bot, rezolvat când testezi conexiunea |
Înregistrează URL-ul de callback <server origin>/oauth/github/callback exact
cum îl arată cardul, lasă Expire user authorization tokens activat și acordă
permisiunile din tabelul de mai sus. Apasă Test: întreabă GitHub pe ce
conturi este instalată aplicația, ca „salvat” și „funcționează” să nu fie
confundate.
Configureaz-o din .env-ul serverului
Secțiune intitulată „Configureaz-o din .env-ul serverului”Pentru o instalare headless sau prin script, serverul inițializează fiecare câmp
din fișierul său .env prima dată când nu are o valoare stocată:
GITHUB_APP_ID=123456GITHUB_CLIENT_ID=Iv23li0123456789abcdGITHUB_CLIENT_SECRET=<secret>GITHUB_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nMIIEow…\n-----END RSA PRIVATE KEY-----"Pune cheia pe un singur rând: o valoare din .env este un singur rând, iar
\n între ghilimele duble se decodează ca rând nou. Serverul refuză să pornească
atunci când GITHUB_APP_PRIVATE_KEY sau GITHUB_CLIENT_SECRET este exportat în
mediul procesului său, unde l-ar putea citi orice proces copil; păstrează-le în
fișierul .env (în Docker, montează-l la /app/bin/.env). Inițializarea are
loc o singură dată per câmp, așa că o editare în Setări nu este anulată de
următoarea repornire.
Dă unui spațiu de lucru propria aplicație
Secțiune intitulată „Dă unui spațiu de lucru propria aplicație”Un spațiu de lucru poate folosi o aplicație proprie în locul celei a serverului:
- Un administrator al spațiului de lucru merge la Setări → Spațiu de lucru → Integrări
- Pe cardul Control Center Connect, alege Folosește aplicațiile mele și apasă Aplică. Toți din spațiul de lucru se autentifică din nou prin aplicațiile spațiului de lucru
- Cardul Aplicația GitHub, din Găzduire de cod, are acum câmpurile aplicației: App id și Cheie privată sub Acționează pentru acest spațiu de lucru, Client id și Client secret sub Autentificarea oamenilor. Apasă Test odată ce sunt completate
Membrii se autentifică apoi în acea aplicație pentru acest spațiu de lucru. Un spațiu de lucru pe propriile aplicații nu revine niciodată la aplicația serverului sau la Connect: până când câmpurile lui sunt complete, munca lui pe GitHub este refuzată. Aceeași alegere acoperă Google Calendar, Linear și căutarea GIF, fiecare cu propriile câmpuri lângă furnizorul său, pe aceeași pagină. Vezi Dă unui spațiu de lucru propria aplicație Linear și Dă unui spațiu de lucru propriul client Google. Celelalte alegeri de pe acest card, și ce face fiecare, sunt în Alegerea pe spațiu de lucru.
Depanare
Secțiune intitulată „Depanare”Creează aplicația mea GitHub spune că serverul nu are nicio adresă
Secțiune intitulată „Creează aplicația mea GitHub spune că serverul nu are nicio adresă”Serverul nu are un URL public la care să se poată întoarce un browser. Setează
CC_SERVER_PUBLIC_URL (sau --public-url) și încearcă din nou.
GitHub spune că linkul a expirat
Secțiune intitulată „GitHub spune că linkul a expirat”Pagina de unică folosință a fost deja folosită sau au trecut zece minute. Pornește din nou din Setări.
Testul spune că datele de autentificare funcționează, dar aplicația nu este instalată nicăieri
Secțiune intitulată „Testul spune că datele de autentificare funcționează, dar aplicația nu este instalată nicăieri”Înregistrarea și instalarea sunt pași separați. Deschide pagina de instalare a aplicației sau folosește Instalează aplicația GitHub din Spațiu de lucru → Integrări.
Testul spune că cheia privată nu a putut fi citită
Secțiune intitulată „Testul spune că cheia privată nu a putut fi citită”Lipește tot fișierul .pem, inclusiv liniile -----BEGIN și -----END. O cheie
ed25519 sau EC nu poate fi folosită: GitHub Apps semnează cu RSA.
Un membru s-a autentificat, dar nu vede niciun depozit
Secțiune intitulată „Un membru s-a autentificat, dar nu vede niciun depozit”Aplicația nu este instalată pe contul care le deține sau instalarea ei selectează alte depozite. O autentificare acordă doar ce are voie să vadă aplicația.
Agenții spun că instalarea GitHub App este suspendată
Secțiune intitulată „Agenții spun că instalarea GitHub App este suspendată”Cineva a suspendat instalarea pe GitHub. Anulează suspendarea în Settings → Applications → Installed GitHub Apps al contului respectiv.