GitHub-Deploy-Key auf einem VPS

Ein Deploy-Key mit reinem Lesezugriff, damit ein VPS ohne Personal Access Token und ohne Passwort von GitHub pullen kann.

Beim ersten git pull auf dem VPS, um ein Update auszurollen, hat GitHub die Tür zugeschlagen:

Invalid username or token. Password authentication is not supported

Einen Personal Access Token auf den Server zu kopieren hat einmal funktioniert, fühlte sich aber falsch an. Tokens laufen ab, landen in der Shell-History und binden den Deploy an den Account eines Menschen. Ein SSH-Deploy-Key löst alle drei Probleme. So richte ich seitdem jeden Deploy ein, der per Pull läuft.

Einen eigenen SSH-Schlüssel auf dem VPS erzeugen

Ein Schlüssel, der nur auf diesem VPS liegt, mit einer Beschriftung, an der ich ihn später in GitHub wiedererkenne:

mkdir -p ~/.ssh && chmod 700 ~/.ssh
ssh-keygen -t ed25519 -C "vps-website" -f ~/.ssh/id_ed25519 -N ""
chmod 600 ~/.ssh/id_ed25519
chmod 644 ~/.ssh/id_ed25519.pub
cat ~/.ssh/id_ed25519.pub

Ed25519 statt RSA, weil die Schlüssel kürzer und schneller sind und GitHub sie seit Jahren unterstützt. Den ausgegebenen öffentlichen Schlüssel kopierst du für den nächsten Schritt.

Den Schlüssel als Deploy-Key eintragen

Im Repository auf GitHub: Settings, Deploy keys, Add deploy key.

Ich lasse ihn bei reinem Lesezugriff, solange der VPS nicht pushen muss, und bei Deploys per Pull muss er das nie. Ein Deploy-Key mit Lesezugriff ist weniger gefährlich als ein Personal Access Token: Er gilt für ein einziges Repository, öffnet nichts anderes und läuft nicht ab.

Den Host-Keys von GitHub vertrauen

Wenn GitHub vorab in known_hosts steht, fragt das erste git clone in einem Deploy-Skript ohne Eingabe nicht nach „Are you sure?“:

ssh-keyscan github.com >> ~/.ssh/known_hosts
chmod 644 ~/.ssh/known_hosts

Den SSH-Zugang testen

ssh -T git@github.com

Ein freundliches „Hi <repo>! You've successfully authenticated…“ heißt: Der Schlüssel funktioniert. Scheitert es hier, behebst du das, bevor du das Remote des Repositorys anfasst.

Das Remote von HTTPS auf SSH umstellen

cd /opt/website
git remote set-url origin git@github.com:adrian-altner/website.git
git remote -v
git fetch
git pull

Ab jetzt braucht kein Deploy mehr eine Anmeldung von Hand.

Optional: eine eigene SSH-Config

Für Hosts mit mehreren Schlüsseln oder überall, wo „nur dieser Schlüssel für diesen Host“ gelten soll:

# ~/.ssh/config
Host github.com
  HostName github.com
  User git
  IdentityFile ~/.ssh/id_ed25519
  IdentitiesOnly yes
chmod 600 ~/.ssh/config

IdentitiesOnly yes ist die wichtige Zeile. Ohne sie bietet ssh erst jeden Schlüssel an, den der Agent kennt, und genau das führt auf Rechnern mit mehr als ein paar Schlüsseln zu „too many authentication failures“.

Schnelle Fehlersuche

  • Permission denied (publickey): Der Schlüssel hängt nicht am richtigen Repository oder Account. Schau bei den Deploy-Keys des Repositorys nach, nicht bei deinen persönlichen SSH-Keys.
  • Repository not found: meist ein Tippfehler in der Remote-URL, oder der Deploy-Key hängt an einem anderen Repository als gedacht.
  • Host key verification failed: In known_hosts fehlt der Eintrag für GitHub. ssh-keyscan github.com >> ~/.ssh/known_hosts noch einmal ausführen.

Zum Mitnehmen

  • Ein Deploy sollte an der Identität einer Maschine hängen, nicht an einem Passwort, das ein Mensch eintippt.
  • IdentitiesOnly yes spart auf Rechnern mit mehreren SSH-Identitäten Stunden der Fehlersuche.

Mehr dazu

Thema
  • Self-Hosting Dienste auf einem Server betreiben, über den du selbst verfügst, statt die gehostete Fassung eines Anbieters zu nutzen.
Siehe auch
  • GitHub nach Codeberg spiegeln Ein GitHub-Actions-Workflow, der Branches und Tags mit einfachem git push über SSH nach Codeberg spiegelt, ohne Action von Dritten.
Schlagwörter

In der Graph-Ansicht zeigen →