Utilitários de linha de comando

Depois de entrar como usuário administrador com SSH, você pode executar esses comandos de qualquer lugar na VM. Para obter mais informações, consulte "Acessando o shell administrativo (SSH)".

Geral

ghe-announce

Este utilitário insere um banner no topo de cada página do GitHub Enterprise. Você pode usá-lo para enviar uma comunicação a todos os usuários.

Você também pode definir um banner de anúncio usando as configurações empresariais no GitHub Enterprise Server. Para obter mais informações, consulte "Personalizar mensagens de usuário na instância".

# Configura uma mensagem visível para todos
$ ghe-announce -s MESSAGE
> Mensagem de anúncio configurada
# Remove uma mensagem já configurada
$ ghe-announce -u
> Mensagem de anúncio removida

ghe-check-disk-usage

Este utilitário verifica se há arquivos grandes ou arquivos excluídos no disco, mas que ainda têm identificadores abertos. Deve ser executado para liberar espaço na partição raiz.

ghe-check-disk-usage

ghe-cleanup-caches

Este utilitário limpa uma série de caches que podem vir a ocupar espaço extra em disco no volume raiz. Se você perceber que o uso do espaço em disco do volume raiz aumenta muito ao longo do tempo, talvez seja uma boa ideia executar este utilitário e verificar se ele ajuda a reduzir o uso geral.

ghe-cleanup-caches

ghe-cleanup-settings

Este utilitário apaga todas as configurações do Console de gerenciamento.

ghe-cleanup-settings

ghe-config

Com este utilitário, você pode recuperar e modificar as definições de configuração da your GitHub Enterprise Server instance.

$ ghe-config core.github-hostname
# Gera o valor de configuração de `core.github-hostname`
$ ghe-config core.github-hostname 'example.com'
# Define o valor de configuração de `core.github-hostname` como `example.com`
$ ghe-config -l
# Lista todos os valores de configuração

Permite encontrar o identificador universalmente exclusivo (UUID) do seu nó em cluster.conf.

$ ghe-config HOSTNAME.uuid

Permite isentar uma lista de usuários do limite de taxa da API REST. Um limite rígido de 120.000 solicitações ainda será aplicado a esses usuários. Para obter mais informações, consulte "Recursos na API REST".

$ ghe-config app.github.rate-limiting-exempt-users "hubot github-actions"
# Exempts the users hubot and github-actions from rate limits

ghe-config-apply

Este utilitário aplica configurações do Console de gerenciamento, recarrega os serviços do sistema, prepara um dispositivo de armazenamento, recarrega os serviços de aplicativos e executa as migrações pendentes de banco de dados. Ele equivale a clicar em Save settings (Salvar configurações) na IU da web do Console de gerenciamento ou a enviar uma solicitação POST ao ponto de extremidade /setup/api/configure.

É provável que você não precise executar essa ação manualmente, mas é possível fazer isso caso você queira automatizar o processo de salvar suas configurações via SSH.

ghe-config-apply

ghe-console

Este utilitário abre o console do GitHub Rails no appliance do GitHub Enterprise. Não use esse comando sem orientações do Suporte do GitHub Enterprise. O uso incorreto pode causar dano ou perda de dados.

ghe-console

ghe-dbconsole

Este utilitário abre uma sessão do banco de dados MySQL no appliance do GitHub Enterprise. Não use esse comando sem orientações do Suporte do GitHub Enterprise. O uso incorreto pode causar dano ou perda de dados.

ghe-dbconsole

ghe-es-index-status

Este utilitário retorna um resumo dos índices do Elasticsearch no formato CSV.

Imprimir um resumo do índice com uma linha de header em 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

Imprimir um resumo do índice e os resultados em column para facilitar a leitura:

$ 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

Este utilitário lista os repositórios no appliance que usam o GitHub Services, um método de integração que será descontinuado em 1 de outubro de 2018. Os usuários do seu appliance podem ter configurado o GitHub Services para criar notificações de pushes em determinados repositórios. Para obter mais informações, consulte "Anunciar a depreciação dos serviços de GitHub" em GitHub Blog ou "Substituir serviços de GitHub". Para saber mais sobre este comando ou consultar opções adicionais, use o sinalizador -h.

ghe-legacy-github-services-report

ghe-logs-tail

