Befehlszeilenwerkzeuge

Du kannst diese Befehle überall in der VM ausführen, nachdem du dich als ein SSH-Administratorbenutzer angemeldet hast. Weitere Informationen finden Sie unter Auf die Verwaltungsshell (SSH) zugreifen.

Alle Dienstprogramme akzeptieren -h oder --help, um Verwendungsinformationen anzuzeigen.

Allgemein

ghe-announce

Dieses Hilfsprogramm legt oben auf jeder GitHub Enterprise Seite ein Banner fest. Diesen kannst du verwenden, um deinen Benutzer eine Mitteilung zu übermitteln.

# Sets a message that's visible to everyone
$ ghe-announce -s MESSAGE
> Announcement message set.
# Removes a previously set message
$ ghe-announce -u
> Removed the announcement message

Damit jeder Benutzer die Ankündigung für sich selbst schließen kann, verwende die -d-Flagge.

# Sets a user-dismissible message that's visible to everyone
$ ghe-announce -d -s MESSAGE
> Announcement message set.
# Removes a previously set message
$ ghe-announce -u
> Removed the announcement message, which was user
> dismissible: MESSAGE

Sie können ein Ankündigungsbanner auch mithilfe der Unternehmenseinstellungen festlegen.GitHub Enterprise Server Weitere Informationen finden Sie unter Anpassen von Benutzernachrichten für dein Unternehmen.

ghe-aqueduct

Dieses Dienstprogramm zeigt Informationen zu aktiven und zu in der Warteschlange befindlichen Hintergrundaufträgen an. Es zeigt dieselben Auftragszählnummern wie die Leiste mit den Administratorstatistiken im oberen Bereich jeder Seite an.

Mit diesem Dienstprogramm kann ermittelt werden, ob der Aqueduct-Server beim Verarbeiten von Hintergrundaufträgen Probleme hat. Eines der folgenden Szenarien kann auf ein Problem mit Aqueduct hinweisen:

• Die Anzahl der Hintergrundaufträge wird erhöht, während die aktiven Aufträge identisch bleiben.
• Die Ereignis-Feeds werden nicht aktualisiert.
• Webhooks werden nicht ausgelöst.
• Die Weboberfläche wird nach einem Git-Push nicht aktualisiert.

Wenn Sie vermuten, dass Aqueduct fehlschlägt, besuchen Sie GitHub Enterprise-Support für Hilfe.

Mit diesem Befehl kannst du Aufträge in der Warteschlange zudem anhalten oder fortsetzen.

$ ghe-aqueduct status
# lists queues and the number of currently queued jobs
# for all queues
$ ghe-aqueduct queue_depth --queue QUEUE
# lists the number of currently queued jobs for the
# specified queue
$ ghe-aqueduct pause --queue QUEUE
# pauses the specified queue
$ ghe-aqueduct resume --queue QUEUE
# resumes the specified queue

ghe-aqueduct-info

Dieses Hilfsprogramm zeigt die Verteilung von in die Warteschlange eingereihten Hintergrundaufträgen an, zusammen mit den derzeit verarbeiteten Aufträgen.

ghe-aqueduct-info

Du kannst die folgenden Flags mit ghe-aqueduct-info verwenden.

ghe-check-disk-usage

Dieses Dienstprogramm überprüft den Datenträger auf große Dateien oder auf gelöschte Dateien mit weiterhin vorhandenen offenen Datei-Handles. Du solltest dieses ausführen, wenn du versuchst, auf der Root-Partition Speicherplatz freizugeben.

ghe-check-disk-usage

ghe-cleanup-caches

Dieses Dienstprogramm bereinigt eine Vielzahl von Caches auf dem Root-Volume, die potenziell zusätzlichen Speicherplatz beanspruchen. Wenn du feststellst, dass sich deine Root-Volume-Speicherplatzauslastung mit der Zeit merklich erhöht, empfiehlt es sich, dieses Dienstprogramm auszuführen, um nachzuvollziehen, ob es die Gesamtnutzung reduzieren kann.

ghe-cleanup-caches

ghe-cleanup-Einstellungen

Dieses Hilfsprogramm löscht alle vorhandenen Verwaltungskonsole Einstellungen.

ghe-cleanup-settings

ghe-config

Mit diesem Hilfsprogramm können Sie sowohl die Konfigurationseinstellungen von Ihre GitHub Enterprise Server-Instance abrufen als auch ändern.

$ ghe-config core.github-hostname
# Gets the configuration value of `core.github-hostname`
$ ghe-config core.github-hostname URL
# Sets the configuration value of `core.github-hostname`
# to the specified URL
$ ghe-config -l
# Lists all the configuration values

Ermöglicht es dir, den universellen eindeutigen Bezeichner (UUID) deines Knotens in cluster.conf zu finden.

  ghe-config HOSTNAME.uuid

Ermöglicht es dir, eine Liste mit Benutzern von REST-API-Ratenbegrenzungen auszuschließen. Für diese Benutzer gilt weiterhin eine feste Obergrenze von 120.000 Anfragen. Bei Benutzernamen, die für diesen Befehl angeben werden, wird die Groß- und Kleinschreibung beachtet. Weitere Informationen finden Sie unter Ratenbegrenzungen für die REST-API.

$ ghe-config app.github.rate-limiting-exempt-users "hubot github-actions[bot]"
# Exempts the users hubot and github-actions[bot] from rate limits.
# Usernames are case-sensitive.

ghe-config-apply

Dieses Hilfsprogramm wendet Verwaltungskonsole Einstellungen an, lädt Systemdienste neu, bereitet ein Speichergerät vor, lädt Anwendungsdienste neu und führt alle ausstehenden Datenbankmigrationen aus. Es entspricht dem Klicken auf " Speichern"-Einstellungen in der VerwaltungskonsoleWeb-UI oder dem Senden einer POST-Anforderung an den /manage/v1/config/apply Endpunkt. Ab Version 3.16 wendet dieses Hilfsprogramm Konfigurationsänderungen bedingt auf relevante Einstellungen an. Du kannst erzwingen, dass es bedingungslos ausgeführt wird, indem du das Flag -f verwendest.

ghe-config-apply

ghe-config-check

Dieses Hilfsprogramm überprüft GitHub Enterprise Server Konfigurationsdateien und überprüft einzelne Optionen.

ghe-config-check

So überprüfen Sie eine bestimmte Datei:

ghe-config-check /PATH/TO/github.conf

So geben Sie Ergebnisse im JSON-Format aus:

ghe-config-check json

So überprüfen Sie bestimmte Konfigurationsschlüssel:

ghe-config-check github-ssl.

Du kannst die folgenden Flags mit ghe-config-check verwenden.

ghe-crypto

Dieses Hilfsprogramm wird verwendet, um Kryptoeinstellungen für TLS- und SSH-Verbindungen zu überprüfen und auflisten Verwaltungskonsolegithub-ssl .

Die Liste der konfigurierbaren github-ssl Felder kann über ghe-crypto --helpangezeigt werden.

Auflisten von Standardchiffresammlungen und Algorithmen

Der list Befehl gibt standardmäßige Kryptoeinstellungen für ein bestimmtes Feld zurück. Verwenden Sie das -o json Flag, um die Ergebnisse im JSON-Format auszugeben.

Um TLS 1.2-Cipher-Suites aufzulisten:

ghe-crypto list tlsv12-ciphersuites

Um TLS 1.3-Cipher-Suites aufzulisten:

ghe-crypto list tlsv13-ciphersuites

So listen Sie SSH-Verschlüsselungen auf:

ghe-crypto list ssh-ciphers

Um SSH-MAC-Algorithmen aufzulisten:

ghe-crypto list ssh-mac-algorithms

So listen Sie SSH-Schlüsselaustauschalgorithmen auf:

ghe-crypto list ssh-kex-algorithms

So listen Sie SSH-Signaturtypen auf:

ghe-crypto list ssh-signature-types

Beispielausgabe im JSON-Format:

$ ghe-crypto list tlsv12-ciphersuites -o json
> [
>  "ECDHE-ECDSA-AES128-GCM-SHA256",
>  "ECDHE-ECDSA-CHACHA20-POLY1305",
>  "ECDHE-ECDSA-AES256-GCM-SHA384",
>  "ECDHE-RSA-AES128-GCM-SHA256",
>  "ECDHE-RSA-CHACHA20-POLY1305",
>  "ECDHE-RSA-AES256-GCM-SHA384"
> ]

Überprüfen von Cipher-Suiten und Algorithmen

Der check Befehl überprüft eine einzelne Zeile von Krypto-Einstellungen, die durch ,getrennt sind. Dies ist hilfreich, bevor Konfigurationsänderungen angewendet werden.

So überprüfen Sie TLS 1.2-Verschlüsselungssammlungen:

ghe-crypto check tlsv12-ciphersuites CIPHER1,CIPHER2,CIPHER3

So überprüfen Sie TLS 1.3-Verschlüsselungssammlungen:

ghe-crypto check tlsv13-ciphersuites TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384,TLS_CHACHA20_POLY1305_SHA256

So überprüfen Sie SSH-Chiffre:

ghe-crypto check ssh-ciphers chacha20-poly1305@openssh.com,aes256-gcm@openssh.com,aes128-gcm@openssh.com

Weitere Informationen zum Konfigurieren von Verschlüsselungssammlungen und kryptografischen Algorithmen finden Sie unter Konfigurieren von TLS- und SSH-Verschlüsselungen.

ghe-console

Dieses Hilfsprogramm öffnet die GitHub Rails-Konsole auf Ihrer GitHub Enterprise Appliance. Verwende diesen Befehl nicht ohne Anweisung vom GitHub Enterprise-Support. Eine falsche Verwendung kann zu Schäden oder Datenverlust führen.

ghe-console

ghe-dbconsole

Dieses Dienstprogramm öffnet eine MySQL-Datenbanksitzung auf Ihrer GitHub Enterprise Appliance. Verwende diesen Befehl nicht ohne Anweisung vom GitHub Enterprise-Support. Eine falsche Verwendung kann zu Schäden oder Datenverlust führen.

