N8N Documentation BR

Documentação NÃO‑OFICIAL do n8n. Este projeto não possui vínculo com o time oficial do n8n e serve como complemento, referência e apoio aos usuários do Brasil.

Documentação completa do n8n em português brasileiro - Hub de conhecimento para a comunidade brasileira de automação

O que é o n8n?

n8n - Automação de Workflows Segura para Times Técnicos

O n8n é uma plataforma de automação de workflows que oferece a times técnicos a flexibilidade do código com a velocidade do no-code. Com mais de 400 integrações, capacidades nativas de IA e uma licença fair-code, o n8n permite que você construa automações poderosas enquanto mantém controle total sobre seus dados e deployments.

Projeto Documentação n8n Pt-BR

Esta iniciativa não oficial foi criada por Tatiana Barros e Carlos de Lima Junior, com a proposta de tornar a experiência com o n8n mais acessível à comunidade brasileira.

Inspirada pela documentação oficial, esta versão em português busca complementar o conteúdo original, eliminando barreiras linguísticas e criando uma ponte de aprendizado para quem está começando ou deseja se aprofundar no universo da automação.

Além de compartilhar conhecimento, este projeto convida qualquer pessoa a praticar e evoluir em escrita técnica, promovendo um espaço aberto para colaboração, troca de experiências e fortalecimento do ecossistema n8n no Brasil.

A Documentação n8n Pt-BR é comunitária, open source e em evolução constante — feita por devs, para devs.

O que você vai encontrar

A documentação está organizada nas seguintes seções principais:

• Usando n8n: Do zero ao seu primeiro workflow. Aprenda os conceitos básicos, a usar a interface e a manipular dados.
• Deployment: Guias completos para hospedar e configurar o n8n em diferentes ambientes, de Docker a nuvens públicas.
• Cursos: Conteúdo estruturado em formato de texto e vídeo para aprendizado sequencial, do nível básico ao avançado.
• Comunidade: Saiba como contribuir para este projeto e para o ecossistema n8n.
• Referência: Guias de migração, dicas de performance, solução de problemas e um glossário de termos técnicos.
• Release Notes: Fique por dentro de todas as novidades, melhorias e correções a cada versão do n8n. (Em desenvolvimento)

Estrutura da Documentação

Nossa documentação está organizada de forma lógica e intuitiva:

Seções Principais

• /intro - Introdução e conceitos fundamentais
• /primeiros-passos - Guias de instalação e primeiros workflows
• /usando-n8n - Uso prático da plataforma
• /integracoes - Catálogo de integrações e nodes
• /integracoes-br - Integrações específicas do Brasil
• /logica-e-dados - Manipulação de dados e lógica de workflows
• /hosting-n8n - Deployment e hospedagem
• /embed - Integração do n8n em aplicações
• /cursos - Cursos estruturados em texto e vídeo
• /comunidade - Recursos da comunidade
• /contribuir - Como contribuir com o projeto
• /referencia - Guias técnicos e glossário
• /privacidade-seguranca - LGPD e boas práticas de segurança
• /advanced-ai - Recursos avançados de IA
• /api - Documentação da API
• /catalogo - Catálogo de serviços e integrações

Evitando Overlaps de Conteúdo

Para manter a qualidade e evitar redundâncias:

• Use a busca do repositório para checar conteúdo existente.
• Consulte a estrutura em sidebars.ts para posicionar novos tópicos.
• Siga o checklist do CONTRIBUTING.md para revisão pré-PR.

Onde acessar

• Documentação online: https://n8n-brasil.github.io/n8n-Doc-PT-BR/

Compatibilidade de Node.js

Este projeto usa Node.js 20.x como versão principal para desenvolvimento e CI/CD. O Node.js 18.x foi removido da matriz de CI devido a incompatibilidades conhecidas com Docusaurus 3.8.1.

Versões suportadas:

• ✅ Node.js 20.x (recomendado)
• ❌ Node.js 18.x (incompatível com Docusaurus 3.8.1)

Dependências críticas:

• Docusaurus 3.8.1
• React 18.2.0
• TypeScript 5.8.3

Como Contribuir com a Documentação Brasileira

Este é um projeto de código aberto, feito para a comunidade BR n8n, e sua ajuda é fundamental para mantermos a documentação rica e atualizada. Qualquer pessoa pode sugerir melhorias, corrigir erros, criar novos tutoriais ou ajudar na revisão!

• Para um guia técnico rápido sobre como configurar seu ambiente e submeter sua primeira contribuição, veja nosso arquivo: CONTRIBUTING.md.
• Contribuir com esta Documentação: Se você quer ajudar a melhorar esta documentação, corrigindo textos, adicionando exemplos ou traduzindo, comece por aqui.
• Contribuir com o n8n (Oficial): Se seu objetivo é colaborar diretamente com o código-fonte do n8n, criar novos nodes ou participar da documentação oficial em inglês.

Agradecemos imensamente a todos que dedicam seu tempo para fortalecer o n8n no Brasil!

Configuração e Ambiente Local

Para rodar o projeto localmente e contribuir, siga as instruções detalhadas no nosso guia de contribuição.

Para ver os passos completos, consulte o arquivo: CONTRIBUTING.md

Como Executar

Desenvolvimento

# Instalar dependências
npm install

# Iniciar servidor de desenvolvimento
npm run start

# Opções úteis
npm run start:clean    # Mata processos nas portas comuns e inicia
npm run start:alt      # Inicia na porta 3001
npm run dev            # Alias para start

Comandos Úteis

# Matar processos nas portas 3000, 3001, 3002
npm run kill-port

# Build para produção
npm run build

# Servir build de produção
npm run serve

# Deploy para GitHub Pages
# PowerShell (Windows)
$env:GIT_USER='SEU_USUARIO_GITHUB'; npm run deploy:pages
# Linux/macOS
GIT_USER=SEU_USUARIO_GITHUB npm run deploy:pages

Solução de Problemas

Porta 3000 em uso:

# Opção 1: Matar processos manualmente
npm run kill-port
npm run start

# Opção 3: Usar porta alternativa
npm run start:alt

Desenvolvido com carinho para a comunidade n8n Brasil.

Esta documentação é independente e não substitui a documentação oficial do n8n.

Atualizar o Post de Progresso

O post “Progresso da Documentação n8n Brasil” é gerado a partir de scripts/progress.config.json.

1. Edite os status em scripts/progress.config.json.
2. Rode:

npm run progress:update

Isso atualiza o corpo e a data do post em blog/2025-01-01-boas-vindas.md. Em seguida, faça o build/serve para validar.

Como Fazer Deploy no GitHub Pages

Para publicar a documentação no GitHub Pages (branch gh-pages), use o script deploy:pages.

• Windows PowerShell:

  $env:GIT_USER='SEU_USUARIO_GITHUB'; npm run deploy:pages
  

• Linux/macOS:

  GIT_USER=SEU_USUARIO_GITHUB npm run deploy:pages
  

O site será publicado em https://n8n-brasil.github.io/n8n-Doc-PT-BR/.

Compatibilidade de Node.js

Este projeto usa Node.js 20.x como versão principal para desenvolvimento e CI/CD. O Node.js 18.x foi removido da matriz de CI devido a incompatibilidades conhecidas com Docusaurus 3.8.1.

Versões suportadas:

• ✅ Node.js 20.x (recomendado)
• ❌ Node.js 18.x (incompatível com Docusaurus 3.8.1)

Dependências críticas:

• Docusaurus 3.8.1
• React 18.2.0
• TypeScript 5.8.3