Este utilitário permite registrar todos os arquivos de log relevantes da sua instalação. Você pode passar as opções para limitar os logs a conjuntos específicos. Para consultar opções adicionais, use o sinalizador -h.

ghe-logs-tail

ghe-maintenance

Este utilitário permite controlar o estado do modo de manutenção da instalação. Ele foi desenvolvido para uso principalmente nos bastidores do Console de gerenciamento, mas também pode ser usado diretamente. Para obter mais informações, consulte "Habilitar e programar o modo de manutenção".

ghe-maintenance -h

ghe-motd

Este utilitário exibe novamente a mensagem do dia (MOTD) que os administradores veem quando acessam a instância através do shell administrativo. A saída contém uma visão geral do estado da instância.

ghe-motd

ghe-nwo

Este utilitário retorna o nome e o proprietário de um repositório com base no ID do repositório.

ghe-nwo REPOSITORY_ID

ghe-org-admin-promote

Use este comando para conceder privilégios de proprietário da organização a usuários com privilégios de administrador do site no appliance ou a qualquer usuário em uma única organização. Você deve especificar um usuário e/ou organização. O comando ghe-org-admin-promote sempre solicitará a confirmação antes da execução, a menos que você use o sinalizador -y para ignorar essa etapa.

É possível usar estas opções com o utilitário:

• O sinalizador -u especifica um nome de usuário. Use este sinalizador para conceder privilégios de proprietário da organização a um usuário. Omita o sinalizador -u para promover todos os administradores do site �  organização especificada.
• O sinalizador -o especifica uma organização. Use este sinalizador para conceder privilégios de proprietário em uma organização. Omita o sinalizador -o para conceder permissões de proprietário em todas as organizações a um administrador do site.
• O sinalizador -a concede privilégios de proprietário em todas as organizações a todos os administradores do site.
• O sinalizador -y ignora a confirmação manual.

Este utilitário não pode promover um administrador externo a proprietário de todas as organizações. Para promover uma conta de usuário comum a administrador do site, use ghe-user-promote.

Conceder privilégios de proprietário da organização em uma organização específica para um administrador específico do site

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

Conceder privilégios de proprietário da organização a um administrador do site em todas as organizações

ghe-org-admin-promote -u USERNAME

Conceder privilégios de proprietário da organização a todos os administradores do site em uma organização específica

ghe-org-admin-promote -o ORGANIZATION

Conceder privilégios de proprietário da organização a todos os administradores do site em todas as organizações

ghe-org-admin-promote -a

ghe-reactivate-admin-login

Use este comando para desbloquear imediatamente o Console de gerenciamento após 10 tentativas de login com falha no período de 10 minutos.

$ ghe-reactivate-admin-login

ghe-resque-info

Este utilitário exibe informações sobre trabalhos em segundo plano, ativos e em fila. Ele fornece os mesmos números de contagem de trabalhos que a barra de estatísticas de administração, na parte superior de todas as páginas.

Este utilitário pode ajudar a identificar se o servidor Resque está tendo problemas ao processar trabalhos em segundo plano. Quaisquer dos cenários a seguir podem indicar problemas com o Resque:

• O número de trabalhos em segundo plano está aumentando, e os trabalhos ativos continuam iguais.
• Os feeds de evento não estão sendo atualizados.
• Webhooks não estão sendo acionados.
• A interface web não atualiza após um push do Git.

Se você desconfiar de falha no Resque, entre em contato com o GitHub Enterprise Support.

Com este comando, também é possível pausar ou retomar trabalhos na fila.

$ ghe-resque-info
# lista filas e o número de trabalhos em fila
$ ghe-resque-info -p QUEUE
# pausa a fila especificada
$ ghe-resque-info -r QUEUE
# retoma a fila especificada

ghe-saml-mapping-csv

Este utilitário pode ajudar a mapear os registros SAML.

Para criar um arquivo CSV contendo todo o mapeamento SAML para os seus usuários do GitHub Enterprise Server:

$ ghe-saml-mapping-csv -d

Para executar uma execução seca de atualização de mapeamentos SAML com novos valores:

$ ghe-saml-mapping-csv -u -n -f /path/to/file

Para atualizar os mapeamentos SAML com novos valores:

$ ghe-saml-mapping-csv -u -f /path/to/file

ghe-service-list

Este utilitário lista todos os serviços iniciados ou parados (em execução ou em espera) no appliance.

$ 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

