Befehlszeilenprogramme
GitHub Enterprise Server enthält eine Vielzahl an Dienstprogrammen, mit denen bestimmte Probleme behoben oder bestimmte Aufgaben ausgeführt werden können.
Inhalt dieses Artikels
- Allgemein
- ghe-announce
- ghe-check-disk-usage
- ghe-cleanup-caches
- ghe-cleanup-settings
- ghe-config
- ghe-config-apply
- ghe-console
- ghe-dbconsole
- ghe-es-index-status
- git-import
- ghe-legacy-github-services-report
- ghe-logs-tail
- ghe-maintenance
- ghe-nwo
- ghe-org-admin-promote
- ghe-reactivate-admin-login
- ghe-resque-info
- ghe-service-list
- ghe-set-password
- ghe-ssh-check-host-keys
- ghe-ssh-roll-host-keys
- ghe-ssh-weak-fingerprints
- ghe-ssl-acme
- ghe-ssl-ca-certificate-install
- ghe-ssl-generate-csr
- ghe-storage-extend
- ghe-version
- ghe-webhook-logs
- Clustering
- ghe-cluster-support-bundle
- ghe-dpages
- ghe-spokes
- Git
- ghe-btop
- ghe-repo
- ghe-repo-gc
- Import und Export
- ghe-migrator
- Unterstützung
- ghe-diagnostics
- ghe-support-bundle
- ghe-support-upload
- Upgrade von GitHub Enterprise Server
- ghe-upgrade
- ghe-upgrade-scheduler
- ghe-update-check
- Benutzerverwaltung
- ghe-org-membership-update
- ghe-user-csv
- ghe-user-demote
- ghe-user-promote
- ghe-user-suspend
- ghe-user-unsuspend
Sie können diese Befehle überall in der VM ausführen, nachdem Sie sich als ein SSH-Administratorbenutzer angemeldet haben. Weitere Informationen finden Sie unter „Auf die Verwaltungsshell (SSH) zugreifen“.
Allgemein
- ghe-announce
- ghe-check-disk-usage
- ghe-cleanup-caches
- ghe-cleanup-settings
- ghe-config
- ghe-config-apply
- ghe-console
- ghe-dbconsole
- ghe-es-index-status
- git-import
- ghe-legacy-github-services-report
- ghe-logs-tail
- ghe-maintenance
- ghe-nwo
- ghe-org-admin-promote
- ghe-reactivate-admin-login
- ghe-resque-info
- ghe-service-list
- ghe-set-password
- ghe-ssh-check-host-keys
- ghe-ssh-roll-host-keys
- ghe-ssh-weak-fingerprints
- ghe-ssl-acme
- ghe-ssl-ca-certificate-install
- ghe-ssl-generate-csr
- ghe-storage-extend
- ghe-version
- ghe-webhook-logs
Clustering
Git
Import und Export
Unterstützung
Upgrade von GitHub Enterprise Server
Benutzerverwaltung
- ghe-org-membership-update
- ghe-user-csv
- ghe-user-demote
- ghe-user-promote
- ghe-user-suspend
- ghe-user-unsuspend
Allgemein
ghe-announce
Dieses Dienstprogramm liegt im oberen Bereich jeder GitHub Enterprise-Seite einen Banner fest. Diesen können Sie verwenden, um Ihren Benutzer eine Mitteilung zu übermitteln.
Nutzung:
# Legt eine Nachricht fest, die für jedermann sichtbar ist
$ ghe-announce -s MESSAGE
> Announcement message set.
# Entfernt eine zuvor festgelegte Nachricht
$ ghe-announce -u
> Removed the announcement message
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. Sie sollten dieses ausführen, wenn Sie versuchen, auf der Root-Partition Speicherplatz freizugeben.
Nutzung:
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 Sie feststellen, dass sich Ihre Root-Volume-Speicherplatzauslastung mit der Zeit merklich erhöht, empfiehlt es sich, dieses Dienstprogramm auszuführen, um nachzuvollziehen, ob es die Gesamtnutzung reduzieren kann.
Nutzung:
ghe-cleanup-caches
ghe-cleanup-settings
Dieses Dienstprogramm löscht alle vorhandenen Managementkonsole-Einstellungen.
Tipp: Dies führen Sie in der Regel nur dann aus, wenn Sie den Support kontaktiert haben und Sie vom Support dazu aufgefordert wurden.
Nutzung:
ghe-cleanup-settings
ghe-config
Mit diesem Dienstprogramm können Sie die Konfigurationseinstellungen von Ihre GitHub Enterprise Server-Instanz abrufen und ändern.
Nutzung:
$ ghe-config core.github-hostname
# Ruft den Konfigurationswert von „core.github-hostname“ ab
$ ghe-config core.github-hostname 'example.com'
# Legt den Konfigurationswert von „core.github-hostname“ auf „example.com“ fest
$ ghe-config -l
# Listet alle Konfigurationswerte auf
ghe-config-apply
Dieses Dienstprogramm wendet Managementkonsole-Einstellungen an, lädt Systemdienste neu, bereitet ein Speichergerät vor, lädt Anwendungsdienste neu und führt ausstehende Datenbankmigrationen aus. Es entspricht dem Klicken auf Save settings (Einstellungen speichern) auf der Webbenutzeroberfläche in der Managementkonsole oder dem Senden einer POST-Anforderung an den Endpunkt /setup/api/configure
.
Sie müssen dies wahrscheinlich niemals manuell ausführen. Es ist jedoch verfügbar, wenn Sie den Prozess zum Speichern Ihrer Einstellungen über die SSH automatisieren möchten.
Nutzung:
ghe-config-apply
ghe-console
Dieses Dienstprogramm öffnet die GitHub Rails-Konsole auf Ihrer GitHub Enterprise-Appliance. Diesen Befehl sollten Sie ohne Anweisung vom GitHub Enterprise-Support nicht verwenden. Eine falsche Verwendung kann zu Schäden oder Datenverlust führen.
Nutzung:
ghe-console
ghe-dbconsole
Dieses Dienstprogramm öffnet eine MySQL-Datenbanksitzung auf Ihrer GitHub Enterprise-Appliance. Diesen Befehl sollten Sie ohne Anweisung vom GitHub Enterprise-Support nicht verwenden. Eine falsche Verwendung kann zu Schäden oder Datenverlust führen.
Nutzung:
ghe-dbconsole
ghe-es-index-status
Dieses Dienstprogramm gibt eine Zusammenfassung der ElasticSearch-Indizes im CSV-Format zurück.
Nutzung:
Eine Indexzusammenfassung mit einer Header-Kopfzeile für STDOUT
ausgeben:
$ 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
Geben Sie eine Indexzusammenfassung und Pipe-Ergebnisse zur besseren Lesbarkeit für column
aus:
$ 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
git-import
Diese Dienstprogramme sind eine Reihe von Tools, die Elemente aus Subversion, Mercurial und aus der Team Foundation-Versionskontrolle in Git-Repositorys importieren können. Weitere Informationen finden Sie unter „Daten aus Drittanbieter-Quellcodeverwaltungssystemen importieren“.
Einzelne Befehle für „git-import“
- 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-hg-raw
- Importiert ein Mercurial-Repository in dieses Git-Repository.
- git-import-svn-raw
- Importiert Subversion-Verlaufs- und -Dateidaten in einen Git-Branch. Dies ist eine direkte Kopie der Struktur, wobei Trunk- oder Branch-Unterscheidungen ignoriert werden.
- git-import-tfs-raw
- Importiert Elemente aus der Team Foundation-Versionskontrolle.
- git-import-rewrite
- Der letzte Importschritt besteht darin, das Repository neu zu schreiben. Dadurch können Sie Autoren umbenennen. Zudem werden dadurch Git-Branches anhand von Ordnern (für Subversion und TFS) generiert.
ghe-legacy-github-services-report
Dieses Dienstprogramm listet Repositorys auf Ihrer Appliance auf, die GitHub Services verwenden. Hierbei handelt es sich um eine Integrationsmethode, die am 1. Oktober 2018 eingestellt wird. Benutzer auf Ihrer Appliance haben GitHub Services möglicherweise so eingerichtet, dass für Push-Vorgänge an bestimmte Repositorys Benachrichtigungen erstellt werden. Weitere Informationen finden Sie unter „Announcing the deprecation of GitHub Services (Bekanntgabe der Einstellung von GitHub)“ im der GitHub-Blog oder „GitHub Services ersetzen“ in die GitHub-Entwicklerdokumentation. Verwenden Sie das Flag -h
, um weitere Informationen zu diesem Befehl oder um zusätzliche Informationen anzuzeigen.
Nutzung:
ghe-legacy-github-services-report
ghe-logs-tail
Mit diesem Dienstprogramm können Sie das Ende aller relevanten Protokolldateien aus Ihrer Installation ausgeben. Sie können Optionen übergeben, um die Protokolle auf bestimmte Sätze zu begrenzen. Verwenden Sie das Flag „-h“, um zusätzliche Optionen anzuzeigen.
Nutzung:
ghe-logs-tail
ghe-maintenance
Mit diesem Dienstprogramm können Sie den Wartungsmoduszustand der Installation steuern. Es soll primär von der Managementkonsole im Hintergrund verwendet werden, kann jedoch auch direkt verwendet werden.
Nutzung:
ghe-maintenance -h
ghe-nwo
Dieses Dienstprogramm gibt den Namen und den Inhaber eines Repositorys basierend auf der Repository-ID zurück.
Nutzung:
ghe-nwo REPOSITORY_ID
ghe-org-admin-promote
Führen Sie 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. Sie müssen einen Benutzer bzw. eine Organisation angeben. Der Befehl ghe-org-admin-promote
fordert immer zur Bestätigung vor der Ausführung auf, sofern Sie nicht das Flag -y
verwenden, um die Bestätigung zu umgehen.
Die folgenden Optionen können Sie mit dem Dienstprogramm verwenden:
- Das Flag
-u
gibt einen Benutzernamen an. Verwenden Sie dieses Flag, um einem bestimmten Benutzer Organisationsinhaberberechtigungen zu erteilen. Lassen Sie das Flag-u
weg, um alle Websiteadministratoren für die angegebene Organisation hochzustufen. - Das Flag
-o
gibt eine Organisation an. Verwenden Sie dieses Flag, um in einer bestimmten Organisation Inhaberberechtigungen zu erteilen. Lassen Sie 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 können Sie ein gewöhnliches Benutzerkonto auf einen Websiteadministrator hochstufen.
Nutzung:
Einem einzelnen Benutzer 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
Führen Sie diesen Befehl aus, um die Managementkonsole nach 10 fehlerhaften Anmeldeversuchen innerhalb von 10 Minuten sofort zu entsperren.
Nutzung:
$ ghe-reactivate-admin-login
ghe-resque-info
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 Resque-Server beim Verarbeiten der Hintergrundaufträge Probleme hat. Eines der folgenden Szenarien kann auf ein Problem mit Resque hinweisen:
- Die Anzahl der Hintergrundaufträge wird erhöht, während die aktiven Aufträge identisch bleiben.
- Die Ereignis-Feeds werden nicht aktualisiert.
- Dienst-Hooks werden nicht ausgelöst.
- Die Weboberfläche wird nach einem Git-Push nicht aktualisiert.
Wenn Sie vermuten, dass Resque fehlschlägt, wenden Sie sich zur Unterstützung an GitHub Enterprise-Support oder GitHub Premium-Support.
Mit diesem Befehl können Sie Aufträge in der Warteschlange zudem anhalten oder fortsetzen.
Nutzung:
$ ghe-resque-info
# Listet Warteschlangen und die Anzahl der aktuell in die Warteschlange versetzten Aufträge auf
$ ghe-resque-info -p QUEUE
# Hält die angegebene Warteschlange an
$ ghe-resque-info -r QUEUE
# Setzt die angegebene Warteschlange fort
ghe-service-list
Mit diesem Dienstprogramm werden alle Dienste aufgelistet, die auf Ihrer Appliance gestartet oder angehalten (oder ausgeführt werden oder warten) wurden.
Nutzung:
$ ghe-service-list
start/running
- github-resqued, process 12711
- github-unicorn, process 12726
- github-gitauth, process 12743
- git-daemon, process 12755
- babeld, process 12771
- github-svn-proxy, process 12802
- gist-unicorn, process 12832
- gist-resqued, process 12881
- render-unicorn, process 12939
- hookshot-unicorn, process 13076
- nodeload2, process 13192
- slumlord-unicorn, process 13304
- ghe-storage, process 2012
- enterprise-manage-unicorn, process 2024
- enterprise-manage-resque, process 2053
stop/waiting
- ghe-replica-mode
Die von diesem Befehl zurückgegebenen Dienstnamen können mit „Upstart“-Befehlen verwendet werden, um diese Dienste bei Bedarf zu beenden, zu starten oder neu zu starten. Ein Beispiel:
$ sudo restart github-resqued
Das Beenden von Diensten führt zu Ausfallzeiten Ihrer Installation, daher sollten Sie sich an GitHub Enterprise-Support oder GitHub Premium-Support wenden, bevor Sie einen Dienst beenden oder neu starten.
ghe-set-password
Mit ghe-set-password
können Sie ein neues Passwort festlegen, um sich bei der Managementkonsole zu authentifizieren.
Nutzung:
ghe-set-password
ghe-ssh-check-host-keys
Dieses Dienstprogramm gleicht die vorhandenen SSH-Hostschlüssel mit der Liste der bekannten kompromittierten SSH-Hostschlüssel ab.
Nutzung:
$ ghe-ssh-check-host-keys
Wenn ein kompromittierter Hostschlüssel gefunden wird, wird das Dienstprogramm mit dem Status 1
und der folgenden Meldung beendet:
> 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 wurde, wird das Dienstprogramm mit dem Status 0
und der folgenden Meldung beendet:
> 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.
Nutzung:
$ 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]
# Drücken Sie auf „Y“, um den Löschvorgang zu bestätigen, oder verwenden Sie den Switch „-y“, um diese Eingabeaufforderung zu umgehen
> SSH host keys have successfully been rolled.
ghe-ssh-weak-fingerprints
Dieses Dienstprogramm gibt einen Bericht der bekannten unsicheren SSH-Schlüssel zurück, die auf der GitHub Enterprise-Appliance gespeichert sind. Optional können Sie Benutzerschlüssel in einer Massenaktion widerrufen. Das Dienstprogramm meldet unsichere Systemschlüssel, die Sie in der Managementkonsole manuell widerrufen müssen.
Nutzung:
# Bericht der unsicheren Benutzer- und SSH-Systemschlüssel ausgeben
$ ghe-ssh-weak-fingerprints
# Alle unsicheren Benutzerschlüssel widerrufen
$ 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“.
Sie können die folgenden zusätzlichen Optionen mit dem Dienstprogramm verwenden:
- Das Flag
-x
entfernt die ACME-Konfiguration.
Nutzung:
ghe-ssl-acme -e
ghe-ssl-ca-certificate-install
Mit diesem Dienstprogramm können Sie ein benutzerdefiniertes CA-Root-Zertifikat auf Ihrem GitHub Enterprise Server erstellen. Das Zertifikat muss im PEM-Format vorliegen. Wenn Ihr Zertifikatsanbieter darüber hinaus mehrere CA-Zertifikate in eine einzelne Datei aufnimmt, müssen Sie sie in einzelne Dateien trennen, die Sie anschließend jeweils an ghe-ssl-ca-certificate-install
weitergeben.
Führen Sie 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 Dienstprogramm aus, wenn Ihre GitHub Enterprise Server-Instanz keine Verbindung mit einem anderen Server herstellen kann, da Letzterer ein selbstsigniertes SSL-Zertifikat oder ein SSL-Zertifikat verwendet, wofür kein erforderliches CA-Bundle bereitgestellt wird. Eine Möglichkeit, dies zu bestätigen, besteht darin, openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs
auf Ihre GitHub Enterprise Server-Instanz auszuführen. Wenn das SSL-Zertifikat des Remote-Servers verifiziert werden kann, sollte Ihre SSL-Sitzung
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 nicht verifiziert werden kann, sollte Ihre SSL-Sitzung
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)
Sie können die folgenden zusätzlichen Optionen mit dem Dienstprogramm verwenden:
- Mit dem Flag
-r
können Sie ein CA-Zertifikat deinstallieren. - Mit dem Flag
-h
werden mehr Nutzungsinformationen angezeigt.
Nutzung:
ghe-ssl-ca-certificate-install -c /path/to/certificate
ghe-ssl-generate-csr
Mit diesem Dienstprogramm können Sie einen privaten Schlüssel und eine Zertifikatsignierungsanforderung (Certificate Signing Request, CSR) generieren, die Sie für eine kommerzielle oder private Zertifizierungsstelle freigeben können, um ein gültiges Zertifikat abzurufen, das Sie für Ihre Instanz verwenden können. Weitere Informationen finden Sie unter „TLS konfigurieren“.
Verwenden Sie das Flag -h
, um weitere Informationen zu diesem Befehl oder zusätzliche Informationen anzuzeigen.
Nutzung:
ghe-ssl-generate-csr
ghe-storage-extend
Einige Plattformen erfordern dieses Skript, um das Benutzer-Volume zu erweitern. Weitere Informationen finden Sie unter „Speicherkapazität erhöhen“.
Nutzung:
$ ghe-storage-extend
ghe-version
Dieses Dienstprogramm gibt die Version, Plattform und den Build von Ihre GitHub Enterprise Server-Instanz aus.
Nutzung:
$ ghe-version
ghe-webhook-logs
Dieses Dienstprogramm gibt Webhook-Auslieferungsprotokolle für Administratoren zurück, damit diese Issues überprüfen und ermitteln können.
Nutzung:
ghe-webhook-logs
Alle fehlerhaften Hook-Auslieferungen vom Vortag anzeigen
ghe-webhook-logs -f -a YYYYMMDD
Vollständige Hook-Nutzlast und Ausnahmen für die Auslieferung anzeigen
ghe-webhook-logs -g delivery-guid -v
Globale Webhook-Auslieferungen anzeigen
ghe-webhook-logs --global
Clustering
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.
Der Befehl erstellt standardmäßig die Tarball-Datei in /tmp. Sie können die Tarball-Datei für das einfache Streaming über SSH auch mittels cat
an STDOUT
übertragen. Dies ist nützlich, wenn die Webbenutzeroberfläche nicht antwortet oder wenn der Download eines Support-Bundles von /setup/support nicht funktioniert. Sie müssen diesen Befehl ausführen, wenn Sie ein erweitertes Bundle generieren möchten, das ältere Protokolle enthält. Sie können diesen Befehl auch ausführen, um das Cluster-Support-Bundle direkt für den GitHub Enterprise-Support hochzuladen.
Nutzung:
Standard-Bundle
$ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -o' > cluster-support-bundle.tgz
Erweitertes Bundle
$ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -x -o' > cluster-support-bundle.tgz
Bundle an den Support senden
$ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -u'
Bundle an den Support senden und es einem Ticket zuordnen
$ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -t ticket-id'
ghe-dpages
Mit diesem Dienstprogramm können Sie den Server für verteilte Seiten verwalten.
Nutzung:
ghe-dpages
Zusammenfassung zum Repository-Ort und zu dessen Zustand anzeigen
ghe-dpages status
ghe-spokes
Mit diesem Dienstprogramm können Sie die drei Kopien jedes Repositorys auf den verteilten Git-Servern verwalten.
Nutzung:
ghe-spokes
Zusammenfassung zum Repository-Ort und zu dessen Zustand anzeigen
ghe-spokes status
Server anzeigen, auf denen das Repository gespeichert ist
ghe-spokes route
Git
ghe-btop
Eine top
-ähnliche Schnittstelle für alle Git-Vorgänge.
Nutzung:
ghe-btop [ | --help | --usage ]
ghe-repo
Mit diesem Dienstprogramm können Sie das Verzeichnis eines Repositorys ändern und als der Benutzer git
eine interaktive Shell öffnen. Durch Ausführung der Befehle git-*
oder git-nw-*
können Sie die manuelle Untersuchung oder Wartung eines Repositorys durchführen.
Nutzung:
ghe-repo username/reponame
ghe-repo-gc
Mit diesem Dienstprogramm wird ein Repository-Netzwerk neu gepackt, um den Paketspeicher zu optimieren. Wenn Sie über ein großes Repository verfügen, wird seine Größe durch die Ausführung dieses Befehls ggf. reduziert. GitHub Enterprise führt diesen Befehl automatisch während der gesamten Interaktion mit einem Repository-Netzwerk aus.
Sie können das optionale Argument --prune
hinzufügen, um nicht erreichbare Git-Objekte zu entfernen, auf die weder über einen Branch noch über ein Tag oder andere Refs verwiesen wird. Dies ist besonders nützlich zum sofortigen Entfernen zuvor gelöschter sensibler Informationen.
Nutzung:
ghe-repo-gc username/reponame
Import und Export
ghe-migrator
ghe-migrator
ist ein hochwertiges Tool für die Migration von einer GitHub-Instanz zu einer anderen. Sie können Ihre Instanzen konsolidieren oder Ihre Organisation, Benutzer, Teams und Repositorys von GitHub.com nach GitHub Enterprise verschieben.
Weitere Informationen finden Sie in unserem Leitfaden Benutzer-, Organisations- und Repository-Daten migrieren.
Unterstützung
ghe-diagnostics
Dieses Dienstprogramm führt eine Vielzahl an Überprüfungen durch und erfasst Informationen zu Ihrer Installation, die Sie an den Support senden können, damit der Support Ihre Probleme diagnostizieren kann.
Derzeit ähnelt die Ausgabe dieses Dienstprogramms dem Herunterladen der Diagnoseinformationen in der Managementkonsole. Im Laufe der Zeit können ihr jedoch zusätzliche Verbesserungen hinzugefügt werden, die auf der Webbenutzeroberfläche nicht verfügbar sind. Weitere Informationen finden Sie unter „Diagnosedateien erstellen und freigeben“.
Nutzung:
ghe-diagnostics
ghe-support-bundle
Hinweis: Wenn Sie eine Geo-Replikationskonfiguration oder GitHub Enterprise Clustering verwenden, sollten Sie das Support-Bundle mit dem Befehl ghe-cluster-support-bundle
abrufen. Weitere Informationen finden Sie unter „Befehlszeilendienstprogramme“.
Dieses Dienstprogramm erstellt eine Support-Bundle-Tarball-Datei, die wichtige Protokolle aus Ihrer Instanz enthält.
Der Befehl erstellt standardmäßig die Tarball-Datei in /tmp. Sie können die Tarball-Datei für das einfache Streaming über SSH auch mittels cat
an STDOUT
übertragen. Dies ist nützlich, wenn die Webbenutzeroberfläche nicht antwortet oder wenn der Download eines Support-Bundles von /setup/support nicht funktioniert. Sie müssen diesen Befehl ausführen, wenn Sie ein erweitertes Bundle generieren möchten, das ältere Protokolle enthält. Sie können diesen Befehl auch ausführen, um das Support-Bundle direkt für den GitHub Enterprise-Support hochzuladen.
Nutzung:
Standard-Bundle
$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz
Erweitertes Bundle
$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -x -o' > support-bundle.tgz
Bundle an den Support senden
$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -u'
Bundle an den Support senden und es einem Ticket zuordnen
$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -t ticket-id'
ghe-support-upload
Dieses Dienstprogramm sendet Informationen von Ihrer Appliance an den GitHub Enterprise-Support. Sie können eine lokale Datei oder einen Datenstrom von bis zu 100 MB über STDIN
angeben. Optional können die hochgeladenen Daten einem Supportticket zugeordnet werden.
Nutzung:
Datei an den Support senden und sie einem Ticket zuordnen
ghe-support-upload -f path/to/your/file -t ticket-id
Daten über STDIN
hochladen und sie einem Ticket zuordnen
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 von einer Replikat-Appliance. Sie solltenghe-repl-status -vv
durch die bestimmten Daten, die Sie anSTDIN
streamen möchten, undVerbose Replication Status
(Ausführlicher Replikationsstatus) durch eine kurze Beschreibung der Daten ersetzen. Dies führen Sie in der Regel nur dann aus, wenn Sie den Support kontaktiert haben und Sie vom Support dazu aufgefordert wurden.
Upgrade von GitHub Enterprise Server
ghe-upgrade
Dieses Dienstprogramm installiert oder verifiziert ein Upgrade-Paket. Darüber hinaus können Sie 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 „Upgrade von GitHub Enterprise Server“.
Nutzung:
Upgrade-Paket verifizieren
ghe-upgrade --verify UPGRADE-PACKAGE-FILENAME
Upgrade-Paket installieren
ghe-upgrade UPGRADE-PACKAGE-FILENAME
Rollback einer Patch-Veröffentlichung durchführen
Wenn Sie ein Rollback eines Upgrades durchführen, müssen Sie eine Upgrade-Paketdatei mit der Dateinamenerweiterung .pkg verwenden. Hotpatch-Paketdateien mit der Dateinamenerweiterung .hpkg werden nicht unterstützt.
ghe-upgrade --allow-patch-rollback EARLIER-RELEASE-UPGRADE-PACKAGE.pkg
Nach der Ausführung des Befehls ist ein Neustart erforderlich. Der Rollback wirkt sich nicht auf die Datenpartition aus, da Migrationen nicht mit Patch-Veröffentlichung ausgeführt werden.
ghe-upgrade-scheduler
Dieses Dienstprogramm verwaltet die geplante Installation von Upgrade-Paketen. Sie können geplante Installationen anzeigen, neu erstellen oder entfernen. Pläne müssen mit Cron-Ausdrücken erstellt werden. Weitere Informationen finden Sie im Wikipedia-Eintrag zu Cron.
Nutzung:
Neu geplante Installation für ein Paket
$ ghe-upgrade-scheduler -c "0 2 15 12 *" UPGRADE-PACKAGE-FILENAME
Geplante Installationen für ein Paket anzeigen
$ 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
Geplante Installationen für ein Paket entfernen
$ ghe-upgrade-scheduler -r UPGRADE PACKAGE FILENAME
ghe-update-check
Dieses Dienstprogramm überprüft, ob eine neue Patch-Veröffentlichung von GitHub Enterprise verfügbar ist. Falls dies der Fall und auf Ihrer Instanz Speicherplatz verfügbar ist, wird das Paket heruntergeladen. Es wird standardmäßig unter /var/lib/ghe-updates gespeichert. Anschließend kann ein Administrator das Upgrade durchführen.
Eine Datei mit dem enthaltenen Downloadstatus ist unter /var/lib/ghe-updates/ghe-update-check.status verfügbar.
Verwenden Sie den Switch -i
, um nach der neuesten GitHub Enterprise-Version zu suchen.
Nutzung:
$ ssh -p 122 admin@hostname -- 'ghe-update-check'
Benutzerverwaltung
ghe-org-membership-update
Dieses Dienstprogramm erzwingt die standardmäßige Einstellung für die Sichtbarkeit von Mitgliedschaften in der Organisation für alle Mitglieder auf Ihrer Instanz. Weitere Informationen finden Sie unter „Sichtbarkeit für die Organisationsmitgliedschaft konfigurieren“. Die Einstellungsoptionen sind public
(öffentlich) oder private
(privat).
Nutzung:
ghe-org-membership-update --visibility=SETTING
ghe-user-csv
Dieses Dienstprogramm gibt eine Liste aller Benutzer in der Installation im CSV-Format aus. Die CSV-Datei enthält die E-Mail-Adresse, welchen Benutzertyp sie aufweisen (z. B. Administrator, Benutzer), über wie viele Repositorys, SSH-Schlüssel und Organisationsmitgliedschaften sie verfügen, wie die letzte protokollierte IP-Adresse lautet usw. Verwenden Sie das Flag -h
, um weitere Optionen anzuzeigen.
Nutzung:
ghe-user-csv -o > users.csv
ghe-user-demote
Dieses Dienstprogramm stuft den angegebenen Benutzer vom Administratorstatus auf einen gewöhnlichen Benutzer zurück. Sie sollten die Webbenutzeroberflä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 Sie einen Benutzer erneut über die CLI zurückstufen müssen.
Nutzung:
ghe-user-demote some-user-name
ghe-user-promote
Dieses Dienstprogramm stuft das angegebene Benutzerkonto auf einen Websiteadministrator hoch.
Nutzung:
ghe-user-promote some-user-name
ghe-user-suspend
Dieses Dienstprogramm sperrt den angegebenen Benutzer und hindert ihn daran, sich anzumelden oder Elemente per Push-Vorgang an Ihre Repositorys zu übertragen oder aus diesen abzurufen.
Nutzung:
ghe-user-suspend some-user-name
ghe-user-unsuspend
Dieses Dienstprogramm entsperrt den angegebenen Benutzer und gewährt ihm Zugriff, um sich anzumelden und um Elemente per Push-Vorgang an Ihre Repositorys zu übertragen und aus ihnen abzurufen.
Nutzung:
ghe-user-unsuspend some-user-name