Informationen zu Geheimnissen
Geheimnisse der Entwicklungsumgebung sind encrypted Umgebungsvariablen, die du in den GitHub Codespaces-Einstellungen für eine Organisation, ein Repository oder ein persönliches Konto erstellen. Weitere Informationen zum Erstellen von benutzerspezifischen Geheimnissen findest du unter Verwalten von Geheimnissen für Codespaces.
Die von dir erstellten Geheimnisse können in GitHub Codespaces verwendet werden. Mithilfe einer Libsodium Sealed Box verschlüsselt GitHub Geheimnisse, bevor sie GitHub erreichen. Erst für die Verwendung in einem Codespace werden die Geheimnisse wieder entschlüsselt.
Geheimnisse auf Organisationsebene ermöglichen es Ihnen, Geheimnisse zwischen mehreren Repositorys zu teilen, was die Notwendigkeit zur Erstellung von doppelten Geheimnissen verringert. Du kannst Zugriffsrichtlinien verwenden, um zu steuern, welche Repositorys Organisationsgeheimnisse verwenden können.
Nachdem du ein Geheimnis erstellt hast, ist es verfügbar, wenn du einen neuen Codespace erstellst oder den Codespace neu startest. Wenn du für GitHub.com ein Geheimnis erstellt hast, das du in einem derzeit ausgeführten Codespace ausführen möchtest, beende den Codespace, und starte ihn neu. Informationen zum Beenden des Codespace findest du unter Verwenden der Visual Studio Code-Befehlspalette in GitHub Codespaces.
Benennen von Geheimnissen
Für Geheimnisnamen gelten folgende Regeln:
-
Geheimnisnamen dürfen nur alphanumerische Zeichen (
[a-z],[A-Z],[0-9]) oder Unterstriche (_) enthalten. Leerzeichen sind nicht zulässig. -
Geheimnisnamen dürfen nicht mit dem Präfix
GITHUB_beginnen. -
Geheimnisnamen dürfen nicht mit einer Ziffer beginnen.
-
Bei Geheimnisnamen wird nicht zwischen Groß- und Kleinschreibung unterschieden.
-
Geheimnisnamen müssen auf der Ebene eindeutig sein, auf der sie erstellt werden. So muss beispielsweise ein auf Repositoryebene erstelltes Geheimnis einen eindeutigen Namen in diesem Repository haben, und ein auf Organisationsebene erstelltes Geheimnis muss einen eindeutigen Namen auf dieser Ebene aufweisen.
Wenn ein Geheimnis mit demselben Namen auf mehreren Ebenen vorhanden ist, erhält das Geheimnis auf der niedrigsten Ebene Vorrang. Wenn beispielsweise ein Geheimnis auf Organisationsebene denselben Namen wie ein Geheimnis auf Repositoryebene aufweist, erhält das Geheimnis auf Repositoryebene Vorrang.
Einschränkungen für Geheimnisse
Du kannst bis zu 100 Geheimnisse pro Organisation und 100 Geheimnisse pro Repository speichern.
Geheimnisse sind auf 48 KB beschränkt.
Empfohlene Geheimnisse für ein Repository
Möglicherweise erfordert dein Projekt bestimmte Benutzergeheimnisse. So müssen Benutzerinnen z. B. einen persönlichen API-Schlüssel bereitstellen, um die Anwendung in einem Codespace ausführen zu können. In diesem Fall kannst du in der Konfiguration des Entwicklungscontainers empfohlene Geheimnisse angeben. Die Benutzerinnen werden dann aufgefordert, Werte für diese Geheimnisse anzugeben, wenn sie diese noch nicht beim Erstellen eines Codespaces auf der Seite „Erweiterte Optionen“ erstellt haben. Stellen Benutzer*innen einen Geheimniswert für die Verwendung im Codespace bereit, wird dieses Geheimnis den persönlichen Einstellungen für Codespaces hinzugefügt. Beim Erstellen eines Codespaces für dieses Repository muss künftig dann kein Wert mehr für dieses Geheimnis eingegeben werden. Weitere Informationen findest du unter Angeben empfohlener Geheimnisse für ein Repository.
Hinzufügen von Geheimnissen für ein Repository
Um Geheimnisse der Entwicklungsumgebung für ein Organisationsrepository zu erstellen, musst du über Administratorzugriff verfügen.
-
Navigiere auf GitHub.com zur Hauptseite des Repositorys.
-
Wähle unter dem Namen deines Repositorys die Option Einstellungen aus. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.
-
Wählen Sie im Abschnitt „Sicherheit“ der Seitenleiste Geheimnisse und Variablen, dann klicken Sie auf Codespaces.
-
Klicke oben auf der Seite auf Neues Repositorygeheimnis.
-
Gib einen Namen für dein Geheimnis in das Eingabefeld Name ein.
-
Gib den Wert für das Geheimnis ein.
-
Klicke auf Geheimnis hinzufügen.
Hinzufügen von Geheimnissen für eine Organisation
Beim Erstellen eines Geheimnisses einer Entwicklungsumgebung in einer Organisation kannst du mit einer Richtlinie einschränken, welche Repositorys darauf zugreifen können. Du kannst beispielsweise allen Repositorys Zugriff gewähren oder nur private Repositorys oder eine angegebene Liste von Repositorys zulassen.
Für das Erstellen von Geheimnissen auf Organisationsebene benötigst du admin-Zugriff.
-
Navigiere auf GitHub.com zur Hauptseite der Organisation.
-
Klicke unter deinem Organisationsnamen auf die Option Einstellungen. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.
-
Wählen Sie im Abschnitt „Sicherheit“ der Seitenleiste Geheimnisse und Variablen, dann klicken Sie auf Codespaces.
-
Klicke oben auf der Seite auf Neues Geheimnis.
-
Gib einen Namen für dein Geheimnis in das Eingabefeld Name ein.
-
Gib den Wert für das Geheimnis ein.
-
Wähle in der Dropdownliste Repositoryzugriff eine Zugriffsrichtlinie aus.
-
Klicke auf Geheimnis hinzufügen.
Überprüfen des Zugriffs auf Organisationsgeheimnisse
Du kannst überprüfen, welche Zugriffsrichtlinien auf ein Geheimnis einer Entwicklungsumgebung in deiner Organisation angewendet werden.
-
Navigiere auf GitHub.com zur Hauptseite der Organisation.
-
Klicke unter deinem Organisationsnamen auf die Option Einstellungen. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.
-
Wählen Sie im Abschnitt „Sicherheit“ der Seitenleiste Geheimnisse und Variablen, dann klicken Sie auf Codespaces.
-
Die Liste der Geheimnisse enthält alle konfigurierten Berechtigungen und Richtlinien. Beispiel:
-
Klicke auf Aktualisieren, um weitere Details zu den konfigurierten Berechtigungen des jeweiligen Geheimnisses anzuzeigen.