ghe-set-password

Com ghe-set-password, você pode definir uma nova senha para autenticação no Console de gerenciamento.

ghe-set-password 

ghe-ssh-check-host-keys

Este utilitário verifica as chaves do host SSH atuais para identificar chaves vazadas conhecidas.

$ ghe-ssh-check-host-keys

Se houver alguma chave vazada, o utilitário exibirá o status 1 e a seguinte mensagem:

> Uma ou mais chaves do host SSH foram encontradas na lista de bloqueio.
> Redefina suas chaves de host usando ghe-ssh-roll-host-keys.

Se não houver chaves de host vazadas, o utilitário exibirá o status 0 e a seguinte mensagem:

> As chaves de host SSH não foram encontradas na lista de bloqueio.
> No momento, nenhuma etapa adicional é necessária/recomendada.

ghe-ssh-roll-host-keys

Este utilitário acumula as chaves do host SSH e as substitui por chaves recém-geradas.

$ sudo ghe-ssh-roll-host-keys
Continuar para acumular chaves de host SSH? Esta ação excluirá as
chaves atuais em /etc/ssh/ssh_host_* para gerar chaves novas. [y/N]

# Pressione 'Y' para confirmar a exclusão ou use o switch -y para ignorar esta solicitação

> chaves de host SSH foram acumuladas com êxito.

ghe-ssh-weak-fingerprints

Este utilitário retorna um relatório de chaves SSH fracas conhecidas armazenadas no appliance do GitHub Enterprise. Você também pode revogar as chaves do usuário como uma ação em lote. O utilitário relatará as chaves de sistema fracas, que você deve revogar manualmente no Console de gerenciamento.

# Imprimir um relatório de chaves SSH fracas do usuário e do sistema
$ ghe-ssh-weak-fingerprints

# Revogar todas as chaves fracas de usuário
$ ghe-ssh-weak-fingerprints --revoke

ghe-ssl-acme

Este utilitário permite instalar um certificado Let's Encrypt no seu appliance do GitHub Enterprise. Para obter mais informações, consulte "Configurar o TLS".

Você pode usar o sinalizador -x para remover a configuração ACME.

ghe-ssl-acme -e

ghe-ssl-ca-certificate-install

Este utilitário permite instalar um certificado CA personalizado de raiz no seu appliance do GitHub Enterprise. O certificado deve estar no formato PEM. Além disso, se o seu provedor de certificados incluir vários certificados CA em um só arquivo, você deverá separá-los em arquivos a serem passados individualmente para ghe-ssl-ca-certificate-install.

Execute este utilitário para adicionar uma cadeia de certificados para verificação de assinatura de commits S/MIME. Para obter mais informações, consulte "Sobre a verificação de assinatura de commit".

Execute este utilitário quando a your GitHub Enterprise Server instance não conseguir se conectar a outro servidor por ele estar usando um certificado SSL autoassinado ou um certificado SSL para o qual não há o pacote CA necessário. Uma forma de confirmar essa questão é executar openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs na your GitHub Enterprise Server instance. Se o certificado SSL do servidor remoto puder ser verificado, sua SSL-Session deverá ter um código de retorno 0, conforme mostrado abaixo.

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)

Por outro lado, se o certificado SSL do servidor remoto não puder ser verificado, sua SSL-Session deverá ter um código de retorno diferente de zero:

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)

É possível usar estas opções adicionais com o utilitário:

• O sinalizador -r permite desinstalar um certificado CA;
• O sinalizador -h exibe mais informações de uso.

ghe-ssl-ca-certificate-install -c /path/to/certificate

ghe-ssl-certificate-setup

Este utilitário permite atualizar um certificado SSL para your GitHub Enterprise Server instance.

Para saber mais sobre este comando ou consultar opções adicionais, use o sinalizador -h.

ghe-ssl-certificate-setup

ghe-ssl-generate-csr

Com este utilitário, você pode gerar uma chave privada e uma solicitação de assinatura de certificado (CSR, Certificate Signing Request) a ser compartilhada com uma autoridade certificada comercial ou privada para obter um certificado válido na sua instância. Para obter mais informações, consulte "Configurar o TLS".

Para saber mais sobre este comando ou consultar opções adicionais, use o sinalizador -h.

ghe-ssl-generate-csr

ghe-storage-extend

