> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firecrawl.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Executando Localmente

> Configure o Firecrawl na sua máquina local para desenvolvimento e contribuição.

Este guia explica como executar o servidor da API do Firecrawl na sua máquina local. Siga estas etapas para configurar o ambiente de desenvolvimento, iniciar os serviços e enviar sua primeira requisição.

Se você estiver contribuindo, o processo segue as convenções padrão de código aberto: faça um fork do repositório, faça alterações, execute os testes e abra um pull request. Para tirar dúvidas ou obter ajuda para começar, entre em contato pelo e-mail [help@firecrawl.com](mailto:help@firecrawl.com) ou [envie uma issue](https://github.com/mendableai/firecrawl/issues).

<div id="prerequisites">
  ## Pré-requisitos
</div>

Instale o seguinte antes de prosseguir:

| Dependência | Obrigatório | Guia de instalação                                                                    |
| ----------- | ----------- | ------------------------------------------------------------------------------------- |
| Node.js     | Sim         | [nodejs.org](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs)       |
| pnpm (v9+)  | Sim         | [pnpm.io](https://pnpm.io/installation)                                               |
| Redis       | Sim         | [redis.io](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) |
| PostgreSQL  | Sim         | Via Docker (veja abaixo) ou instalado diretamente                                     |
| Docker      | Opcional    | Necessário para a configuração do contêiner do PostgreSQL                             |

<div id="set-up-the-database">
  ## Configure o banco de dados
</div>

Você precisa de um banco de dados PostgreSQL inicializado com o esquema definido em `apps/nuq-postgres/nuq.sql`. A maneira mais simples é usar a imagem Docker em `apps/nuq-postgres`.

Com o Docker em execução, faça o build e inicie o contêiner:

```bash theme={null}
docker build -t nuq-postgres apps/nuq-postgres
```

```bash theme={null}
docker run --name nuqdb \
  -e POSTGRES_PASSWORD=postgres \
  -p 5433:5432 \
  -v nuq-data:/var/lib/postgresql/data \
  -d nuq-postgres
```

<div id="configure-environment-variables">
  ## Configurar variáveis de ambiente
</div>

Copie o modelo para criar o arquivo `.env` no diretório `apps/api/`:

```bash theme={null}
cp apps/api/.env.example apps/api/.env
```

Para uma configuração local mínima, sem autenticação nem serviços opcionais (processamento de PDF, bloqueio de JavaScript, recursos de IA), use a seguinte configuração:

```bash apps/api/.env theme={null}
# ===== Obrigatório =====
NUM_WORKERS_PER_QUEUE=8
PORT=3002
HOST=0.0.0.0
REDIS_URL=redis://localhost:6379
REDIS_RATE_LIMIT_URL=redis://localhost:6379

## Para ativar a autenticação do banco de dados, você precisa configurar o supabase.
USE_DB_AUTHENTICATION=false

## Conexão PostgreSQL para filas — altere se as credenciais, host ou banco de dados forem diferentes
NUQ_DATABASE_URL=postgres://postgres:postgres@localhost:5433/postgres

# ===== Opcional =====
# SUPABASE_ANON_TOKEN=
# SUPABASE_URL=
# SUPABASE_SERVICE_TOKEN=
# TEST_API_KEY=               # Defina se você configurou autenticação e deseja testar com uma chave de API real
# OPENAI_API_KEY=             # Obrigatório para recursos dependentes de LLM (geração de texto alternativo de imagem, etc.)
# BULL_AUTH_KEY=@
# PLAYWRIGHT_MICROSERVICE_URL= # Defina para executar um fallback do Playwright
# LLAMAPARSE_API_KEY=         # Defina para processar PDFs com o LlamaParse
# SLACK_WEBHOOK_URL=          # Defina para enviar mensagens de status de saúde do servidor para o Slack
# POSTHOG_API_KEY=            # Defina para enviar eventos do PostHog como logs de tarefas
# POSTHOG_HOST=               # Defina para enviar eventos do PostHog como logs de tarefas
```

<div id="install-dependencies">
  ## Instalar dependências
</div>

No diretório `apps/api/`, instale os pacotes com pnpm:

```bash theme={null}
cd apps/api
pnpm install
```

<div id="start-the-services">
  ## Inicie os serviços
</div>

Você precisa de três sessões de terminal rodando simultaneamente: Redis, o servidor de API e um terminal para enviar requisições.

<div id="terminal-1-redis">
  ### Terminal 1 — Redis
</div>

Inicie o servidor Redis em qualquer lugar dentro do projeto:

```bash theme={null}
redis-server
```

<div id="terminal-2-api-server">
  ### Terminal 2 — servidor da API
</div>

Acesse `apps/api/` e inicie o serviço:

```bash theme={null}
pnpm start
```

Isso inicia o servidor da API e os workers responsáveis por processar as tarefas de crawl.

<Note>
  Se você pretende usar o [recurso de extração com LLM](https://github.com/firecrawl/firecrawl/pull/586/), exporte primeiro sua chave de API da OpenAI: `export OPENAI_API_KEY=sk-...`
</Note>

<div id="terminal-3-send-a-test-request">
  ### Terminal 3 — Enviar uma requisição de teste
</div>

Verifique se o servidor está em execução com uma verificação de integridade:

```bash theme={null}
curl -X GET http://localhost:3002/test
```

Isso deve retornar `Hello, world!`.

Para testar o endpoint de crawl:

```bash theme={null}
curl -X POST http://localhost:3002/v1/crawl \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://mendable.ai"
  }'
```

<div id="alternative-docker-compose">
  ## Alternativa: Docker Compose
</div>

Para uma configuração mais simples, o Docker Compose executa todos os serviços (Redis, servidor da API e workers) com um único comando.

1. Certifique-se de que o Docker e o Docker Compose estejam instalados.
2. Copie `.env.example` para `.env` no diretório `apps/api/` e configure conforme necessário.
3. No diretório raiz do projeto, execute:

```bash theme={null}
docker compose up
```

Isso inicia automaticamente todos os serviços com a configuração correta.

<div id="running-tests">
  ## Executando testes
</div>

Execute a suíte de testes com o comando:

```bash theme={null}
npm run test:snips
```