GitHub-integration

Anslut din egenvärdade Status200 till GitHub med en GitHub App som du själv äger. När appen har installerats från Status200 importeras installationens repositories till ditt projekt och hålls synkroniserade, AI-korrigeringsuppgifter öppnar pull requests, och ditt team kan ge appen uppgifter från GitHub genom att nämna den.

Den här sidan är till för den som driver Status200-servern: du skapar appen en gång, och sedan ansluter varje projekt den från Kod.

Så fungerar det#

Installationen börjar i Status200, inte på GitHub: länken som Status200 skickar dig till GitHub med är det som knyter installationen till ditt projekt.

• Omdirigeringen i webbläsaren bär installationen och en OAuth-engångskod. Status200 byter koden för att bekräfta att GitHub-kontot som installerade appen administrerar installationen och importerar sedan dess repositories. En installation som redan finns ansluts i stället genom att logga in på GitHub: koden talar då om för Status200 vilka installationer kontot administrerar.
• Webhooks håller listan över repositories synkroniserad och ger appen uppgifter: omnämnanden, tilldelningar, utlösaretiketter och granskningsbegäranden. GitHub signerar var och en med webhook-hemligheten, och Status200 avvisar dem som den inte kan verifiera.

Innan du börjar#

• Ett GitHub-konto som kan skapa GitHub Apps för organisationen eller användaren som appen ska installeras på. För att installera den i en organisation måste du vara ägare till den eller få en ägare att godkänna begäran.
• Ett offentligt HTTPS-värdnamn för Status200 som GitHub kan nå för webhooks. Se Nätverksåtkomst.
• Åtkomst till serverns konfiguration: config.env för Docker Compose, eller dina Helm-values för Kubernetes.

Skapa GitHub-appen#

1. Öppna inställningarna för GitHub Apps#

   • För en organisation: https://github.com/organizations/YOUR_ORG/settings/apps
   • För ett personligt konto: https://github.com/settings/apps

   Välj New GitHub App.

2. Fyll i registreringsformuläret#

   Fält	Värde
   GitHub App name	Valfritt unikt namn, till exempel Status200. Anteckna det exakt: det är GITHUB_APP_NAME.
   Homepage URL	https://your-oneuptime-domain.com
   Callback URL	https://your-oneuptime-domain.com/api/github/auth/callback
   Request user authorization (OAuth) during installation	På. Den är obligatorisk: se anmärkningen nedan.
   Setup URL	https://your-oneuptime-domain.com/api/github/auth/callback, om GitHub låter dig ange en (se nedan).
   Redirect on update	Valfritt. När någon har ändrat en installation på GitHub tar Status200 dem till Kod.
   Webhook URL	https://your-oneuptime-domain.com/api/github/webhook, med webhooken satt till Active.
   Webhook secret	En lång slumpmässig sträng. Anteckna den: den är GITHUB_APP_WEBHOOK_SECRET. Obligatorisk: Status200 avvisar osignerade webhooks, så om GITHUB_APP_WEBHOOK_SECRET inte är satt stoppas synkroniseringen av repositories i stället för att overifierade nyttolaster godtas.

   Enligt GitHubs dokumentation kan du med Request user authorization (OAuth) during installation påslagen inte ange en Setup URL: användare skickas i stället till Callback URL efter att de har installerat appen. Båda pekar på samma Status200-adress, så omdirigeringen hamnar rätt i båda fallen.

   Viktigt

   Varför "Request user authorization (OAuth) during installation" är obligatorisk. Efter en installation omdirigerar GitHub tillbaka med ett installation_id i URL:en. Det numret ensamt bevisar ingenting om vem som äger installationen — vem som helst kan skriva in ett annat. Med det här alternativet påslaget returnerar GitHub också en OAuth-code för engångsbruk, kopplad till GitHub-kontot som utförde installationen, som Status200 byter för att bekräfta att kontot verkligen administrerar installationen innan den ansluts till ditt projekt.

   Utan det vägrar Status200 att ansluta installationen, och dashboarden visar ett fel som ber dig slå på inställningen. Det är avsiktligt: att godta installations-ID:t overifierat skulle låta ett Status200-projekt göra anspråk på en annan organisations repositories.

