Instalar aplicativos GitHub

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 "Tornar um aplicativo do GitHub público ou privado".

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. Selecione Todos os repositórios ou Selecionar apenas repositórios.
5. Se você escolheu "Selecionar apenas repositórios", selecione o menu suspenso Selecionar repositórios e clique nos repositórios em que deseja instalar o aplicativo.
6. Clique em Instalar. 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.

Oferecer seu aplicativo no GitHub Marketplace

Você pode oferecer uma versão paga ou gratuita do seu aplicativo no GitHub Marketplace, em que as pessoas podem pesquisar e ver detalhes sobre seu aplicativo. O GitHub Marketplace instala automaticamente um aplicativo GitHub quando um pedido é concluído.

Confira "About GitHub Marketplace" para saber mais sobre como listar seu aplicativo no GitHub Marketplace.

Para saber mais sobre como os usuários podem instalar seu aplicativo por meio do GitHub Marketplace, confira "Usar Aplicativos do GitHub".

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 "Migrar aplicativos OAuth para aplicativos 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 guia "Geral", em “URL da página inicial”, digite a URL da página inicial do aplicativo e clique em Salvar alterações.
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.
4. Crie uma home page para seu aplicativo que inclua a URL de instalação do aplicativo: https://github.com/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 "Criar um aplicativo GitHub" para saber mais.

Assim que alguém tiver instalado seu aplicativo, você deverá obter um token de acesso para o usuário. Para obter mais informações, confira "Como gerar um token de acesso do usuário para um GitHub App".

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:

https://github.com/apps/<app name>/installations/new?state=AB12t