Algumas plataformas exigem este script para aumentar o volume de usuários. Para obter mais informações, consulte "Aumentar a capacidade de armazenamento".

$ ghe-storage-extend

ghe-version

Este utilitário imprime a versão, a plataforma e a compilação de your GitHub Enterprise Server instance.

$ ghe-version

ghe-webhook-logs

Este utilitário retorna logs de entrega de webhook para os administradores revisarem e identificarem problemas.

ghe-webhook-logs

Para exibir todas as entregas de hook falhas do último dia:

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

O formato da data deve ser AAAA-MM-DD, AAAA-MM-DD HH:MM:SS, ou AAAA-MM-DD HH:MM:SS (+/-) HH:M.

Para exibir a carga útil total do hook, o resultado e quaisquer exceções para a entrega:

ghe-webhook-logs -g delivery-guid

Clustering

ghe-cluster-status

Verifique a saúde dos seus nós e serviços em uma implantação de clustering de GitHub Enterprise Server.

$ ghe-cluster-status

ghe-cluster-support-bundle

Este utilitário cria um pacote de suporte tarball com logs importantes de cada nó em configurações de replicação geográfica ou de cluster.

O comando cria o tarball em /tmp por padrão, mas você também pode criar em cat para STDOUT a fim de facilitar a transmissão por SSH. Fazer isso é útil caso a interface da web não responda ou baixe um pacote de suporte de /setup/support que não funcione. Você deve usar este comando se quiser gerar um pacote estendido, com logs mais antigos. Também é possível usá-lo para fazer upload do pacote de suporte de cluster diretamente para o suporte do GitHub Enterprise.

Para criar um pacote padrão:

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

Para criar um pacote estendido:

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

Para enviar um pacote para Suporte do GitHub:

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

Para enviar um pacote para Suporte do GitHub e associar o pacote a um tíquete:

$ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -t ticket-id'

ghe-cluster-failover

Falha ao sair de nós de cluster ativos para nós de cluster passivo. Para obter mais informações, consulte "Iniciar um failover para seu cluster de réplica".

ghe-cluster-failover

ghe-dpages

Este utilitário permite que você gerencie o servidor distribuído GitHub Pages.

ghe-dpages

Para mostrar um resumo da localização e saúde do repositório:

ghe-dpages status

Para evacuar um serviço de armazenamento GitHub Pages antes de evacuar um nó de cluster:

ghe-dpages evacuate pages-server-UUID

ghe-spokes

Este utilitário permite gerenciar as três cópias de cada repositório nos servidores distribuídos do git.

ghe-spokes

Para mostrar um resumo da localização e saúde do repositório:

ghe-spokes status

Para mostrar os servidores em que o repositório está armazenado:

ghe-spokes route

Para evacuar os serviços de armazenamento em um nó de cluster:

ghe-spokes server evacuate git-server-UUID

ghe-storage

Este utilitário permite remover todos os serviços de armazenamento antes de remover um nó de cluster.

ghe-storage evacuate storage-server-UUID

Git

ghe-btop

Interface do tipo top para as operações atuais do Git.

ghe-btop [  | --help | --usage ]

ghe-governor

Este utilitário ajuda a analisar o tráfego do Git. Ela consulta arquivos de dados do Governador, localizados em /data/user/gitmon. GitHub mantém uma hora de dados por arquivo, retidos por duas semanas. Para obter mais informações, consulte Analisando tráfego do Git que usa o Governador em Suporte �  Comunidade GitHub.

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

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

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

Os subcomandos válidos são:
  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

Este utilitário permite mudar para o diretório de um repositório e abrir um shell interativo como usuário do git. Você pode fazer a inspeção ou manutenção manual de um repositório usando comandos como git-* ou git-nw-*.

ghe-repo username/reponame

ghe-repo-gc

Este utilitário reempacota manualmente uma rede de repositórios para otimizar o armazenamento do pacote. Se você tem um repositório muito grande, esse comando pode ajudar a reduzir o tamanho. O GitHub Enterprise executa automaticamente este comando durante toda a sua interação com uma rede de repositórios.

Você pode adicionar o argumento opcional --prune para remover objetos inacessíveis do Git que não são referenciados em um branch, tag ou qualquer outra referência. Fazer isso é útil principalmente para remover de imediato informações confidenciais já eliminadas.

ghe-repo-gc username/reponame

GitHub Actions

ghe-actions-check