3. Ange behörigheterna#

   Ange de här Repository permissions under Permissions & events:

   Behörighet	Åtkomst	Vad Status200 använder den till
   Contents	Read and write	Läsa filer i repositoryt och pusha grenarna för AI-korrigeringarnas pull requests
   Pull requests	Read and write	Öppna och uppdatera pull requests och publicera granskningar
   Issues	Read and write	Publicera appens kommentarer — även på pull requests, vars konversation GitHub skickar via issues-API:t
   Checks	Read-only	Valfritt. Läsa CI-resultatet för korrigeringarnas pull requests. Utan den förblir deras CI-status overifierad
   Metadata	Read-only	Grundläggande metadata för repositoryt (krävs av GitHub)

   Det är Issues: Read and write som gör appen interaktiv. Utan den tas omnämnanden emot men misslyckas sedan tyst när appen försöker svara — GitHub levererar kommentarer i pull request-konversationer från issues-API:t, så den här enda behörigheten avgör varje svar som appen skriver. Se Arbeta med Status200 från GitHub.

   Status200 behöver inga behörigheter på organisations- eller kontonivå.

4. Prenumerera på webhook-händelser#

   Status200 använder två uppsättningar händelser, och de gör olika jobb.

   Synkronisering av repositories — installation och installation_repositories. GitHub Apps tar emot dessa automatiskt; de håller uppsättningen anslutna repositories i takt med var appen är installerad.

   Den interaktiva appen — dessa måste du prenumerera på uttryckligen, och var och en möjliggör ett visst sätt att ge appen uppgifter:

   Händelse	Vad den möjliggör
   Issue comment	@mention-kommandon i issues och i pull requests
   Issues	att tilldela appen en issue, och repositoryts utlösaretikett
   Pull request	att be appen om en granskning, och produktionsgranskningar av pull requests när de öppnas och ändras
   Pull request review	ett omnämnande i texten till en inskickad granskning
   Pull request review comment	ett omnämnande i en inbäddad kommentar i diffen

   Om du inte prenumererar på någon av dessa ansluter GitHub-appen fortfarande repositories och öppnar fortfarande korrigeringarnas pull requests från Status200 — den svarar bara aldrig på något som skrivs i GitHub. Det är den vanligaste orsaken till ”boten ignorerar mig”. Se Arbeta med Status200 från GitHub för vilka kommandona är och vem som får ge dem.

   Andra händelser (Push, Workflow run) kvitteras och ignoreras; att prenumerera på dem slår inte på aviseringar eller CI/CD-automatisering.

5. Välj var appen kan installeras#

   Välj under Where can this GitHub App be installed?:

   • Only on this account - För privat/intern användning
   • Any account - Om du vill att andra ska kunna installera din app

6. Skapa appen och anteckna dess ID:n#

   Välj Create GitHub App. GitHub öppnar appens inställningssida. Anteckna App ID högst upp på sidan och Client ID i avsnittet About.

7. Generera en client secret#

   Välj Generate a new client secret under Client secrets. Kopiera den direkt: GitHub visar den bara en gång.

8. Generera en privat nyckel#

   Välj Generate a private key under Private keys. GitHub laddar ned en .pem-fil. Förvara den säkert: den låter Status200 autentisera sig som appen.

Konfigurera Status200#

base64 < private-key.pem | tr -d '\n'

GITHUB_APP_ID=YOUR_APP_ID
GITHUB_APP_NAME=YOUR_APP_NAME
GITHUB_APP_CLIENT_ID=YOUR_CLIENT_ID
GITHUB_APP_CLIENT_SECRET=YOUR_CLIENT_SECRET
GITHUB_APP_PRIVATE_KEY=YOUR_BASE64_ENCODED_PRIVATE_KEY
GITHUB_APP_WEBHOOK_SECRET=YOUR_WEBHOOK_SECRET

gitHubApp:
  id: "YOUR_APP_ID"
  name: "YOUR_APP_NAME" # The exact name of your GitHub App
  clientId: "YOUR_CLIENT_ID"
  clientSecret: "YOUR_CLIENT_SECRET"
  privateKey: "<BASE64_ENCODED_PRIVATE_KEY_CONTENT>"
  webhookSecret: "YOUR_WEBHOOK_SECRET"

När Status200 är igång igen visar Kod knappen Anslut GitHub i stället för GitHub App är inte konfigurerad på den här servern.

Referens för miljövariabler#

Alla sex är obligatoriska.

Anslut repositories#

Starta anslutningen från Status200, inte från appens sida på GitHub: länken som Status200 skickar dig till GitHub med är det som knyter installationen till ditt projekt.

När appen redan är installerad på kontot, för ett annat projekt eller direkt från GitHub, ansluts den inte av att installera den igen: GitHub öppnar installationens inställningar och skickar aldrig tillbaka dig. Klicka i stället på Anslut en befintlig installation under Anslut GitHub. Du loggar in på GitHub, och Status200 ansluter installationen som ditt GitHub-konto administrerar. Administrerar det mer än en, visar Kod dem: välj kontot vars repositories projektet ska använda.

