n8n-nodes-github-import-export

Este é um nó comunitário para n8n que permite exportar e importar workflows e credenciais do n8n para/de repositórios GitHub.

Funcionalidades

Exportação

• Exportar workflows do n8n para um repositório GitHub
• Exportar credenciais do n8n para um repositório GitHub (apenas metadados, sem dados sensíveis)
• Filtrar workflows por tags e nomes
• Personalizar caminhos de exportação
• Incluir ou remover IDs de workflows dos nomes de arquivos
• Suporte a múltiplos formatos de encoding (UTF-8 e Base64)

Importação

• Importar workflows de um repositório GitHub para n8n
• Importar credenciais de um repositório GitHub para n8n
• Filtrar arquivos por nome
• Opção para sobrescrever items existentes
• Suporte a múltiplos formatos de encoding (UTF-8 e Base64)

Como usar

Pré-requisitos

• Instância n8n funcionando
• Conta GitHub com um repositório
• Token de acesso pessoal do GitHub com permissões de repositório
• Chave API do n8n (crie em sua instância em Configurações > API)

Obtendo a Chave API do n8n

1. Acesse a sua instância n8n
2. Vá para "Configurações" (ícone de engrenagem no canto superior direito)
3. Clique em "API"
4. Clique em "Criar" para gerar uma nova chave API
5. Copie a chave gerada (você só poderá vê-la uma vez)
6. Ao configurar o nó, use esta chave no campo "API Key" das credenciais n8n API

Importante: Ao configurar as credenciais n8n API, certifique-se de usar a URL correta para o seu servidor n8n. O valor padrão é http://localhost:5678, mas pode variar conforme sua instalação (como http://localhost:5000 no Replit). Para servidores remotos, use o formato https://seu-servidor-n8n.com

Configuração para Exportação

1. Instale o nó em sua instância n8n
2. Configure as credenciais do GitHub e da API do n8n
3. Adicione o nó GitHub Import/Export ao seu workflow
4. Selecione o recurso "Export" e a operação "Export to GitHub"
5. Configure os parâmetros de exportação
6. Execute o workflow para exportar seus dados para o GitHub

Configuração para Importação

1. Instale o nó em sua instância n8n
2. Configure as credenciais do GitHub e da API do n8n
3. Adicione o nó GitHub Import/Export ao seu workflow
4. Selecione o recurso "Import" e a operação "Import from GitHub"
5. Configure os parâmetros de importação (repositório, branch, etc.)
6. Execute o workflow para importar dados do GitHub para seu n8n

Parâmetros

Parâmetros Comuns

• Repository Owner: Nome do proprietário do repositório
• Repository Name: Nome do repositório
• Branch Name: Nome do branch (ex: main, master)

Parâmetros de Exportação

• Export Items: Escolha exportar workflows, credenciais ou ambos
• Workflows Folder Path: Caminho para salvar os workflows
• Credentials Folder Path: Caminho para salvar as credenciais
• Commit Message: Mensagem de commit
• Include Workflow IDs in Filenames: Opção para incluir IDs nos nomes dos arquivos
• Additional Options:
  • Filter Workflows by Tags: Filtrar por tags (separadas por vírgula)
  • Filter Workflows by Name: Filtrar por nome
  • File Encoding: Codificação do arquivo (UTF-8 ou Base64)
  • Remove n8n Metadata: Remover metadados específicos do n8n

Parâmetros de Importação

• Import Items: Escolha importar workflows, credenciais ou ambos
• Workflows Folder Path: Caminho para buscar os workflows
• Credentials Folder Path: Caminho para buscar as credenciais
• Additional Import Options:
  • File Name Filter: Filtrar arquivos por nome
  • File Encoding: Codificação do arquivo (UTF-8 ou Base64)
  • Overwrite Existing Items: Sobrescrever itens existentes

Instalação

1. Instalação via interface do n8n (recomendado)

1. Abra sua instância n8n
2. Vá para Configurações > Nós Comunitários
3. Digite n8n-nodes-github-import-export na barra de pesquisa
4. Clique em Instalar

2. Instalação via linha de comando

Dentro do diretório raiz da sua instalação n8n, execute um dos comandos abaixo:

# Usando npm
npm install @seuusuario/n8n-nodes-github-import-export

# Usando n8n
n8n community-nodes install @seuusuario/n8n-nodes-github-import-export

3. Instalação manual

Opção A: Usando pasta custom (recomendado)

1. Baixe o pacote npm ou use o arquivo seuusuario-n8n-nodes-github-import-export-0.1.0.tgz gerado pelo comando npm pack
2. Crie a estrutura de pastas:

   mkdir -p ~/.n8n/custom/n8n-nodes-github-import-export
   

3. Extraia o arquivo .tgz para a pasta criada:

   tar -xzf seuusuario-n8n-nodes-github-import-export-0.1.0.tgz -C ~/.n8n/custom/n8n-nodes-github-import-export --strip-components=1
   

4. Crie o arquivo index.js na pasta custom:

   cat > ~/.n8n/custom/index.js << 'EOF'
   module.exports = {
       GitHubExporter: require('./n8n-nodes-github-import-export/dist/nodes/GitHubExporter/GitHubExporter.node.js').GitHubExporter,
       GitHubApi: require('./n8n-nodes-github-import-export/dist/credentials/GitHubApi.credentials.js').GitHubApi,
       N8nApi: require('./n8n-nodes-github-import-export/dist/credentials/N8nApi.credentials.js').N8nApi
   };
   EOF
   

5. Reinicie o n8n

Opção B: Copiando para as pastas nodes e credentials

1. Baixe o arquivo .tgz do pacote npm ou use o arquivo gerado pelo comando npm pack
2. Crie as pastas necessárias:

   mkdir -p ~/.n8n/nodes/GitHubExporter
   mkdir -p ~/.n8n/credentials
   

3. Extraia e copie os arquivos:

   tar -xzf seuusuario-n8n-nodes-github-import-export-0.1.0.tgz -C /tmp
   cp -r /tmp/package/dist/nodes/GitHubExporter/* ~/.n8n/nodes/GitHubExporter/
   cp -r /tmp/package/dist/credentials/* ~/.n8n/credentials/
   

4. Reinicie o n8n

Exemplos de Uso

Exportar Workflows para GitHub

1. Crie um novo workflow no n8n
2. Adicione o nó GitHub Import/Export como nó de gatilho (primeiro nó do workflow)
3. Configure as credenciais:
   • GitHub API: Crie um token de acesso pessoal no GitHub com permissões de repo
   • n8n API: Adicione URL do seu n8n e uma chave API de sua instância n8n
4. Configure o nó:
   • Resource: Export
   • Operation: Export to GitHub
   • Repository Owner: seu-usuario
   • Repository Name: backup-n8n
   • Branch Name: main
   • Export: Selecione Workflows, Credentials ou ambos
   • Configure os caminhos das pastas e outras opções
5. Conecte o nó a outros nós para executar ações adicionais após a exportação

Importar Workflows do GitHub

1. Crie um novo workflow no n8n
2. Adicione o nó GitHub Import/Export como nó de gatilho (primeiro nó do workflow)
3. Configure as credenciais (GitHub API e n8n API)
4. Configure o nó:
   • Resource: Import
   • Operation: Import from GitHub
   • Repository Owner: seu-usuario
   • Repository Name: backup-n8n
   • Branch Name: main
   • Import: Selecione Workflows, Credentials ou ambos
   • Configure as opções adicionais como filtro de arquivos e sobrescrita
5. Conecte o nó a outros nós para executar ações adicionais após a importação

Contribuições

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou enviar pull requests.

Licença

MIT