Este utilitário verifica se todos os serviços para GitHub Actions são saudáveis. Para obter mais informações, consulte "Primeiros passos com GitHub Actions para GitHub Enterprise Server" e "Solução de problemas GitHub Actions para a sua empresa".

ghe-actions-check

ghe-actions-precheck

Este utilitário testa a configuração de armazenamento do blob para GitHub Actions em your GitHub Enterprise Server instance. Você pode usar o utilitário para verificar sua configuração de armazenamento antes de habilitar o GitHub Actions para sua instância.

Para obter mais informações sobre a configuração de GitHub Actions, consulte "Primeiros passos com GitHub Actions por GitHub Enterprise Server".

ghe-actions-precheck -p [provider] -cs ["connectionstring"]

Se o sistema de armazenamento estiver configurado corretamente, você verá a seguinte saída.

Todos os testes de armazenamento aprovados

Importação e exportação

ghe-migrator

O ghe-migrator é uma ferramenta de alta fidelidade que ajuda a fazer migrações de uma instância do GitHub para outra. Você pode consolidar suas instâncias ou mover a organização, os usuários, as equipes e os repositórios do GitHub.com para o GitHub Enterprise.

Para obter mais informações, consulte nossos guias sobre migração de dados para a sua empresa.

git-import-detect

Em uma URL, detecta qual tipo de sistema de gerenciamento de controle de origem está na outra extremidade. Provavelmente esse processo já é conhecido nas importações manuais, mas pode ser muito útil em scripts automatizados.

git-import-detect

git-import-hg-raw

Este utilitário importa um repositório Mercurial para este repositório Git. Para obter mais informações, consulte "Importando dados de sistemas de controle de versões de terceiros".

git-import-hg-raw

git-import-svn-raw

Este utilitário importa histórico do Subversion e dados de arquivos para um branch do Git. Trata-se de uma cópia direta da árvore, ignorando qualquer distinção de trunk ou branch. Para obter mais informações, consulte "Importando dados de sistemas de controle de versões de terceiros".

git-import-svn-raw

git-import-tfs-raw

Este utilitário faz a importação a partir do Controle de Versão da Fundação da Equipe (TFVC). Para obter mais informações, consulte "Importando dados de sistemas de controle de versões de terceiros".

git-import-tfs-raw

git-import-rewrite

Este utilitário reescreve o repositório importado. Isso dá a você a oportunidade de renomear autores e, para o Subversion e TFVC, produz branches Git baseados em pastas. Para obter mais informações, consulte "Importando dados de sistemas de controle de versões de terceiros".

git-import-rewrite

Suporte

ghe-diagnostics

Este utilitário faz uma série de verificações e reúne informações sobre a instalação que você pode enviar ao suporte para ajudar a diagnosticar problemas.

No momento, a saída do utilitário é semelhante ao download das informações de diagnóstico no Console de gerenciamento, mas ele pode ter melhorias adicionais ao longo do tempo que não estão disponíveis na interface da web. Para obter mais informações, consulte "Criar e compartilhar arquivos de diagnóstico".

ghe-diagnostics

ghe-support-bundle

Esse utilitário cria um tarball do pacote de suporte com logs importantes da sua instância.

O comando cria o tarball em /tmp por padrão, mas você também pode criar em cat para STDOUT a fim de facilitar a transmissão por SSH. Fazer isso é útil caso a interface da web não responda ou baixe um pacote de suporte de /setup/support que não funcione. Você deve usar este comando se quiser gerar um pacote estendido, com logs mais antigos. Também é possível usá-lo para fazer upload do pacote de suporte diretamente para o suporte do GitHub Enterprise.

Para criar um pacote padrão:

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

Para criar um pacote estendido:

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

Para enviar um pacote para Suporte do GitHub:

$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -u'

Para enviar um pacote para Suporte do GitHub e associar o pacote a um tíquete:

$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -t ticket-id'

ghe-support-upload

Este utilitário envia informações do seu appliance para o suporte do GitHub Enterprise. Você pode especificar um arquivo local ou fornecer um fluxo de até 100 MB de dados via STDIN. Os dados carregados também podem ser associados a um tíquete de suporte.

Para enviar um arquivo para Suporte do GitHub e associar o arquivo a um tíquete:

ghe-support-upload -f path/to/your/file -t ticket-id

Para fazer upload de dados via STDIN e associá-los a dados de um tíquete:

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