Vem som kan ansluta. Anslutningen importerar installationens repositories till projektet och kräver därför behörighet att lägga till kodrepositorier: Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, eller ett team med Create Code Repository. Ett team som blockerar behörigheten tar bort den. På Status200 Cloud kräver kodrepositorier Growth-abonnemanget eller högre. För alla andra är kortet låst och säger vad som krävs. På GitHub måste kontot som installerar eller ansluter appen administrera installationen: ägaren till ett personligt konto, eller någon med admin-behörighet till varje repository som installationen har åtkomst till, så som en ägare av organisationen har. Läsåtkomst till ett av dess repositories räcker inte.

Slutför inom 15 minuter, i samma webbläsare. Länken fungerar en gång, i 15 minuter, i webbläsaren som startade den. När GitHub skickar tillbaka dig kontrollerar Status200 behörigheten igen innan den importerar något.

Nätverksåtkomst för egenvärdade installationer#

Trafikriktning och slutpunkter#

Callbacken är en omdirigering i webbläsaren, medan webhooken är en begäran från GitHubs servrar. En användares VPN-anslutning ger inte GitHub åtkomst till webhooken. Domänerna ovan täcker integrationens kärnbegäranden; ytterligare verktyg för repositories, nedladdningar, LFS eller paket kan kräva andra mål. De här inställningarna beskriver GitHub.com; att ändra brandväggen konfigurerar inte stöd för värdnamnet till en GitHub Enterprise Server.

Privata installationer och säkerhet för callbacks#

Exponera /api/github/webhook via en offentlig gateway med offentlig DNS, ett offentligt betrott HTTPS-certifikat med fullständig kedja och en privat rutt till Status200s ingress. Tillåt inkommande TCP 443 till gatewayen och begränsa den offentliga vidarebefordringen till den här POST-rutten. Behåll dashboarden och webbläsarens callback på den privata ingressen om användarna når dem över VPN; med delad DNS kan samma värdnamn levereras internt och externt.

Ange HOST=status200.example.com och HTTP_PROTOCOL=https i config.env, eller host: status200.example.com och httpProtocol: https i Helm. Tillämpa konfigurationen och vänta tills Status200 har startat om. De här värdena genererar URL:er; de skapar inte DNS, TLS eller nätverksåtkomst. Om värdnamnet ändras uppdaterar du GitHub-appens URL:er för webhook, callback, setup och startsida.

Bevara metoden, den ursprungliga sökvägen, frågesträngen, bodyn, Content-Type, X-Hub-Signature-256, X-GitHub-Event och X-GitHub-Delivery. Bevara den offentliga värden och HTTPS-schemat via betrodda proxyhuvuden. Undanta webhooken från webbläsar-SSO, CAPTCHA och proxyns inloggningssidor. Låt GitHubs SSL-verifiering vara påslagen och konfigurera samma GITHUB_APP_WEBHOOK_SECRET i båda systemen: Status200 avvisar osignerade begäranden och kan inte validera webhooks utan den här hemligheten. Se GitHubs vägledning om validering av webhooks.

Om du också begränsar webhooks käll-IP:er använder du de aktuella hooks-intervallen från GitHubs Meta API och uppdaterar dem regelbundet; ersätt dem inte med intervallen för GitHub Actions-runners, och hoppa inte över signaturverifieringen. GitHub varnar för att deras adresser ändras och att den publicerade listan inte är fullständig.

Kontrollera åtkomsten och förstå begränsningarna#

GitHub dokumenterar felsökning av leveranser och kräver en 2xx-kvittering inom tio sekunder. En GET från webbläsaren mot webhooken testar inte en signerad POST.

Inställningen för åtkomst till privata nätverk styr utgående begäranden till privata mål och gör inte webhooken nåbar för GitHub.

Felsökning#

Anslutningen slutfördes inte#

När GitHub skickar tillbaka dig och installationen inte anslöts visar Kod meddelandet GitHub anslöts inte, med en mening på ditt språk som säger varför. Resten av sidan laddas som vanligt, så du kan ansluta igen direkt där. Den visar aldrig vad GitHub själv svarade: det står i Status200-serverns logg, tillsammans med orsaken.

Andra problem#

Bästa praxis för säkerhet#

• Rotera hemligheter regelbundet. Generera nya client secrets och privata nycklar med jämna mellanrum.
• Låt webhook-hemligheten vara angiven. Status200 avvisar webhooks som den inte kan verifiera.
• Begränsa åtkomsten till repositories. Ge installationen bara de repositories som behöver anslutas.
• Bevaka webhook-leveranser. Kontrollera regelbundet om det finns misslyckade leveranser eller misstänkt aktivitet.
• Håll privata nycklar utanför versionshanteringen.

Nästa steg#