ghe-dbconsole

ghe-es-index-status

Dieses Dienstprogramm gibt eine Zusammenfassung der ElasticSearch-Indizes im CSV-Format zurück.

Drucken einer Indexzusammenfassung mit einer Header-Kopfzeile für STDOUT:

$ ghe-es-index-status -do
> warning: parser/current is loading parser/ruby23, which recognizes
> warning: 2.3.3-compliant syntax, but you are running 2.3.4.
> warning: please see https://github.com/whitequark/parser#compatibility-with-ruby-mri.
> Name,Primary,Searchable,Writable,UpToDate,RepairProgress,Version
> code-search-1,true,true,true,true,100.0,72e27df7c631b45e026b42bfef059328fa040e17
> commits-5,true,true,true,true,100.0,7ed28813100c47813ef654c0ee2bb9abf21ab744
> gists-4,true,true,true,true,100.0,cf8e7d04fcf2564c902e2873c424a279cc41079d
> issues-4,false,false,false,true,100.0,d0bb08f71eebf6e7b070572aa399b185dbdc8a76
> issues-5,true,true,true,true,100.0,d0bb08f71eebf6e7b070572aa399b185dbdc8a76
> projects-2,true,true,true,true,100.0,c5cac1c4b3c66d42e609d088d174dbc3dd44469a
> pull-requests-6,true,true,true,true,100.0,6a466ad6b896a3499509990979bf9a18d7d41de3
> repos-6,true,true,true,true,100.0,6c8b5fbba0fc1e409558db411d05e092c1387082
> users-5,true,true,true,true,100.0,38984875552bb826c9ec42999f409cb2e95556eb
> wikis-4,true,true,true,true,100.0,2613dec44bd14e14577803ac1f9e4b7e07a7c234

Drucken Sie eine Indexzusammenfassung und leiten Sie die Ergebnisse für bessere Lesbarkeit an column weiter.

$ ghe-es-index-status -do | column -ts,
> warning: parser/current is loading parser/ruby23, which recognizes
> warning: 2.3.3-compliant syntax, but you are running 2.3.4.
> warning: please see https://github.com/whitequark/parser#compatibility-with-ruby-mri.
> Name             Primary  Searchable  Writable  UpToDate  RepairProgress  Version
> code-search-1    true     true        true      true      100.0           72e27df7c631b45e026b42bfef059328fa040e17
> commits-5        true     true        true      true      100.0           7ed28813100c47813ef654c0ee2bb9abf21ab744
> gists-4          true     true        true      true      100.0           cf8e7d04fcf2564c902e2873c424a279cc41079d
> issues-4         false    false       false     true      100.0           d0bb08f71eebf6e7b070572aa399b185dbdc8a76
> issues-5         true     true        true      true      100.0           d0bb08f71eebf6e7b070572aa399b185dbdc8a76
> projects-2       true     true        true      true      100.0           c5cac1c4b3c66d42e609d088d174dbc3dd44469a
> pull-requests-6  true     true        true      true      100.0           6a466ad6b896a3499509990979bf9a18d7d41de3
> repos-6          true     true        true      true      100.0           6c8b5fbba0fc1e409558db411d05e092c1387082
> users-5          true     true        true      true      100.0           38984875552bb826c9ec42999f409cb2e95556eb
> wikis-4          true     true        true      true      100.0           2613dec44bd14e14577803ac1f9e4b7e07a7c234

ghe-legacy-github-services-report

Dieses Hilfsprogramm listet Repositorys auf Ihrer Appliance auf, die GitHub-Dienste verwenden, eine Integration, die am 1. Oktober 2018 eingestellt wurde. Benutzer in Ihrer Appliance haben möglicherweise Dienste eingerichtet GitHub , um Benachrichtigungen für Pushs an bestimmte Repositorys zu erstellen. Weitere Informationen finden Sie unter Ankündigung der Abschaffung von GitHub-Diensten auf the GitHub Blog. Verwende das Flag -h, um weitere Informationen zu diesem Befehl oder zusätzliche Informationen anzuzeigen.

ghe-legacy-github-services-report

ghe-logs-tail

Mit diesem Dienstprogramm kannst du das Ende aller relevanten Protokolldateien aus deiner Installation ausgeben. Du kannst Optionen übergeben, um die Protokolle auf bestimmte Sätze zu begrenzen. Verwende das Flag „-h“, um zusätzliche Optionen anzuzeigen.

ghe-logs-tail

ghe-maintenance

Mit diesem Dienstprogramm kannst du den Wartungsmoduszustand der Installation steuern. Er ist in erster Linie für die Verwaltungskonsole im Hintergrund gedacht, kann aber auch direkt verwendet werden. Weitere Informationen finden Sie unter Wartungsmodus aktivieren und planen.

ghe-maintenance -h

ghe-motd

Dieses Dienstprogramm zeigt erneut die Meldung des Tages (MOTD) an, die Administratoren sehen, wenn sie über die Administrations-Shell auf die Instanz zugreifen. Die Ausgabe enthält einen Überblick über den Status der Instanz.

ghe-motd

ghe-nwo

Dieses Dienstprogramm gibt den Namen und den Inhaber eines Repositorys basierend auf der Repository-ID zurück.

ghe-nwo REPOSITORY_ID

ghe-org-admin-promote

Führe diesen Befehl aus, um Benutzern mit Websiteadministratorberechtigungen Organisationsinhaberberechtigungen auf der Appliance zu erteilen oder um beliebigen einzelnen Benutzern in einer einzelnen Organisation Organisationsinhaberberechtigungen zu erteilen. Du musst einen Benutzer bzw. eine Organisation angeben. Der Befehl ghe-org-admin-promote fragt immer nach Bestätigung, bevor er ausgeführt wird, es sei denn, du verwendest das Flag -y, um die Bestätigung zu umgehen.

Die folgenden Optionen kannst du mit dem Dienstprogramm verwenden:

• Das Flag -u gibt einen Benutzernamen an. Verwende dieses Flag, um einem bestimmten Benutzer Organisationsinhaberberechtigungen zu erteilen. Lass das Flag -u weg, um alle Websiteadministratoren für die angegebene Organisation hochzustufen.
• Das Flag -o gibt eine Organisation an. Verwende dieses Flag, um in einer bestimmten Organisation Inhaberberechtigungen zu erteilen. Lass das Flag -o weg, um dem angegebenen Websiteadministrator in allen Organisationen Inhaberberechtigungen zu erteilen.
• Das Flag -a erteilt allen Websiteadministratoren in allen Organisationen Inhaberberechtigungen.
• Das Flag -y umgeht die manuelle Bestätigung.

Mit diesem Dienstprogramm ist es nicht möglich, einen Nicht-Websiteadministrator auf einen Inhaber sämtlicher Organisationen hochzustufen. Mit ghe-user-promote kannst du ein gewöhnliches Benutzerkonto auf einen Websiteadministrator hochstufen.

Allen Websiteadministratoren in einer bestimmten Organisation Organisationsinhaberberechtigungen erteilen

ghe-org-admin-promote -u USERNAME -o ORGANIZATION

Einem bestimmten Websiteadministrator in allen Organisationen Organisationsinhaberberechtigungen erteilen

ghe-org-admin-promote -u USERNAME

Allen Websiteadministratoren in einer bestimmten Organisation Organisationsinhaberberechtigungen erteilen

ghe-org-admin-promote -o ORGANIZATION

Allen Websiteadministratoren in allen Organisationen Organisationsinhaberberechtigungen erteilen

ghe-org-admin-promote -a

ghe-reactivate-admin-login

Verwenden Sie diesen Befehl, um die Verwaltungskonsole unmittelbar nach der Sperrung eines Kontos zu entsperren. Informationen zum Konfigurieren von Authentifizierungsrichtlinien finden Sie unter Ihre GitHub Enterprise Server-InstanceConfiguring rate limits (Konfigurieren von Ratenbegrenzungen).

ghe-reactivate-admin-login

ghe-saml-mapping-csv

Mit diesem Hilfsprogramm können Administratorinnen die SAML-NameID-Zuordnungen für Benutzerinnen in einer Instanz ausgeben oder aktualisieren. Das Hilfsprogramm kann eine CSV-Datei ausgeben, die alle vorhandenen Zuordnungen auflistet. Du kannst auch Zuordnungen für Benutzer*innen in deiner Instanz aktualisieren, indem du die resultierende Datei bearbeitest und dann das Hilfsprogramm verwendest, um neue Zuordnungen aus der Datei zuzuweisen.

Führe den folgenden Befehl aus, um eine CSV-Datei mit einer Liste aller SAML-NameID-Benutzerzuordnungen für die Instanz auszugeben.

ghe-saml-mapping-csv -d

Standardmäßig schreibt das Hilfsprogramm die Datei nach /data/user/tmp.

Wenn du Zuordnungen aktualisieren möchtest, wird empfohlen, die Datei am Standardspeicherort zu belassen, damit das Hilfsprogramm auf diese zugreifen kann.

Um Zuordnungsaktualisierungen vorzubereiten, bearbeite die Datei; nimm die gewünschten Änderungen vor. Führe einen Testlauf aus, um das Ergebnis der Zuordnungsaktualisierung mit den neuen Werten in der bearbeiteten CSV-Datei anzuzeigen. Führe den folgenden Befehl aus, und ersetze /PATH/TO/FILE durch den tatsächlichen Pfad zu der Datei, die du bearbeitet hast.

ghe-saml-mapping-csv -u -n -f /PATH/TO/FILE

Um SAML-Zuordnungen in der Instanz mit neuen Werten aus der Datei zu aktualisieren, führe den folgenden Befehl aus, und ersetze /PATH/TO/FILE durch den tatsächlichen Pfad zu der von dir bearbeiteten Datei.

ghe-saml-mapping-csv -u -f /PATH/TO/FILE

