Este guia explica como instalar um tema ou componente de tema do Discourse a partir de um repositório privado do GitHub.
Nível de usuário exigido: Administrador
Sumário
Esta documentação cobre o processo de instalação de um tema ou componente de tema do Discourse a partir de um repositório privado do GitHub. Inclui etapas para gerar e usar chaves SSH para acesso seguro. Você precisará ter acesso de administrador tanto à sua instância do Discourse quanto ao repositório do GitHub que está instalando. Veja como você pode usar seus próprios temas e componentes de tema privados em seu fórum.
Pré-requisitos
Antes de começar, certifique-se de ter:
- Acesso de Administrador à sua instância do Discourse
- Um repositório Git privado contendo seu tema ou componente
- Acesso para adicionar chaves de implantação ao seu repositório Git (nível de administrador/proprietário)
Guia passo a passo
- Vá para o seu repositório privado do GitHub e copie o endereço SSH da aba Clone SSH.
2. Navegue até o painel de administração do seu Discourse.
3. Na barra lateral de administração, vá para
Aparência > Temas e componentes e selecione a aba Temas ou Componentes (dependendo do que você está instalando). 4. Clique em
Instalar e, em seguida, selecione De um repositório git.
5. Cole o endereço SSH que você copiou do repositório privado na etapa 1. Deve estar no formato:
git@github.com:USERNAME/REPO-NAME.git.
Certifique-se de usar o link clone with SSH, e não o que começa com
https
6. Uma chave SSH é gerada automaticamente e exibida em uma nova caixa de texto.
7. Clique no ícone de cópia no canto superior direito dessa caixa para copiar a nova chave SSH. Não clique em instalar ou feche esta janela modal ainda.
8. Agora vá para as configurações do seu repositório privado do GitHub (por exemplo, no GitHub, vá para
Settings > Deploy keys)
9. Adicione uma nova chave de implantação. Você terá que dar um título apropriado a ela. Cole a chave SSH que você copiou do Discourse no campo da chave de implantação.
10. Clique em
Add key para salvar a chave de implantação nas configurações do seu repositório Git.
11. Retorne à janela modal de instalação do tema do Discourse e clique no botão
Install. Agora você deverá ver a página de configurações do seu novo tema ou componente.
Melhores práticas
- Sempre use o URL SSH para o seu repositório, não o URL HTTPS.
- Mantenha suas chaves de implantação seguras e não as compartilhe publicamente.
- Atualize regularmente seu tema ou componentes para garantir que você tenha os recursos mais recentes e atualizações de segurança.
FAQs
P: Posso usar este método com provedores Git além do GitHub?
R: Sim, este método deve funcionar com qualquer provedor Git que suporte chaves de implantação ou autenticação SSH.
P: O Discourse lembrará da chave SSH para atualizações futuras?
R: Sim, o Discourse armazenará a chave privada gerada e a usará para acesso futuro ao repositório Git.
P: Posso alterar o repositório privado mais tarde?
R: Sim, você pode atualizar o URL do repositório nas configurações do tema, se necessário.
Recursos adicionais
*As chaves SSH usadas neste tópico foram geradas apenas para esta documentação