Instalando um Aplicativo GitHub de terceiros

Sobre a instalação de GitHub Apps

Este artigo descreve como instalar um GitHub App diretamente do proprietário do aplicativo em vez de usar o GitHub Marketplace. Para obter mais informações sobre como instalar GitHub Apps do GitHub Marketplace, confira Instalando um Aplicativo GitHub por meio do GitHub Marketplace em sua conta pessoal e Instalando um Aplicativo GitHub por meio do GitHub Marketplace em suas organizações. Para obter mais informações sobre como instalar GitHub Apps de sua propriedade, confira Instalando seu próprio aplicativo GitHub.

Para usar um GitHub App em seus recursos, instale o aplicativo em sua conta empresarial, da organização ou pessoal. Você pode instalar o mesmo GitHub App em várias contas. Por exemplo, se você instalar o aplicativo em sua conta pessoa ou em algumas organizações que possui, poderá usar o aplicativo nos repositórios pessoais, nas organizações em que instalou o aplicativo e em repositórios que são propriedade dessas organizações.

Ao instalar um aplicativo, você concede permissão ao aplicativo para acessar os recursos empresariais ou da organização e do repositório que ele solicitou. Durante o processo de instalação, o GitHub informará a você quais permissões o GitHub App solicitou. Para obter mais informações sobre as solicitações da API REST que o GitHub App pode fazer com essas permissões, confira Permissões necessárias para aplicativos GitHub.

Ao instalar um aplicativo que solicita permissões de repositório, você também escolherá a quais repositórios o GitHub App receberá acesso.

Antes de instalar um GitHub App, você deve garantir que confia no proprietário do GitHub App. Você também deve examinar as permissões que o GitHub App está solicitando e confirmar que você está de acordo com a concessão dessas permissões. Para obter mais informações sobre as solicitações da API REST que o GitHub App pode fazer com essas permissões, confira Permissões necessárias para aplicativos GitHub.

Não há limite na quantidade de aplicativos que você pode instalar.

Diferença entre instalação e autorização

Depois de instalar um GitHub App, você também poderá ser solicitado a autorizar o aplicativo.

Ao instalar um GitHub App em sua conta ou organização, você concede ao aplicativo permissão para acessar os recursos de organização e repositório solicitados. Você também especifica quais repositórios o aplicativo pode acessar. Durante o processo de instalação, o GitHub App indicará quais permissões de repositório e organização você está concedendo. Para obter mais informações sobre quais permissões diferentes permitem que um GitHub App faça, confira Escolhendo permissões para um aplicativo GitHub.

Por exemplo, você pode conceder ao GitHub App permissão para gravar problemas e ler metadados do repositório e conceder ao GitHub App acesso a todos os repositórios.

Ao autorizar um GitHub App, você concede a ele acesso à sua conta do GitHub, com base nas permissões de conta solicitadas. Durante o processo de autorização, o aplicativo indicará quais recursos o aplicativo pode acessar em sua conta. Ao autorizar um GitHub App, você também concede ao aplicativo permissão para agir em seu nome.

Por exemplo, você pode conceder ao GitHub App permissão para ler seus endereços de email e gravar gists.

É possível instalar um GitHub App sem autorizar o aplicativo. Da mesma forma, é possível autorizar o aplicativo sem instalá-lo.

Para obter mais informações sobre como autorizar GitHub Apps, confira Autorizando aplicativos GitHub.

Requisitos para instalar um GitHub App

Qualquer pessoa pode instalar GitHub Apps em sua conta pessoal, a menos que seja um Enterprise Managed User.

Os proprietários da organização podem instalar GitHub Apps em sua organização.

Os proprietários de empresa podem instalar GitHub Apps em suas contas empresariais se o aplicativo solicitar permissões empresariais e pertencer à empresa ou a uma de suas organizações.

Os administradores do repositório podem instalar GitHub Apps na organização que possui o repositório, se o aplicativo não requerer permissões da organização nem a permissão de "administração do repositório". Nesse caso, eles só podem instalar o aplicativo apenas com acesso aos repositórios que administram. Proprietários da organização podem restringir a instalação de GitHub App pelos administradores de repositório. Quando essa restrição está habilitada, os administradores do repositório não podem instalar GitHub Apps e, em vez disso, devem solicitar que os proprietários da organização instalem o aplicativo desejado. Para saber mais, confira Limitando as solicitações de acesso e instalações de aplicativos OAuth e GitHub App.

Membros da organização e colaboradores externos que não podem instalar um aplicativo na organização ainda podem selecionar a organização durante o processo de instalação. Em vez de instalar o aplicativo, o GitHub enviará uma notificação ao proprietário da organização para solicitar que ele instale o aplicativo. A capacidade de fazer essas solicitações pode ser controlada usando políticas de solicitação de acesso ao aplicativo. Confira Limitando as solicitações de acesso e instalações de aplicativos OAuth e GitHub App.

A função "gerente de aplicativos" não dá a uma pessoa a capacidade de instalar um GitHub App na organização ou empresa. Confira Sobre Gerenciadores de Aplicativos do GitHub.

Como instalar um GitHub App

Durante o processo de instalação, o proprietário do aplicativo direcionará você para uma URL do GitHub para instalar o GitHub App. A URL será semelhante a https://github.com/apps/APP-NAME/installations/new, em que APP-NAME é o nome do GitHub App.

1. Selecione o local em que você deseja instalar o GitHub App. Você pode selecionar sua conta pessoal ou uma organização da qual você é membro. Se você for um proprietário da empresa e o aplicativo der suporte a empresas, também poderá optar por instalar o aplicativo em sua empresa.

   Observação

   Se a organização usa o SSO do SAML, mas não aparece listada, pode ser necessário iniciar uma sessão SAML ativa para ela. Para saber mais, confira Aplicativos SAML e GitHub.

2. Caso o aplicativo exija permissões do repositório, selecione Todos os repositórios ou Somente repositórios selecionados. O aplicativo sempre terá pelo menos acesso somente leitura a todos os repositórios públicos no GitHub.

   Se o aplicativo não exigir permissões de repositório, essas opções serão omitidas.

3. Se você escolheu Apenas repositórios selecionados na etapa anterior, na lista suspensa Selecionar repositórios, escolha os repositórios que você deseja que o aplicativo acesse.

   Se o aplicativo cria algum repositório, ele também terá acesso a esses repositórios automaticamente.

4. Examine as permissões que o aplicativo está solicitando. Para obter mais informações sobre as solicitações da API REST que o GitHub App pode fazer com essas permissões, confira Permissões necessárias para aplicativos GitHub.

5. Clique em Instalar, Instalar e solicitar ou Solicitar. O botão que é apresentado depende de se o proprietário da organização não deve aprovar nenhum, deve aprovar alguns ou deve aprovar todo o acesso solicitado para o aplicativo. Não é possível solicitar instalações empresariais. O proprietário da empresa deve instalar o aplicativo diretamente. Para obter mais informações, confira Requisitos para instalar um GitHub App.