ghe-scim-identities-csv

Mit diesem Hilfsprogramm können Administrierende die SCIM-Identitäten für Benutzende in einer Instanz ausgeben. Das Hilfsprogramm kann eine CSV-Datei ausgeben, in der alle vorhandenen Identitäten und die Gruppen aufgelistet sind, deren Mitglieder sie sind.

Führe den folgenden Befehl aus, um eine CSV-Datei mit einer Liste aller SCIM-Benutzeridentitäten für die Instanz auszugeben. Dadurch wird eine Datei erstellt, die sich auf /data/user/tmp/scim-identities-DATE.csv befindet, die deine SCIM-Identitäten enthält.

ghe-scim-identities-csv

Wenn du die Datei angeben möchtest, führe den folgenden Befehl aus.

ghe-scim-identities-csv -f /PATH/TO/FILE

Es wird empfohlen, in eine Datei in /data/user/tmp zu schreiben.

ghe-service-list

Mit diesem Hilfsprogramm werden alle Dienste aufgelistet, die auf deiner Appliance gestartet oder gestoppt (entweder in Betrieb oder wartend) wurden.

$ ghe-service-list
active
  - alambic
  - alive
  - aqueduct-lite
  - authzd
  - babeld
  - codeload
  - consul, process 17114
  - consul-template, process 19493
  - driftwood
  - elasticsearch
  - enterprise-manage-unicorn, process 9359
  - ghe-user-disk, process 2545
  - git-daemon
  - github-env
  - github-gitauth
  - github-resqued
  - github-stream-processors
  - github-timerd
  - github-unicorn
  - gitrpcd
  - governor
  - gpgverify
  - grafana-server, process 19314
  - graphite-web, process 20189
  - hookshot-go
  - kafka-lite
  - kredz
  - lfs-server
  - mail-replies
  - memcached
  - minio
  - mysql
  - nginx
  - nomad, process 19562
  - pages
  - postfix
  - redis
  - spokesd
  - spokes-sweeper
  - svnbridge
  - token-scanning-api
  - token-scanning-backfill-worker
  - token-scanning-hydro-consumer
  - token-scanning-incremental-worker
  - token-scanning-udp-backfill-worker
  - treelights
  - turboscan
  - viewscreen

inactive
  - wireguard

ghe-passwort-festlegen

Mit diesem Hilfsprogramm können Sie ein neues Passwort für den Stamm-Administrator der Website festlegen, um sich bei der Verwaltungskonsole zu authentifizieren. Weitere Informationen finden Sie unter Verwalten des Zugriffs auf die Verwaltungskonsole.

ghe-set-password

ghe-setup-network

Mit diesem Dienstprogramm kannst du die primäre Netzwerkschnittstelle konfigurieren.

Um den visuellen Modus einzugeben, der dich durch die Konfiguration von Netzwerkeinstellungen führt:

ghe-setup-network -v

Verwende das Flag „-h“, um zusätzliche Optionen anzuzeigen.

ghe-ssh-check-host-keys

Dieses Dienstprogramm gleicht die vorhandenen SSH-Hostschlüssel mit der Liste der bekannten kompromittierten SSH-Hostschlüssel ab.

ghe-ssh-check-host-keys

Wenn ein kompromittierter Hostschlüssel gefunden wird, beendet sich das Dienstprogramm mit Status 1 und gibt folgende Meldung aus:

> One or more of your SSH host keys were found in the blacklist.
> Please reset your host keys using ghe-ssh-roll-host-keys.

Wenn kein kompromittierter Hostschlüssel gefunden wird, beendet das Dienstprogramm mit Status 0 und einer Nachricht:

> The SSH host keys were not found in the SSH host key blacklist.
> No additional steps are needed/recommended at this time.

ghe-ssh-roll-host-keys

Dieses Dienstprogramm rotiert die SSH-Hostschlüssel und ersetzt sie durch neu generierte Schlüssel.

$ sudo ghe-ssh-roll-host-keys
Proceed with rolling SSH host keys? This will delete the
existing keys in /etc/ssh/ssh_host_* and generate new ones. [y/N]

# Press 'Y' to confirm deleting, or use the -y switch to bypass this prompt

> SSH host keys have successfully been rolled.

ghe-ssh-weak-fingerprints

Dieses Hilfsprogramm gibt einen Bericht über bekannte schwache SSH-Schlüssel zurück, die in der GitHub Enterprise Appliance gespeichert sind. Optional kannst du Benutzerschlüssel in einer Massenaktion widerrufen. Das Dienstprogramm meldet schwache Systemschlüssel, die Sie manuell im Verwaltungskonsole widerrufen müssen.

# Print a report of weak user and system SSH keys
$ ghe-ssh-weak-fingerprints

# Revoke all weak user keys
$ ghe-ssh-weak-fingerprints --revoke

ghe-ssl-acme

Mit diesem Dienstprogramm können Sie ein Let's Encrypt-Zertifikat auf Ihrer GitHub Enterprise Appliance installieren. Weitere Informationen finden Sie unter TLS konfigurieren.

Du kannst das Flag -x verwenden, um die ACME-Konfiguration zu entfernen.

ghe-ssl-acme -e

ghe-ssl-ca-certificate-install

Mit diesem Tool können Sie ein benutzerdefiniertes Stammzertifikat auf Ihrem GitHub Enterprise Server installieren. Das Zertifikat muss im PEM-Format vorliegen. Wenn dein Zertifikatsanbieter mehrere CA-Zertifikate in einer einzigen Datei bereitstellt, musst du diese in einzelne Dateien aufteilen, die du dann einzeln an ghe-ssl-ca-certificate-install übergibst.

Führe dieses Dienstprogramm aus, um eine Zertifikatskette für die S/MIME-Commit-Signaturverifizierung hinzuzufügen. Weitere Informationen finden Sie unter Informationen zur Verifizierung einer Commit-Signatur.

Führen Sie dieses Hilfsprogramm aus, wenn Ihre GitHub Enterprise Server-Instance keine Verbindung zu einem anderen Server herstellen kann, da der andere Server ein selbstsigniertes SSL-Zertifikat oder ein SSL-Zertifikat verwendet, für das er nicht das erforderliche Zertifizierungsstellen-Bundle bereitstellt. Eine Möglichkeit, dies zu bestätigen, besteht darin, openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs von Ihre GitHub Enterprise Server-Instance auszuführen. Wenn das SSL-Zertifikat des Remote-Servers verifiziert werden kann, sollte deine SSL-Session den Rückgabecode 0 aufweisen (siehe unten).

SSL-Session:
    Protocol  : TLSv1
    Cipher    : AES128-SHA
    Session-ID: C794EBCC3CBC10F747C9AFC029C03C1048FC99CFC34D13D7444E0F267C58DF4C
    Session-ID-ctx:
    Master-Key: 02A7C47CFD6EEC87D3C710E9DD87390E04EF82DDD7514AE03127D5DC1945FC0CAEFB5395791AEA598667EFA61B9EA8C5
    Key-Arg   : None
    Start Time: 1394581597
    Timeout   : 300 (sec)
    Verify return code: 0 (ok)

Wenn das SSL-Zertifikat des Remote-Servers dagegen nicht verifiziert werden kann, sollte deine SSL-Session einen Rückgabecode ungleich null zurückgeben:

SSL-Session:
    Protocol  : TLSv1
    Cipher    : AES128-SHA
    Session-ID: 82CB288051A6DB66094C50A69CF1292AEE7E54C6B01B659B98AB336F8C33863E
    Session-ID-ctx:
    Master-Key: 01B025B2F764043A27919A8D1355AAECD8844FF0831B1D664042334790574A6F4025BAB085D4ED71D71AAB3091B849E5
    Key-Arg   : None
    Start Time: 1394581782
    Timeout   : 300 (sec)
    Verify return code: 27 (certificate not trusted)

Du kannst die folgenden zusätzlichen Optionen mit dem Dienstprogramm verwenden:

• Mit dem Flag -r kannst du ein CA-Zertifikat deinstallieren.
• Mit dem Flag -h werden weitere Nutzungsinformationen angezeigt.

ghe-ssl-ca-certificate-install -c CERTIFICATE_PATH

Führe den folgenden Befehl aus, um die Konfiguration anzuwenden. Während einer Konfiguration können Dienste auf Ihre GitHub Enterprise Server-Instance neu gestartet werden, was zu kurzen Ausfallzeiten für Benutzer führen kann.

ghe-config-apply

ghe-config-apply

ghe-ssl-zertifikat-einrichtung

Mit diesem Dienstprogramm können Sie ein SSL-Zertifikat für Ihre GitHub Enterprise Server-Instance aktualisieren.

Verwende das Flag -h, um weitere Informationen zu diesem Befehl oder zusätzliche Informationen anzuzeigen.

/usr/local/share/enterprise/ghe-ssl-certificate-setup

ghe-ssl-generate-csr

Mit diesem Dienstprogramm kannst du einen privaten Schlüssel und eine Zertifikatsignierungsanforderung (Certificate Signing Request, CSR) generieren, die du für eine kommerzielle oder private Zertifizierungsstelle freigeben kannst, um ein gültiges Zertifikat abzurufen, das du für deine Instanz verwenden kannst. Weitere Informationen finden Sie unter TLS konfigurieren.

Verwende das Flag -h, um weitere Informationen zu diesem Befehl oder zusätzliche Informationen anzuzeigen.

ghe-ssl-generate-csr

ghe-speicher-erweitern

Einige Plattformen erfordern dieses Skript, um das Benutzer-Volume zu erweitern. Weitere Informationen finden Sie unter Speicherkapazität erhöhen.

ghe-storage-extend

ghe-version

Dieses Hilfsprogramm druckt die Version, Plattform und den Build von Ihre GitHub Enterprise Server-Instance.

ghe-version

ghe-webhook-logs

Dieses Dienstprogramm gibt Webhook-Auslieferungsprotokolle für Administratoren zurück, damit die Administratoren Probleme überprüfen und identifizieren können.