Neste exemplo, ghe-repl-status -vv envia informações detalhadas do status de um appliance réplica. Substitua ghe-repl-status -vv pelos dados que você deseja transmitir a STDIN e faça uma breve descrição dos dados em Verbose Replication Status. Normalmente, você só executará esse processo se você contacted support (entrar em contato com o suporte) e eles te pediram para fazê-lo.

Atualização do GitHub Enterprise Server

ghe-upgrade

Este utilitário instala ou verifica um pacote de atualização. Também é possível usá-lo para voltar a uma versão de patch em casos de falha ou interrupção de uma atualização. Para obter mais informações, consulte "Atualizar o GitHub Enterprise Server".

Para verificar um pacote de atualização:

ghe-upgrade --verify UPGRADE-PACKAGE-FILENAME

Para instalar um pacote de atualização:

ghe-upgrade UPGRADE-PACKAGE-FILENAME

Ao reverter uma atualização, você deve usar um arquivo de atualização com a extensão .pkg. Arquivos de pacotes de hotpatch com a extensão .hpkg não são suportados.

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

É necessário reinicializar após a execução do comando. Reverter não afeta a partição de dados, pois as migrações não são executadas nas versões de patch.

ghe-upgrade-scheduler

Este utilitário gerencia a instalação programada de pacotes de atualização. Você pode exibir, criar ou remover instalações programadas. Crie as programações usando expressões cron. Para obter mais informações, leia mais sobre Cron na Wikipedia.

Para agendar uma nova instalação para um pacote:

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

Para exibir instalações programadas para um pacote:

$ 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

Para remover instalações programadas para um pacote:

$ ghe-upgrade-scheduler -r UPGRADE PACKAGE FILENAME

ghe-update-check

Este utilitário verificará se uma nova versão do patch do GitHub Enterprise está disponível. Se estiver e se houver espaço disponível na sua instância, ele baixará o pacote. Por padrão, a versão fica salva em /var/lib/ghe-updates. Um administrador pode realizar a atualização.

Um arquivo contendo o status do download fica disponível em /var/lib/ghe-updates/ghe-update-check.status.

Para verificar a versão mais recente do GitHub Enterprise, use o switch -i.

$ ssh -p 122 admin@hostname -- 'ghe-update-check'

Gerenciamento de usuários

ghe-license-usage

Este utilitário exporta uma lista de usuários da instalação em formato JSON. Se sua instância estiver conectada ao GitHub Enterprise Cloud, GitHub Enterprise Server usa essa informação para reportar informações de licenciamento ao GitHub Enterprise Cloud. Para obter mais informações, consulte "Conectando a sua conta corporativa a GitHub Enterprise Cloud ".

Por padrão, a lista de usuários no arquivo JSON resultante é criptografada. Use o sinalizador -h para ver mais opções.

ghe-license-usage

ghe-org-membership-update

Este utilitário aplicará a configuração padrão de visibilidade da associação da organização a todos os integrantes da sua instância. Para obter mais informações, consulte "Configurando a visibilidade da associação �  organização". As opções de configuração são públicas ou privadas.

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

ghe-user-csv

Este utilitário exporta uma lista de todos os usuários na instalação em formato CSV. O arquivo CSV inclui o endereço de e-mail, o tipo de usuário (por exemplo, administrador), a quantidade de repositórios, chaves SSH e associações os usuários têm na organização, o endereço IP mais recente e outras informações. Use o sinalizador -h para ver mais opções.

ghe-user-csv -o > users.csv

ghe-user-demote

Este utilitário rebaixa o usuário especificado do status de administrador para o status de usuário regular. É recomendável usar a IU da web para executar esta ação, mas informe esse utilitário em caso de erro na execução do utilitário ghe-user-promotion se você precisar rebaixar um usuário novamente da CLI.

ghe-user-demote some-user-name

ghe-user-promote

Este utilitário promove a conta de usuário especificada a administrador do site.

ghe-user-promote some-user-name

ghe-user-suspend

Este utilitário suspende o usuário especificado, impedindo-o de fazer login, push ou pull nos seus repositórios.

ghe-user-suspend some-user-name

ghe-user-unsuspend

Este utilitário cancela a suspensão do usuário especificado, liberando o acesso para fazer login, push ou pull nos seus repositórios.

ghe-user-unsuspend some-user-name