Skip to main content

Instalar aplicativos GitHub

Quando seu aplicativo é público, qualquer pessoa pode usar uma URL de instalação para instalar o aplicativo no seu repositório. Quando seu app é privado, somente você pode instalar o aplicativo em repositórios que você possui.

Observação: seu GitHub App terá acesso a todos os repositórios que o aplicativo criar, mesmo que alguém instale apenas seu aplicativo em repositórios selecionados.

Instalar o seu aplicativo GitHub privado no seu repositório

Depois de criar um aplicativo GitHub privado, é possível instalá-lo em um dos repositórios de organização ou usuário. Para obter mais informações, confira "Fluxo de instalação privada".

  1. Na página de configurações dos Aplicativos do GitHub, selecione seu aplicativo.
  2. Na barra lateral esquerda, clique em Instalar Aplicativo.
  3. Clique em Instalar ao lado da conta pessoal ou de organização que contém o repositório correto.
  4. Instale o aplicativo em todos os repositórios ou repositórios selecionados. Permissões de instalação do aplicativo
  5. Uma vez instalado, você verá as opções de configuração para o aplicativo na conta selecionada. Você pode fazer alterações aqui ou pode repetir as etapas anteriores para instalar o aplicativo em outra conta.

Permitir que pessoas instalem seu aplicativo público no repositório deles

Você pode habilitar outros para instalar seu aplicativo público, fornecendo a URL de instalação em locais como a página inicial do seu aplicativo. Em seguida, você pode apontar para a página inicial do aplicativo a partir da página inicial do GitHub.

Se você estiver migrando de um aplicativo OAuth para um aplicativo GitHub, você pode usar parâmetros de consulta para pré-selecionar os repositórios e a conta ao instalar o aplicativo GitHub. Confira "Como migrar Aplicativos OAuth para Aplicativos do GitHub" para saber mais.

Essas etapas pressupõem que você tenha criado um GitHub App:

  1. Na página de configurações dos Aplicativos do GitHub, selecione o aplicativo público que deseja configurar para que outras pessoas o instalem.
  2. Na "URL da Home Page", digite a URL da home page do aplicativo e clique em Salvar alterações. URL da homepage
  3. O GitHub fornece uma página inicial para o seu aplicativo que inclui um link para a "URL da página inicial" do seu aplicativo. Para visitar a página inicial no GitHub, copie a URL do "Link público" e cole-a em um navegador. Link público
  4. Crie uma home page para seu aplicativo que inclua a URL de instalação do aplicativo: http(s)://HOSTNAME/apps/<app name>/installations/new.

Autorizar usuários durante a instalação

Você pode simplificar o processo de autorização concluindo-o durante a instalação do aplicativo. Para fazer isso, selecione Solicitar autorização do usuário (OAuth) durante a instalação ao criar ou modificar seu aplicativo no GitHub. Confira "Como criar um Aplicativo do GitHub" para saber mais.

Assim que alguém tiver instalado seu aplicativo, você deverá obter um token de acesso para o usuário. Confira as etapas 2 e 3 em "Como identificar usuários no seu site" para saber mais.

Preservar o estado do aplicativo durante a instalação

Você pode fornecer um parâmetro state na URL de instalação de um aplicativo para preservar o estado da página do aplicativo e levar as pessoas de volta a esse estado depois que elas instalarem, se autenticarem ou aceitarem atualizações no Aplicativo do GitHub. Por exemplo, você pode usar o state para correlacionar uma instalação a um usuário ou a uma conta.

Para preservar um estado, adicione-o à URL de instalação:

http(s)://HOSTNAME/apps/<app name>/installations/new?state=AB12t