ghe-webhook-logs

So zeigen Sie alle Hook-Lieferungen gefiltert nach einem bestimmten Ereignis an.

ghe-webhook-logs --event issues

Zum Anzeigen aller Hookbereitstellungen gefiltert nach einem bestimmten Ereignis und einer bestimmten Aktion:

ghe-webhook-logs --event issues.opened
To show all failed hook deliveries in the past day:

```shell
ghe-webhook-logs -f -a YYYY-MM-DD

Das Datumsformat sollte YYYY-MM-DD, YYYY-MM-DD HH:MM:SS oder YYYY-MM-DD HH:MM:SS (+/-) HH:M sein.

So zeigst du die vollständigen Hooknutzdaten, das Ergebnis und alle Ausnahmen für die Übermittlung an:

ghe-webhook-logs -g DELIVERY_GUID

ghe-governor-summary

Dieses Dienstprogramm verwendet Daten aus ghe-governor , um eine Git-Aktivitätszusammenfassung anzuzeigen, einschließlich der wichtigsten Repositorys, Benutzer und IP-Adressen.

ghe-governor-summary

Du kannst die folgenden Flags mit ghe-governor-summary verwenden.

ghe-redis-usage

Dieses Hilfsprogramm berechnet die Speicherauslastung von Schlüsseln in Redis.

ghe-redis-usage

Du kannst die folgenden Flags mit ghe-redis-usage verwenden.

ghe-snmpv3-add-user

Dieses Dienstprogramm fügt der SNMPv3-Konfiguration auf Ihre GitHub Enterprise Server-Instance einen schreibgeschützten Benutzer hinzu.

ghe-snmpv3-add-user -A PASSPHRASE -X PASSPHRASE USERNAME

Du kannst die folgenden Flags mit ghe-snmpv3-add-user verwenden.

ghe-snmpv3-hash-password

Dieses Hilfsprogramm bildet den Hash eines Kennworts gemäß RFC 2574 zur Verwendung mit SNMPv3.

ghe-snmpv3-hash-password -s PASSWORD

Du kannst die folgenden Flags mit ghe-snmpv3-hash-password verwenden.

ghe-snmpv3-remove-user

Dieses Hilfsprogramm entfernt einen Benutzer aus der SNMPv3-Konfiguration auf Ihre GitHub Enterprise Server-Instance.

ghe-snmpv3-remove-user USERNAME

ghe-ssh-audit-login

Dieses Dienstprogramm ruft die autorisierten Benutzer und Fingerabdrücke für die Auditierung von SSH-Anmeldungen auf Ihre GitHub Enterprise Server-Instance ab.

ghe-ssh-audit-login

Du kannst die folgenden Flags mit ghe-ssh-audit-login verwenden.

ghe-system-info

Dieses Hilfsprogramm gibt Systeminformationen für Ihre GitHub Enterprise Server-Instance im JSON-Format aus.

ghe-system-info

Clustering

ghe-cluster-balance

Mit diesem Hilfsprogramm kannst du eine gleichmäßige Verteilung von Zuordnungen auf deine Clusterknoten erzwingen, indem du den Status der Zuordnungen deines Clusters überprüfst und dann problematische Zuordnungen ausgleichst. Weitere Informationen finden Sie unter Erneutes Ausgleichen von Cluster-Arbeitslasten.

Um eine Liste der ausgleichbaren Aufträge und der zugehörigen Zuweisungsverteilung auszugeben:

ghe-cluster-balance status

Ausgeben von Zuordnungsanzahlen für einen bestimmten Auftrag oder eine durch Kommas getrennte Liste von Aufträgen:

ghe-cluster-balance -j JOB

Ausgleichen problematischer Zuordnungen für einen bestimmten Auftrag oder eine durch Kommas getrennte Liste von Aufträgen:

ghe-cluster-balance rebalance -j JOB

Du kannst die folgenden Flags mit ghe-cluster-balance rebalance verwenden.

Um Fertigstellungsskripte für die angegebene Shell auszugeben:

ghe-cluster-balance completion

Um eine kurze Beschreibung des Hilfsprogramms und aller gültigen Unterbefehle anzuzeigen:

ghe-cluster-balance help

ghe-cluster-block-ip

Dieses Hilfsprogramm fügt Firewallregeln auf einem Clusterknoten hinzu, die den gesamten Datenverkehr zu und von einer bestimmten IP-Adresse blockieren. Derzeit werden nur IPv4-Adressen unterstützt.

ghe-cluster-block-ip IP-ADDRESS

Um den Block zu entfernen, verwenden Sie ghe-cluster-unblock-ip.

ghe-cluster-config-apply

Dieses Hilfsprogramm überprüft Ihre /data/user/common/cluster.conf Konfigurationsdatei, kopiert sie in jeden Knoten im Cluster und konfiguriert jeden Knoten basierend auf der geänderten Datei.

ghe-cluster-config-apply

Du kannst die folgenden Flags mit ghe-cluster-config-apply verwenden.

ghe-cluster-config-check

Dieses Hilfsprogramm überprüft die Clusterkonfigurationsdatei und überprüft einzelne Optionen.

ghe-cluster-config-check

So überprüfen Sie eine bestimmte Datei:

ghe-cluster-config-check /PATH/TO/cluster.conf

So geben Sie Ergebnisse im JSON-Format aus:

ghe-cluster-config-check json

ghe-cluster-config-init

Dieses Hilfsprogramm initialisiert einen Cluster mithilfe der Konfiguration in /data/user/common/cluster.conf. SSL muss vor dem Ausführen dieses Befehls konfiguriert werden.

ghe-cluster-config-init

ghe-cluster-diagnostics

Dieses Hilfsprogramm durchläuft alle Knoten im Cluster und sammelt Diagnoseausgaben von jedem Knoten.

ghe-cluster-diagnostics

Du kannst die folgenden Flags mit ghe-cluster-diagnostics verwenden.

ghe-cluster-each

Dieses Hilfsprogramm durchläuft alle Knoten im Cluster und führt einen Befehl parallel aus.

ghe-cluster-each -- COMMAND

Du kannst die folgenden Flags mit ghe-cluster-each verwenden.

ghe-cluster-host-check

Dieses Hilfsprogramm überprüft, ob alle Hosts in einem Cluster für die Konfiguration bereit sind.

ghe-cluster-host-check

Du kannst die folgenden Flags mit ghe-cluster-host-check verwenden.

GHE-Cluster-Wartung

Mit dem ghe-cluster-maintenance-Hilfsprogramm kannst du den Wartungsmodus für jeden Knoten in einem Cluster festlegen oder die Festlegung aufheben.

$ ghe-cluster-maintenance -h
# Shows options
$ ghe-cluster-maintenance -q
# Queries the current mode
$ ghe-cluster-maintenance -s
# Sets maintenance mode
$ ghe-cluster-maintenance -s "MESSAGE"
# Sets maintenance mode with a custom message
$ ghe-cluster-maintenance -m "MESSAGE"
# Updates the custom message
$ ghe-cluster-maintenance -u
# Unsets maintenance mode

ghe-cluster-nodes

Dieses Hilfsprogramm listet Knoten im Cluster auf, mit Optionen zum Filtern nach Rolle, Rechenzentrum oder Status.

ghe-cluster-nodes

Du kannst die folgenden Flags mit ghe-cluster-nodes verwenden.

ghe-cluster-repl-bootstrap

Dieses Dienstprogramm konfiguriert die Hochverfügbarkeitsreplikation für einen sekundären Satz von Clusterknoten. Weitere Informationen finden Sie unter Die Hochverfügbarkeitsreplikation für einen Cluster konfigurieren.

ghe-cluster-repl-bootstrap

ghe-cluster-repl-teardown

Dieses Hilfsprogramm deaktiviert die Replikation auf Replikatknoten für einen Cluster in einer Konfiguration mit hoher Verfügbarkeit. Weitere Informationen finden Sie unter Die Hochverfügbarkeitsreplikation für einen Cluster konfigurieren.

ghe-cluster-repl-teardown

ghe-cluster-repl-status

Dieses Hilfsprogramm zeigt den Replikationsstatus für einen Cluster in einer Konfiguration mit hoher Verfügbarkeit an.

ghe-cluster-repl-status

ghe-cluster-set-password

Dieses Hilfsprogramm aktualisiert interaktiv das Kennwort des Administrators und Verwaltungskonsole auf allen Clusterknoten.

ghe-cluster-set-password

Du kannst die folgenden Flags mit ghe-cluster-set-password verwenden.

ghe-cluster-status

Überprüfen Sie den Zustand Ihrer Knoten und Dienste in einer Cluster-Bereitstellung von GitHub Enterprise Server.

ghe-cluster-status

ghe-cluster-support-bundle

Dieses Dienstprogramm erstellt eine Support-Bundle-Tarball-Datei, die wichtige Protokolle von jedem Knoten in einer Geo-Replikation oder Clustering-Konfiguration enthält.

Standardmäßig erstellt der Befehl den Tarball in /tmp, aber du kannst ihn auch nach cat``STDOUT lassen, um das Streaming über SSH zu erleichtern. Dies ist nützlich, wenn die Web-Benutzeroberfläche nicht antwortet oder der Download eines Support-Bundles von /setup/support nicht funktioniert. Du musst diesen Befehl ausführen, wenn du ein erweitertes Bundle generieren möchtest, das ältere Protokolle enthält. Sie können diesen Befehl auch verwenden, um das Cluster-Support-Bundle direkt an den GitHub Enterprise Support hochzuladen.

Um ein Standardpaket zu erstellen:

ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -o' > cluster-support-bundle.tgz

So erstellst du ein Standardbundle, das Daten aus den letzten zwei Tagen enthält:

ssh -p 122 admin@HOSTNAME -- "ghe-cluster-support-bundle -p 2days -o" > support-bundle.tgz

So erstellst du ein erweitertes Bundle, das Daten der letzten acht Tage enthält

ssh -p 122 admin@HOSTNAME -- ghe-cluster-support-bundle -x -o' > cluster-support-bundle.tgz

So senden Sie ein Bündel an GitHub-Support:

ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -u'

Um ein Bündel an GitHub-Support zu senden und es einem Ticket zuzuordnen:

ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -t TICKET_ID'

ghe-cluster-unblock-ip

Dieses Hilfsprogramm entfernt Firewallregeln von einem Clusterknoten, der den gesamten Datenverkehr zu und von einer bestimmten IP-Adresse blockiert. Derzeit werden nur IPv4-Adressen unterstützt.

ghe-cluster-unblock-ip IP-ADDRESS

ghe-cluster-failover

Mit dem Hilfsprogramm ghe-cluster-failover können Sie ein Failover zum Replikatcluster ausführen. Weitere Informationen finden Sie unter Initiieren eines Failovers zu Ihrem Replikatcluster.

ghe-cluster-failover

ghe-dpages

Mit diesem Dienstprogramm können Sie den verteilten GitHub Pages Server verwalten.

ghe-dpages

Um eine Zusammenfassung des Repository-Standorts und -Zustands anzuzeigen:

ghe-dpages status

So evakuieren Sie einen GitHub Pages-Dienst, bevor Sie einen Cluster-Knoten evakuieren:

ghe-dpages evacuate pages-server-UUID

ghe-remove-node

Dieses Hilfsprogramm entfernt einen Knoten aus einem Cluster oder einem zusätzlichen Knoten aus einer Ha-Konfiguration (High Availability). Richten Sie für einen geplanten Ersatz eines funktionalen Clusterknotens den Ersetzungsknoten ein, bevor Sie diesen Befehl verwenden, um den alten Knoten zu entfernen. Weitere Informationen finden Sie unter Clusterknoten ersetzen. Informationen zu den erforderlichen HA-Prüfungen und Verifizierungsschritten finden Sie unter Entfernen eines zusätzlichen Knotens.

Bevor Sie diesen Befehl für eine geplante Entfernung verwenden, installieren Sie die neueste Patchversion für Ihre Featureversion auf jedem Knoten. Jeder Knoten muss dieselbe genaue Freigabe ausführen. Warten Sie, bis ein Upgrade oder eine Konfiguration abgeschlossen ist, bevor Sie mit dem Entfernen beginnen. Zum Notfallaustausch eines nicht verfügbaren Clusterknotens siehe Clusterknoten ersetzen.

Sie müssen diesen Befehl über den primären MySQL-Knoten ausführen, bei dem es sich in der Regel um den Knoten handelt, der in der Regel wie mysql-master in der Clusterkonfigurationsdatei (cluster.conf) festgelegt ist. Führen Sie in einer HA-Konfiguration den Befehl aus der primären HA-Konfiguration aus. Sie können den mysql-master- oder redis-master-Knoten nicht entfernen. Weitere Informationen finden Sie unter Cluster initialisieren.

ghe-remove-node HOSTNAME

Der Befehlt leistet Folgendes:

• Evakuiert Daten von allen Datendiensten, die auf dem Knoten ausgeführt werden, sodass die verbleibenden Knoten Kopien der Daten enthalten.
• Entfernt Workloads vom Knoten
• Entfernt den Knoten aus der Konfiguration. Wenn ein weiterer nicht primärer Knoten vorhanden ist, wird der Befehl ghe-config-apply ausgeführt, und es wird kein Datenverkehr mehr an den entfernten Knoten weitergeleitet. Wenn kein sekundärer Knoten mehr vorhanden ist, entfernt der Befehl die Clustermetadaten und wandelt die primäre Instanz in eine eigenständige Instanz um, ohne ghe-config-apply auszuführen.

Sie können den Befehl mit den folgenden Flags ausführen.

          * In einer HA-Konfiguration können Sie diesen Befehl verwenden, um einen zusätzlichen Knoten zu entfernen. Sie können es nicht verwenden, um die primäre HA-Datei oder ein Replikat zu entfernen.

• Der Zielknoten muss ready in nomad node status melden, um das Entfernen abzuschließen. Das --no-evacuate Flag entfernt keinen Offlineknoten aus der Konfiguration.
• Dieser Befehl unterstützt keine parallele Ausführung. Um mehrere Knoten zu entfernen, müssen Sie warten, bis dieser Befehl abgeschlossen ist, bevor Sie ihn für einen anderen Knoten ausführen.

ghe-spokesctl

Mit diesem Hilfsprogramm kannst du die Replikation von Repositorys auf den verteilten Git-Servern verwalten.

ghe-spokesctl

Zeigen Sie die Server, auf denen das Repository gespeichert ist:

ghe-spokesctl routes

Um Speicherdienste auf einem Cluster-Knoten zu evakuieren:

ghe-spokesctl server set evacuating git-server-UUID

ghe-storage

Mit diesem Dienstprogramm kannst du alle Speicherdienste evakuieren, bevor du einen Clusterknoten evakuierst.

ghe-storage evacuate storage-server-UUID

nes

Mit diesem Dienstprogramm können Sie den Gesundheitszustand von Clusterknoten mithilfe von Node Eligibility Service überwachen. Standardmäßig ist Node Eligibility Service deaktiviert. Weitere Informationen finden Sie unter Überwachen der Integrität deiner Clusterknoten mit dem Knotenberechtigungsdienst.

Um die Gesundheit der Clusterknoten anzusehen:

nes get-cluster-health

Überprüfen der TTL-Einstellungen:

nes get-node-ttl all

Festlegen des TTL-Werts für den fail-Status in Minuten:

nes set-node-ttl fail MINUTES

Der TTL-Wert für den fail-Status muss höher sein als der TTL-Wert für den warn-Status.

Festlegen des TTL-Werts für den warn-Status in Minuten:

nes set-node-ttl warn TIME

Um zu prüfen, ob Node Eligibility Service administrative Maßnahmen ergreifen kann, wenn ein Knoten mit dem Hostnamen HOSTNAME offline geht:

nes get-node-adminaction HOSTNAME

Um Node Eligibility Service zu erlauben, automatisch administrative Maßnahmen zu ergreifen, wenn ein Knoten mit dem Hostnamen HOSTNAME offline geht:

nes set-node-adminaction approved HOSTNAME

Um die Befugnis von Node Eligibility Service zu entziehen, den Knoten mit dem Hostnamen HOSTNAME offline zu schalten:

nes set-node-adminaction none HOSTNAME

Manuelles Aktualisieren der Berechtigung eines Knotens zum erneuten Hinzufügen zum Cluster:

nes set-node-eligibility eligible HOSTNAME

Git

ghe-btop

Eine top-ähnliche Schnittstelle für aktuelle Git-Vorgänge.

ghe-btop [ <port number> | --help | --usage ]

ghe-governor

Dieses Dienstprogramm hilft beim Analysieren des Git-Datenverkehrs. Es fragt die Governor-Datendateien ab, die sich unter /data/user/governor/ befinden. GitHub enthält eine Stunde Daten pro Datei, die für zwei Wochen aufbewahrt werden. Weitere Informationen finden Sie unter Analysieren des Git-Datenverkehrs auf Ihrer GitHub Enterprise Server Instanz.

ghe-governor <subcommand> <column> [options]

ghe-governor -h
Usage: ghe-governor [-h] <subcommand> args

OPTIONS:
  -h | --help        Show this message.

Valid subcommands are:
  aggregate              Find the top (n) groups of queries for a grouping function and metric
  health                 Summarize all recent activity on one or more servers
  top                    Find the top (n) queries for a given metric
  dump                   Dump individual operations
  test-quotas            Check quota information

Try ghe-governor <subcommand> --help for more information on the arguments each subcommand takes.

ghe-repo

Mit diesem Dienstprogramm kannst du das Verzeichnis eines Repositorys ändern und als der git-Benutzer eine interaktive Shell öffnen. Durch Ausführung der Befehle git-* oder git-nw-* kannst du die manuelle Untersuchung oder Wartung eines Repositorys durchführen.

ghe-repo USERNAME/REPONAME

ghe-repo-gc

Mit diesem Dienstprogramm wird ein Repository-Netzwerk neu gepackt, um den Paketspeicher zu optimieren. Wenn du über ein großes Repository verfügst, wird seine Größe durch die Ausführung dieses Befehls ggf. reduziert. GitHub Enterprise führt diesen Befehl automatisch während ihrer Interaktion mit einem Repositorynetzwerk aus.

ghe-repo-gc USERNAME/REPONAME

Sie können das optionale Argument --prune hinzufügen, um nicht erreichbare Git-Objekte zu entfernen, auf die nicht aus einer Verzweigung, einem Tag oder durch einen anderen Verweis verwiesen wird. Dies ist besonders nützlich, um zuvor gelöschte vertrauliche Informationen sofort zu entfernen. Weitere Informationen findest du unter Entfernen vertraulicher Daten aus einem Repository.

Wenn Sie eine Bereitstellungstopologie mit mehreren Knoten verwenden, um zu verhindern, dass vertrauliche Daten auf anderen Knoten beibehalten und während eines Failovers potenziell verfügbar gemacht werden, müssen Sie den Befehl auf allen Knoten ausführen. Für eine Clusterkonfiguration können Sie z. B. den folgenden Befehl verwenden.

ghe-cluster-each -r git -- "ghe-repo-gc --prune USERNAME/REPONAME"

GitHub Actions

ghe-actions-check

Dieses Dienstprogramm überprüft, ob alle Dienste für GitHub Actions ordnungsgemäß funktionieren. Weitere Informationen findest du unter Erste Schritte mit GitHub Actions für GitHub Enterprise Server und Problembehandlung bei GitHub Actions für Ihr Unternehmen.

ghe-actions-check

ghe-actions-precheck

Dieses Tool testet die Blob-Speicherkonfiguration für GitHub Actions auf Ihre GitHub Enterprise Server-Instance. Sie können das Hilfsprogramm verwenden, um Ihre Speicherkonfiguration zu überprüfen, bevor Sie GitHub Actions für Ihre Instanz aktivieren.

Weitere Informationen zur Konfiguration von GitHub Actions finden Sie unter Erste Schritte mit GitHub Actions für GitHub Enterprise Server.

ghe-actions-precheck -p [PROVIDER] -cs ["CONNECTION-STRING"]

Wenn dein Speichersystem ordnungsgemäß konfiguriert ist, wird die folgende Ausgabe angezeigt.

All Storage tests passed

ghe-actions-test-storage-with-oidc

Dieses Hilfsprogramm überprüft, ob der Blob-Speicheranbieter für GitHub Actions auf Ihre GitHub Enterprise Server-Instance gültig ist, wenn OpenID Connect (OIDC) verwendet wird.

ghe-actions-test-storage-with-oidc -p [PROVIDER] -cs ["CONNECTION-STRING"]

ghe-actions-stop

Dieses Dienstprogramm verhindert, dass GitHub Actions auf Ihre GitHub Enterprise Server-Instance ausgeführt wird.

ghe-actions-start

Dieses Dienstprogramm startet GitHub Actions auf Ihre GitHub Enterprise Server-Instance, nachdem es zuvor angehalten wurde.

Wenn Ihr System ordnungsgemäß konfiguriert ist, wird die folgende Ausgabe angezeigt:

Actions was enabled!

ghe-actions-cache-disable

Dieses Hilfsprogramm deaktiviert den GitHub Actions Cache-Dienst auf Ihre GitHub Enterprise Server-Instance und beendet die zugehörigen Aufträge.

ghe-actions-cache-disable

Du kannst die folgenden Flags mit ghe-actions-cache-disable verwenden.

ghe-actions-cache-enable

Dieses Hilfsprogramm aktiviert den GitHub Actions Cache-Dienst auf Ihre GitHub Enterprise Server-Instance und startet die zugehörigen Jobs.

ghe-actions-cache-enable

Du kannst die folgenden Flags mit ghe-actions-cache-enable verwenden.

ghe-actions-check-connectivity

Dieses Hilfsprogramm überprüft die Netzwerkkonnektivität zwischen GitHub Actions Diensten auf Ihre GitHub Enterprise Server-Instance.

ghe-actions-check-connectivity

Du kannst die folgenden Flags mit ghe-actions-check-connectivity verwenden.

ghe-actions-diagnostics

Dieses Hilfsprogramm sammelt diagnostische Informationen speziell zu GitHub Actions auf Ihre GitHub Enterprise Server-Instance, die Sie an GitHub-Support senden können, um bei der Untersuchung von Problemen zu helfen.

ghe-actions-diagnostics

ghe-actions-dump

Dieses Hilfsprogramm erstellt einen Dump der GitHub Actions Dienste auf Ihre GitHub Enterprise Server-Instance. Sie können diesen Befehl auch verwenden, um den Dump direkt zu GitHub-Support hochzuladen.

ghe-actions-dump

Du kannst die folgenden Flags mit ghe-actions-dump verwenden.

GitHub Packages

ghe-check-blob-connection

Dieses Dienstprogramm prüft, ob ein Blob Storage-Anbieter für GitHub Packages auf Ihre GitHub Enterprise Server-Instance gültig ist.

ghe-check-blob-connection --help

Wenn zuvor eine Verbindung konfiguriert wurde, können Tests durchgeführt werden, indem der Befehl ohne Parameter direkt ausgeführt wird.

ghe-check-blob-connection

Wenn Ihr System ordnungsgemäß konfiguriert ist, wird die folgende Ausgabe angezeigt:

All Storage tests passed

ghe-packages-precheck

Dieses Dienstprogramm prüft, ob ein Blob Storage-Anbieter für GitHub Packages auf Ihre GitHub Enterprise Server-Instance gültig ist. Verwenden Sie diese Einstellung, um Ihre Speicherkonfiguration zu überprüfen, bevor Sie dies aktivieren GitHub Packages.

ghe-packages-precheck -p PROVIDER -cs "CONNECTION-STRING"

Du kannst die folgenden Flags mit ghe-packages-precheck verwenden.

Hochverfügbarkeit

ghe-repl-decommission

Dieser Befehl deaktiviert die Datenbankeinträge für den Knoten mit der angegebenen UUID. Du führst diesen Befehl auf dem neuen Primärknoten aus, nachdem du ein Failover auf einen Replikatknoten ausgeführt hast, um die Datenbankeinträge des deaktivierten Knotens zu entfernen. Weitere Informationen finden Sie unter Initiieren eines Failovers zu deiner Replikat-Appliance.

ghe-repl-decommission <UUID>

ghe-repl-promote

Mit diesem Befehl wird die Replikation in einem vorhandenen Replikatknoten deaktiviert und der Replikatknoten mit den gleichen Einstellungen wie der ursprüngliche primäre Knoten in einen primären Knoten konvertiert. Alle Replikationsdienste sind aktiviert. Weitere Informationen finden Sie unter Initiieren eines Failovers zu deiner Replikat-Appliance.

Wenn ein Replikat hochgestuft wird, wird nicht automatisch die Replikation für vorhandene Appliances eingerichtet. Nach dem Hochstufen eines Replikats kannst Du bei Bedarf eine Replikation von der neuen primären Instanz zu den vorhandenen Appliances und zur vorherigen primären Instanz einrichten.

ghe-repl-promote

ghe-repl-setup

Führe dieses Hilfsprogramm in einem vorhandenen Knoten aus, um eine Hochverfügbarkeitskonfiguration zu aktivieren. Das Hilfsprogramm versetzt den Knoten in den Standbymodus, bevor du die Replikation mit ghe-repl-start beginnst. Weitere Informationen finden Sie unter Erstellung eines hochverfügbaren Replikats.

Nach dem Ausführen des Hilfsprogramms weist der Knoten die folgende Konfiguration auf.

• Für die Kommunikation zwischen den Knoten wird ein verschlüsselter WireGuard-VPN-Tunnel eingerichtet.
• Datenbankdienste werden für die Replikation konfiguriert und gestartet.
• Anwendungsdienste werden deaktiviert. Bei Versuchen, über HTTP oder HTTPS, Git oder andere unterstützte Protokolle auf den Replikatknoten zuzugreifen, wird die Meldung „Server im Replikationsmodus“, eine Wartungsseite oder eine Fehlermeldung angezeigt.

Ersetze beim Ausführen dieses Hilfsprogramms „PRIMARY-NODE-IP“ durch die IP-Adresse des primären Knotens deiner Instanz.

ghe-repl-setup PRIMARY-NODE-IP

ghe-repl-start

Dieses Hilfsprogramm beginnt mit der Replikation aller Datenspeicher in einem Knoten. Führe dieses Hilfsprogramm nach der Ausführung von ghe-repl-setup aus. Weitere Informationen finden Sie unter Erstellung eines hochverfügbaren Replikats.

ghe-repl-start

ghe-repl-status

Dieses Hilfsprogramm zeigt den Status der Replikation in einem Knoten an und gibt den Status OK, WARNING oder CRITICAL für den Replikationsdatenstrom jedes Datenspeichers zurück. Weitere Informationen finden Sie unter Überwachen einer Hochverfügbarkeitskonfiguration.

• Wenn einer der Replikationskanäle den WARNING-Status aufweist, wird der Befehl mit dem Code 1 beendet.
• Wenn Sie die Replikation nicht gestartet haben, wird der Befehl mit dem Code 1 beendet.
• Wenn einer der Kanäle den CRITICAL-Status aufweist, wird der Befehl mit dem Code 2 beendet.
• Die Ausgabe entspricht den Erwartungen des Nagios-Plug-Ins „check_by_ssh“. Weitere Informationen zum check_by_ssh-Plug-In findest du auf der offiziellen Nagios-Plug-In-Seite.

ghe-repl-status

Die Optionen -v und -vv bieten zusätzliche Informationen zum Replikationsstatus der einzelnen Datenspeicher.

ghe-repl-status -v

ghe-repl-stop

Mit diesem Befehl wird die Replikation für alle Datenspeicher in einem vorhandenen Replikatknoten vorübergehend deaktiviert. Alle Replikationsdienste werden beendet. Verwende ghe-repl-start, um die Replikation fortzusetzen.

ghe-repl-stop

ghe-repl-teardown

Dieses Hilfsprogramm deaktiviert die Replikation in einem vorhandenen Replikatknoten vollständig und entfernt die Replikatkonfiguration. Du kannst den folgenden Befehl über einen Replikatknoten ausführen. Wenn der Replikatknoten jedoch nicht erreichbar ist, kannst du den Befehl auch über den primären Knoten ausführen.

ghe-repl-teardown

ghe-repl-stop-all

Dieses Hilfsprogramm deaktiviert Replikationen aller Datenspeicher in allen Replikat-Knoten. Führen Sie dieses Hilfsprogramm vom primären Knoten aus, bevor Sie Replikate aktualisieren. Weitere Informationen finden Sie unter Aktualisierung mit einem Upgrade-Paket.

ghe-repl-node

Dieses Hilfsprogramm verwaltet knotenspezifische Replikationseinstellungen, einschließlich der Aktivierung des Aktiven Replikatmodus, konfigurieren von Cacheservern und Festlegen von Rechenzentrumszuweisungen.

ghe-repl-node

Du kannst die folgenden Flags mit ghe-repl-node verwenden.

ghe-repl-start-all

Dieses Hilfsprogramm beginnt mit der Replikation aller Datenspeicher in allen Replikatknoten. Führe dieses Hilfsprogramm nach der Aktualisierung der Replikate vom primären Knoten aus. Weitere Informationen finden Sie unter Aktualisierung mit einem Upgrade-Paket.

Importieren und exportieren

ghe-migrator

          `ghe-migrator` ist ein Hi-Fidelity-Tool, mit dem Sie von einer GitHub Instanz zu einer anderen migrieren können. Sie können Ihre Instanzen konsolidieren oder Ihre Organisation, Benutzer, Teams und Repositorys von GitHub.com in GitHub Enterprise verschieben.

Weitere Informationen findest du in unseren Leitfäden zum Migrieren von Daten zu und von deinem Unternehmen.

git-import-detect

Ermittelt anhand einer URL, welcher Quellcodeverwaltungssystem-Typ sich am anderen Ende befindet. Während eines manuellen Imports ist dieser wahrscheinlich bereits bekannt. Dies kann jedoch bei automatisierten Skripts sehr nützlich sein.

git-import-detect

git-import-hg-raw

Dieses Hilfsprogramm importiert ein Mercurial-Repository in dieses Git-Repository. Weitere Informationen finden Sie unter Importieren aus anderen Versionskontrollsystemen mit der Verwaltungsshell.

git-import-hg-raw

git-import-svn-raw

Dieses Dienstprogramm importiert Daten über den Subversion-Verlauf und über Dateien in einen Git-Branch. Dies ist eine unveränderte Kopie des Baums, wobei Trunk- oder Branch-Unterscheidungen ignoriert werden. Weitere Informationen finden Sie unter Importieren aus anderen Versionskontrollsystemen mit der Verwaltungsshell.

git-import-svn-raw

git-import-tfs-raw

Dieses Dienstprogramm importiert von Team Foundation Version Control (TFVC). Weitere Informationen finden Sie unter Importieren aus anderen Versionskontrollsystemen mit der Verwaltungsshell.

git-import-tfs-raw

git-import-rewrite

Dieses Dienstprogramm schreibt das importierte Repository erneut. Dies gibt dir die Möglichkeit, Autoren umzubenennen, und erzeugt für Subversion und TFVC auf Ordnern basierende Git-Verzweigungen. Weitere Informationen finden Sie unter Importieren aus anderen Versionskontrollsystemen mit der Verwaltungsshell.

git-import-rewrite

Lizenz

ghe-Lizenz

Mit diesem Hilfsprogramm können Sie mit Ihrer aktuellen aktiven Lizenz oder mit neuen Lizenzen interagieren, ohne sie zuerst importieren zu müssen. Sie können die Lizenz auch direkt anwenden, um die Änderungen mit --apply wirksam werden zu lassen. Das Anwenden von Änderungen mit dem Hilfsprogramm ghe-license vermeidet eine Ausführung der Konfiguration und startet nur die betroffenen Dienste neu.

Sie können die möglichen Befehle und Flags mithilfe von ghe-license -h überprüfen.

Alternativ können Sie Lizenzen über die REST-API oder die GitHub CLI. Weitere Informationen findest du unter REST-API-Endpunkte zum Verwalten von GitHub Enterprise Server und Verwalten Ihrer Instanz mithilfe der GitHub CLI.

Anzeigen von Lizenzinformationen. Alternativ können Sie das Flag -j für JSON-Formatierung verwenden.

ghe-license info
# "advanced_security_enabled" : true
# "advanced_security_seats" : 0
# "cluster_support" : false
# "company" : "GitHub"
# "croquet_support" : true
# "custom_terms" : true
# "evaluation" : false
# "expire_at" : "2025-01-01T23:59:59-08:00"
# "insights_enabled" : true
# "insights_expire_at" : "2025-01-01T23:59:59.999-08:00"
# "learning_lab_evaluation_expires" : "2023-01-01T23:59:59.000-08:00"
# "learning_lab_seats" : 100
# "perpetual" : false
# "reference_number" : "123456"
# "seats" : 0
# "ssh_allowed" : true
# "support_key" : null
# "unlimited_seating" : true

Überprüfen der Lizenz.

ghe-license check
# License is valid.

Alle Befehle werden für die vorhandene Lizenz ausgeführt. Sie können jedoch auch eine Lizenz von STDOUT mithilfe von --pipe bereitstellen.

cat license | ghe-license import --pipe
# License imported at /data/user/common/enterprise.ghl.
# License synchronized.

Sie können auch eine Lizenz bereitstellen, indem Sie der Umgebungsvariable GHE_LICENSE_FILE einen Dateipfad zuweisen.

GHE_LICENSE_FILE=/path/license ghe-license import
# License imported at /data/user/common/enterprise.ghl.
# License synchronized.

Migrationen

Elm

          `elm` ist das Befehlszeilentool für Enterprise Live Migrations, ein Tool für Livemigrationen zu GHE.com. Weitere Informationen findest du unter [AUTOTITLE](/migrations/elm/elm-cli-reference).

Sicherheit

ghe-find-insecure-git-operations

Dieses Hilfsprogramm durchsucht die Protokolle deiner Instanz und identifiziert Git-Vorgänge über SSH, die unsichere Algorithmen oder Hashfunktionen verwenden, einschließlich der Verschlüsselungsverfahren DSA, RSA-SHA-1, HMAC-SHA-1 und CBC. Du kannst die Ausgabe verwenden, um den Übergang jedes Clients zu einer sichereren SSH-Verbindung zu unterstützen. Weitere Informationen finden Sie unter the GitHub Blogund AUTOTITLE.

ghe-find-insecure-git-operations

Unterstützung

ghe-diagnostics

Dieses Dienstprogramm führt eine Vielzahl an Überprüfungen durch und erfasst Informationen zu deiner Installation, die du an den Support senden kannst, damit der Support deine Probleme diagnostizieren kann.

Derzeit ähnelt die Ausgabe dieses Hilfsprogramms dem Herunterladen der Diagnoseinformationen in der VerwaltungskonsoleDatei, kann jedoch im Laufe der Zeit zusätzliche Verbesserungen enthalten, die in der Web-Benutzeroberfläche nicht verfügbar sind. Weitere Informationen finden Sie unter Bereitstellen von Daten für GitHub Support.

ghe-diagnostics

ghe-diagnostics-io

Dieses Dienstprogramm sammelt ein I/O-Diagnosepaket von Ihre GitHub Enterprise Server-Instance. Das Paket enthält Daten zur Datenträger-E/A-Leistung, die GitHub-Support bei der Untersuchung speicherbezogener Probleme helfen können.

ghe-diagnostics-io

Sie können optional ein Timeout in Sekunden für die Datensammlung angeben. Der Standardwert beträgt 120 Sekunden.

ghe-diagnostics-io TIMEOUT

ghe-Support-Paket

Standardmäßig erstellt der Befehl den Tarball in /tmp, aber du kannst ihn auch nach cat``STDOUT lassen, um das Streaming über SSH zu erleichtern. Dies ist nützlich, wenn die Web-Benutzeroberfläche nicht antwortet oder der Download eines Support-Bundles von /setup/support nicht funktioniert. Du musst diesen Befehl ausführen, wenn du ein erweitertes Bundle generieren möchtest, das ältere Protokolle enthält. Sie können diesen Befehl auch verwenden, um das Supportpaket direkt zur GitHub Enterprise Unterstützung hochzuladen.

Um ein Standardpaket zu erstellen:

ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o' > support-bundle.tgz

So erstellst du ein Standardbundle, das Daten aus den letzten zwei Tagen enthält:

ssh -p 122 admin@HOSTNAME -- "ghe-support-bundle -p 2days -o" > support-bundle.tgz

So erstellst du ein erweitertes Bundle, das Daten der letzten acht Tage enthält

ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -x -o' > support-bundle.tgz

So senden Sie ein Bündel an GitHub-Support:

ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -u'

Um ein Bündel an GitHub-Support zu senden und es einem Ticket zuzuordnen:

ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -t TICKET_ID'

GHE-Support-Upload

Dieses Hilfsprogramm sendet Informationen von Ihrer Appliance an die GitHub Enterprise Unterstützung. Über STDIN kannst du eine lokale Datei oder einen Datenstrom von bis zu 100 MB angeben. Optional können die hochgeladenen Daten einem Supportticket zugeordnet werden.

So senden Sie eine Datei an GitHub-Support und ordnen sie einem Ticket zu:

ghe-support-upload -f FILE_PATH -t TICKET_ID

Um Daten über STDIN hochzuladen und die Daten mit einem Ticket zu verknüpfen:

ghe-repl-status -vv | ghe-support-upload -t TICKET_ID -d "Verbose Replication Status"

In diesem Beispiel sendet ghe-repl-status -vv ausführliche Statusinformationen aus einer Replikat-Appliance. Du solltest ghe-repl-status -vv durch die spezifischen Daten ersetzen, die du nach STDIN streamen möchtest, und Verbose Replication Status durch eine kurze Beschreibung der Daten. Dies führst du in der Regel nur dann aus, wenn du den Support kontaktiert hast und vom Support dazu aufgefordert wurdest.

Aktualisieren GitHub Enterprise Server

ghe-check-background-upgrade-jobs

Während eines Upgrades auf eine Featureversion zeigt dieses Hilfsprogramm den Status von Hintergrundupgradeaufträgen an, z. B. Elasticsearch-Indexmigrationen, auf Ihre GitHub Enterprise Server-Instance. Wenn Sie Back-to-Back-Upgrades ausführen, sollten Sie dieses Hilfsprogramm verwenden, um zu überprüfen, ob alle Hintergrundaufträge abgeschlossen sind, bevor Sie mit dem nächsten Featureupgrade fortfahren.

ghe-check-background-upgrade-jobs

ghe-migrations

Während eines Upgrades auf eine Funktionsversion zeigt dieses Hilfsprogramm den Status der aktiven Datenbankmigrationen auf Ihre GitHub Enterprise Server-Instance an. Die Ausgabe enthält einen Versionsbezeichner für die Migration, den Namen der Migration, den Status der Migration sowie die aktuelle Dauer der Migration.

Zur Anzeige der Migrationsliste:

ghe-migrations

Standardmäßig gibt das Hilfsprogramm eine Tabelle mit zehn Zeilen aus. Gehe wie folgt vor, um die Höhe der Tabelle in Zeilen anzupassen:

ghe-migrations -height LINES

Standardmäßig wird die Schnellansicht jede Sekunde aktualisiert. Um die Dauer in Sekunden zur Aktualisierung des Visualizers anzugeben:

ghe-migrations -refresh_rate SECONDS

ghe-update-check

Dieses Hilfsprogramm überprüft, ob eine neue Patchversion GitHub Enterprise verfügbar ist. Falls dies der Fall und auf deiner Instanz Speicherplatz verfügbar ist, wird das Paket heruntergeladen. Es wird standardmäßig unter /var/lib/ghe-updates gespeichert. Ein Administrator kann dann das Upgrade ausführen.

Eine Datei mit dem enthaltenen Downloadstatus ist unter /var/lib/ghe-updates/ghe-update-check.status verfügbar.

Verwenden Sie den GitHub Enterprise Schalter, um die neueste -i Version zu überprüfen.

ssh -p 122 admin@HOSTNAME -- 'ghe-update-check'

ghe-upgrade

Dieses Dienstprogramm installiert oder verifiziert ein Upgrade-Paket. Darüber hinaus kannst du dieses Dienstprogramm verwenden, um ein Rollback einer Patch-Veröffentlichung auszuführen, wenn ein Upgrade fehlschlägt oder unterbrochen wird. Weitere Informationen finden Sie unter Übersicht über den Upgradeprozess.

Um ein Upgrade-Paket zu überprüfen:

ghe-upgrade --verify UPGRADE-PACKAGE-FILENAME

Um ein Upgrade-Paket zu installieren:

ghe-upgrade UPGRADE-PACKAGE-FILENAME

Ab Version 3.21 können Betreiber viele der Upgrade-Vorgänge mithilfe einer phasenweisen Ausführung durchführen, ohne dass dafür ein Wartungsfenster erforderlich ist.

Erstausführungsvorgänge, für die kein Wartungsfenster erforderlich ist, indem die Phase vor dem Upgrade ausgelöst wird

ghe-upgrade --phase pre-upgrade UPGRADE-PACKAGE-FILENAME

Sobald dies abgeschlossen ist, können die Operatoren das Upgrade abschließen, indem die letzten Schritte ausgeführt werden, nachdem ein Wartungsfenster geplant wurde.

ghe-upgrade --phase upgrade UPGRADE-PACKAGE-FILENAME

Der aktualisierte GitHub Enterprise Host wird von diesem Vorgang neu gestartet.

Wenn du ein Rollback eines Upgrades durchführst, musst du eine Upgradepaketdatei mit der Erweiterung .pkg verwenden. Hotpatchpaketdateien mit der Erweiterung .hpkg werden nicht unterstützt.

ghe-upgrade --allow-patch-rollback EARLIER-RELEASE-UPGRADE-PACKAGE.pkg

Nach Ausführung des Befehls ist ein Neustart erforderlich. Der Rollback wirkt sich nicht auf die Datenpartition aus, da Migrationen nicht mit Patch-Releases ausgeführt werden.

ghe-upgrade-scheduler

Dieses Dienstprogramm verwaltet die geplante Installation von Upgrade-Paketen. Du kannst geplante Installationen anzeigen, neu erstellen oder entfernen. Pläne müssen mit Cron-Ausdrücken erstellt werden. Weitere Informationen findest du im Eintrag zu Cron in Wikipedia.

Das Hilfsprogramm ghe-upgrade-scheduler eignet sich am besten für die Planung von Hotpatch-Upgrades, für die in den meisten Fällen kein Wartungsmodus oder Neustart erforderlich ist. Dieses Hilfsprogramm eignet sich nicht für vollständige Paketupgrades, bei denen ein Administrator den Wartungsmodus manuell festlegen, die Instanz neu starten und den Wartungsmodus aufheben muss. Weitere Informationen zu den verschiedenen Upgradetypen findest du unter Aktualisierung mit einem Upgrade-Paket.

Um eine neue Installation für ein Paket einzuplanen:

ghe-upgrade-scheduler -c "0 2 15 12 *" UPGRADE-PACKAGE-FILENAME

Um eingeplante Installationen für ein Paket anzuzeigen:

$ ghe-upgrade-scheduler -s UPGRADE PACKAGE FILENAME
> 0 2 15 12 * /usr/local/bin/ghe-upgrade -y -s UPGRADE-PACKAGE-FILENAME > /data/user/common/UPGRADE-PACKAGE-FILENAME.log 2>&1

Um eingeplante Installationen für ein Paket zu entfernen:

ghe-upgrade-scheduler -r UPGRADE PACKAGE FILENAME

Benutzerverwaltung

ghe-Lizenznutzung

Dieses Dienstprogramm exportiert eine Liste von Benutzern der Installation im JSON-Format. Wenn Ihre Instanz mit GitHub Enterprise Cloud verbunden ist, verwendet GitHub Enterprise Server diese Informationen, um Lizenzierungsinformationen an GitHub Enterprise Cloud zu melden. Weitere Informationen finden Sie unter Aktivieren von GitHub Connect für GitHub.com.

Standardmäßig wird die Liste der Benutzer in der resultierenden JSON-Datei verschlüsselt. Überprüfe optionale Flags über ghe-license --help.

ghe-license usage

ghe-org-mitgliedschaft-aktualisierung

Dieses Dienstprogramm erzwingt die standardmäßige Einstellung für die Sichtbarkeit von Mitgliedschaften in der Organisation für alle Mitglieder auf deiner Instanz. Weitere Informationen finden Sie unter Sichtbarkeit für die Organisationsmitgliedschaft konfigurieren. Einstellungsoptionen sind public oder private.

ghe-org-membership-update --visibility=SETTING

ghe-user-csv

Dieses Dienstprogramm exportiert eine Liste aller Benutzer in der Installation im CSV-Format. Die CSV-Datei enthält die E-Mail-Adresse, von welchem Benutzertyp sie sind (z. B. Administrator, Benutzer), über wie viele Repositorys, SSH-Schlüssel und Organisationsmitgliedschaften sie verfügen, wie die letzte protokollierte IP-Adresse lautet usw. Verwende das Flag -h für weitere Optionen.

ghe-user-csv -o > users.csv

ghe-user-demote

Dieses Dienstprogramm stuft den angegebenen Benutzer vom Administratorstatus auf einen gewöhnlichen Benutzer zurück. Du solltest die Web-Benutzeroberfläche verwenden, um diese Aktion durchzuführen, dieses Dienstprogramm jedoch für den Fall bereitstellen, dass das Dienstprogramm ghe-user-promote einen fehlerhaften Zustand aufweist und du einen Benutzer erneut über die CLI zurückstufen musst.

ghe-user-demote USERNAME

ghe-user-promote

Dieses Dienstprogramm stuft das angegebene Benutzerkonto auf einen Websiteadministrator hoch.

ghe-user-promote USERNAME

ghe-user-suspend

Dieses Dienstprogramm sperrt den angegebenen Benutzer, wodurch er sich nicht mehr anmelden, Push- oder Pull-Operationen in deinen Repositorys ausführen kann.

ghe-user-suspend USERNAME

ghe-user-unsuspend (Benutzer-Entsperrung)

Dieses Dienstprogramm hebt die Sperrung des angegebenen Benutzers auf, wodurch ihm der Zugriff für das Anmelden sowie das Pushen und Pullen von deinen Repositories gewährt wird.

ghe-user-unsuspend USERNAME

Datenbank und Speicher

ghe-elasticsearch-watermarks

Dieses Hilfsprogramm konfiguriert die Wasserzeicheneinstellungen von Elasticsearch über die API. Dies ist eine Notfalllösung vom Typ „Break Glass“, die eine Änderung der Wasserzeicheneinstellungen ermöglicht, ohne dass ein Konfigurationslauf erforderlich ist.

So legen Sie die Prozentwerte für Wasserzeichen fest:

ghe-elasticsearch-watermarks set LOW-PERCENT HIGH-PERCENT

So entfernen Sie alle Wasserzeicheneinstellungen und verwenden Die Standardwerte:

ghe-elasticsearch-watermarks remove

So zeigen Sie die aktuellen Wasserzeicheneinstellungen an:

ghe-elasticsearch-watermarks status

ghe-es-repair-status

Dieses Hilfsprogramm zeigt den Status von Elasticsearch-Suchindex-Reparaturvorgängen an Ihre GitHub Enterprise Server-Instance.

ghe-es-repair-status

ghe-es-usage

Dieses Dienstprogramm berechnet die Datenträgernutzung der Indizes in Elasticsearch auf Ihre GitHub Enterprise Server-Instance.

ghe-es-usage

Du kannst die folgenden Flags mit ghe-es-usage verwenden.

ghe-mssql-console

Dieses Hilfsprogramm öffnet eine Microsoft SQL Server-Datenbank Sitzung auf Ihre GitHub Enterprise Server-Instance. Die MSSQL-Datenbank wird von GitHub Actions Diensten verwendet.

ghe-mssql-console

Du kannst die folgenden Flags mit ghe-mssql-console verwenden.

ghe-mssql-diagnostics

Dieses Hilfsprogramm zeigt Diagnoseinformationen für Microsoft SQL Server an, um bei der GitHub-SupportUntersuchungGitHub Actions von Problemen zu helfen.

ghe-mssql-diagnostics

ghe-mssql-health-check

Dieses Dienstprogramm überprüft den Zustand der Microsoft-SQL-Server-Instanz auf Ihre GitHub Enterprise Server-Instance, einschließlich der Sicherungen und Transaktionsprotokolle.

ghe-mssql-health-check

Abhängigkeiten

ghe-dep-graph-enable

Dieses Dienstprogramm aktiviert den Dienst „Dependency Graph“ auf Ihre GitHub Enterprise Server-Instance.

ghe-dep-graph-enable

Monitoring

ghe-otelcol-validate

Dieses Hilfsprogramm validiert die OpenTelemetry Collector-Konfigurationsdatei auf Ihre GitHub Enterprise Server-Instance.

ghe-otelcol-validate