Guia de Início Rápido

Esta tradução é anterior aos novos controles de ativação e implantação segura. Use o guia em inglês até que esta página seja atualizada.

Procurando uma forma mais fácil? Use nosso Instalador Desktop para implantação com um clique e configuração automática. Sem linha de comando!

Pré-requisitos

Antes de começar, certifique-se de ter o seguinte instalado em seu sistema:

Docker Engine (20.10.0 ou superior)
Docker Compose (v2.0.0 ou superior)
OpenSSL (para gerar certificados SSL)

Instalando o Docker

Para macOS:

Baixe e instale o Docker Desktop do Docker Hub
Siga o assistente de instalação
Verifique a instalação:

docker --version
docker compose --version

Para Linux (Ubuntu/Debian):

# Atualize o índice de pacotes
sudo apt-get update

# Instale os pré-requisitos
sudo apt-get install \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg \
    lsb-release

# Adicione a chave GPG oficial do Docker
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg

# Configure o repositório estável
echo \
  "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

# Instale o Docker Engine
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin

# Adicione seu usuário ao grupo docker
sudo usermod -aG docker $USER

Para Windows:

Baixe e instale o Docker Desktop do Docker Hub
Habilite o WSL 2 seguindo a documentação do Docker
Siga o assistente de instalação
Verifique a instalação no PowerShell:

docker --version
docker compose --version

Passo 1: Criar Diretório do Projeto

Crie um novo diretório para sua implantação do CaseBender e navegue até ele:

mkdir casebender-deployment
cd casebender-deployment

Passo 2: Configurar Variáveis de Ambiente

Crie um arquivo .env com o seguinte conteúdo:

# Autenticação
AUTH_SECRET="B7OawnWf6+LwB/9yXbxbk4ppZ1khydqj4qc9k9g3nnE="
AUTH_SALT="B7OawnW"
AUTH_TRUST_HOST=true
NEXTAUTH_URL=https://local.casebender.com
NEXTAPP_URL=https://local.casebender.com

# Licença (opcional)
# O CaseBender gera e persiste automaticamente uma chave secreta de licença no
# primeiro boot (armazenada no volume "casebender_secret") e a reutiliza após
# reinicializações e atualizações — nenhuma ação necessária. Defina
# LICENSE_SECRET_KEY apenas se quiser gerenciar a chave você mesmo: fazer backup,
# rotacioná-la ou compartilhá-la entre réplicas. Gere uma com: openssl rand -hex 32
# LICENSE_SECRET_KEY=

# Configuração do Liveblocks (colaboração em tempo real)
LIVEBLOCKS_SECRET_KEY=sk_dev_HaIczPV4gPit5_gx7YRsNXLGJNzBE5wQ8z8I1H8ft3ZPZHVrfH2ryJJ586ezHYla

# Configuração do Banco de Dados (o host é o serviço interno "db")
POSTGRES_PASSWORD=88AlwaysTimeToWin88
POSTGRES_PRISMA_URL="postgresql://superadmin:88AlwaysTimeToWin88@db:5432/casebender?schema=public"
POSTGRES_URL="postgresql://superadmin:88AlwaysTimeToWin88@db:5432/casebender?schema=public"
POSTGRES_URL_NON_POOLING="postgresql://superadmin:88AlwaysTimeToWin88@db:5432/casebender?schema=public"

# Configuração do Redis
REDIS_URL="redis://redis:6379"
# Alternativa de host/porta — lida por todos os serviços (também cobre
# imagens antigas que não interpretam REDIS_URL para a fila de tarefas).
REDIS_HOST=redis
REDIS_PORT=6379

O CaseBender é executado como vários contêineres: a aplicação web (app), um gateway da API REST (api), um gateway de ingestão de alertas (ingestion, que recebe os webhooks de integração como o Microsoft Defender), um worker em segundo plano e os processadores workflow e MISP. O Nginx fica à frente e roteia o tráfego para o serviço correto. Todos estão incluídos no arquivo Compose abaixo.

Passo 3: Gerar Certificados SSL

Para desenvolvimento local, gere certificados SSL autoassinados:

# Gerar certificado SSL e chave
openssl req -x509 -nodes -days 365 -newkey rsa:2048 \
  -keyout local-casebender.key \
  -out local-casebender.crt \
  -subj "/CN=local.casebender.com/O=CaseBender/C=US"

# Verificar o certificado
openssl x509 -in local-casebender.crt -text -noout

Passo 4: Configurar Nginx

Crie nginx.conf com o seguinte conteúdo:

events {
    worker_connections 1024;
}

http {
    # ─── Upstreams ─────────────────────────────────────────────
    upstream web_app {
        server app:3000;
    }

    upstream api_service {
        server api:3005;
    }

    upstream ingestion_service {
        server ingestion:3003;
    }

    # ─── Rate Limiting ─────────────────────────────────────────
    limit_req_zone $binary_remote_addr zone=api_limit:10m rate=100r/s;
    limit_req_zone $binary_remote_addr zone=ingest_limit:10m rate=1000r/s;

    # ─── Redirecionamento HTTP -> HTTPS ────────────────────────
    server {
        listen 80;
        server_name local.casebender.com;
        return 301 https://$server_name$request_uri;
    }

    # ─── Servidor HTTPS Principal ──────────────────────────────
    server {
        listen 443 ssl;
        http2 on;
        server_name local.casebender.com;

        ssl_certificate /etc/nginx/certs/local-casebender.crt;
        ssl_certificate_key /etc/nginx/certs/local-casebender.key;

        ssl_protocols TLSv1.2 TLSv1.3;
        client_max_body_size 100M;

        # ─── Cabeçalhos de Segurança ──────────────────────────
        add_header X-Frame-Options "SAMEORIGIN" always;
        add_header X-Content-Type-Options "nosniff" always;
        add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;

        # ─── API de Ingestão (webhooks de integração) ─────────
        location /api/v1/ingest/ {
            limit_req zone=ingest_limit burst=500 nodelay;
            proxy_pass http://ingestion_service;
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Proto $scheme;
        }

        # Rota de ingestão legada
        location /api/ingest/ {
            limit_req zone=ingest_limit burst=500 nodelay;
            proxy_pass http://ingestion_service;
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Proto $scheme;
        }

        # ─── Gateway da API REST ──────────────────────────────
        location /api/v1/ {
            limit_req zone=api_limit burst=50 nodelay;
            proxy_pass http://api_service;
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Proto $scheme;
        }

        location /api/openapi.json {
            proxy_pass http://api_service;
            proxy_set_header Host $host;
        }

        # ─── Verificação de Saúde ─────────────────────────────
        location /health {
            access_log off;
            return 200 "healthy";
            add_header Content-Type text/plain;
        }

        # ─── Aplicação Web (catch-all) ────────────────────────
        location / {
            proxy_pass http://web_app;
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Proto $scheme;
            proxy_set_header X-Forwarded-Host $host;
            proxy_set_header X-Forwarded-Port $server_port;

            # Suporte a WebSocket
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";

            proxy_connect_timeout 60s;
            proxy_send_timeout 60s;
            proxy_read_timeout 60s;
        }
    }
}

Passo 5: Criar Configuração do Docker Compose

Crie docker-compose.yml com o seguinte conteúdo:

services:
  # ─── Serviços Principais ─────────────────────────────────────
  app:
    image: casebender/casebender:latest
    platform: linux/amd64
    ports:
      - "3000:3000"
    environment:
      - AUTH_SECRET=${AUTH_SECRET}
      - AUTH_SALT=${AUTH_SALT}
      - AUTH_TRUST_HOST=true
      - NEXTAUTH_URL=${NEXTAUTH_URL:-https://local.casebender.com}
      - NEXTAPP_URL=${NEXTAPP_URL:-https://local.casebender.com}
      - LICENSE_SECRET_KEY=${LICENSE_SECRET_KEY}
      - LIVEBLOCKS_SECRET_KEY=${LIVEBLOCKS_SECRET_KEY}
      - POSTGRES_PRISMA_URL=${POSTGRES_PRISMA_URL}
      - POSTGRES_URL=${POSTGRES_URL}
      - POSTGRES_URL_NON_POOLING=${POSTGRES_URL_NON_POOLING}
      - REDIS_URL=${REDIS_URL:-redis://redis:6379}
      - REDIS_HOST=${REDIS_HOST:-redis}
      - REDIS_PORT=${REDIS_PORT:-6379}
    volumes:
      # Mantém o segredo e o blob de licença gerados automaticamente entre
      # atualizações para que `docker compose pull` não regenere a licença.
      - casebender_secret:/app/apps/web/app/secret
    depends_on:
      db:
        condition: service_healthy
      redis:
        condition: service_healthy
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "node -e \"require('http').get('http://localhost:3000/api/health', (r) => process.exit(r.statusCode === 200 ? 0 : 1)).on('error', () => process.exit(1))\""]
      interval: 10s
      timeout: 5s
      retries: 5
      start_period: 60s

  api:
    image: casebender/api:latest
    platform: linux/amd64
    ports:
      - "3005:3005"
    environment:
      - PORT=3005
      - POSTGRES_PRISMA_URL=${POSTGRES_PRISMA_URL}
      - POSTGRES_URL=${POSTGRES_URL}
      - POSTGRES_URL_NON_POOLING=${POSTGRES_URL_NON_POOLING}
      - REDIS_URL=${REDIS_URL:-redis://redis:6379}
      - REDIS_HOST=${REDIS_HOST:-redis}
      - REDIS_PORT=${REDIS_PORT:-6379}
      - AUTH_SECRET=${AUTH_SECRET}
    depends_on:
      db:
        condition: service_healthy
      redis:
        condition: service_healthy
    restart: unless-stopped

  ingestion:
    image: casebender/ingestion:latest
    platform: linux/amd64
    ports:
      - "3003:3003"
    environment:
      - PORT=3003
      - POSTGRES_PRISMA_URL=${POSTGRES_PRISMA_URL}
      - POSTGRES_URL=${POSTGRES_URL}
      - POSTGRES_URL_NON_POOLING=${POSTGRES_URL_NON_POOLING}
      - REDIS_URL=${REDIS_URL:-redis://redis:6379}
      - REDIS_HOST=${REDIS_HOST:-redis}
      - REDIS_PORT=${REDIS_PORT:-6379}
    depends_on:
      db:
        condition: service_healthy
      redis:
        condition: service_healthy
    restart: unless-stopped

  # ─── Serviços de Processamento ───────────────────────────────
  worker:
    image: casebender/worker:latest
    platform: linux/amd64
    ports:
      - "3002:3002"
    environment:
      - PORT=3002
      - POSTGRES_PRISMA_URL=${POSTGRES_PRISMA_URL}
      - POSTGRES_URL=${POSTGRES_URL}
      - POSTGRES_URL_NON_POOLING=${POSTGRES_URL_NON_POOLING}
      - REDIS_URL=${REDIS_URL:-redis://redis:6379}
      - REDIS_HOST=${REDIS_HOST:-redis}
      - REDIS_PORT=${REDIS_PORT:-6379}
    depends_on:
      db:
        condition: service_healthy
      redis:
        condition: service_healthy
    restart: unless-stopped

  workflow-processor:
    image: casebender/workflow-processor:latest
    platform: linux/amd64
    ports:
      - "3001:3001"
    environment:
      - POSTGRES_PRISMA_URL=${POSTGRES_PRISMA_URL}
      - POSTGRES_URL=${POSTGRES_URL}
      - POSTGRES_URL_NON_POOLING=${POSTGRES_URL_NON_POOLING}
      - REDIS_URL=${REDIS_URL:-redis://redis:6379}
      - REDIS_HOST=${REDIS_HOST:-redis}
      - REDIS_PORT=${REDIS_PORT:-6379}
    depends_on:
      db:
        condition: service_healthy
      redis:
        condition: service_healthy
      app:
        condition: service_healthy
    restart: unless-stopped

  misp-processor:
    image: casebender/misp-processor:latest
    platform: linux/amd64
    ports:
      - "3004:3004"
    environment:
      - PORT=3004
      - POSTGRES_PRISMA_URL=${POSTGRES_PRISMA_URL}
      - POSTGRES_URL=${POSTGRES_URL}
      - POSTGRES_URL_NON_POOLING=${POSTGRES_URL_NON_POOLING}
      - REDIS_URL=${REDIS_URL:-redis://redis:6379}
      - REDIS_HOST=${REDIS_HOST:-redis}
      - REDIS_PORT=${REDIS_PORT:-6379}
    depends_on:
      db:
        condition: service_healthy
      redis:
        condition: service_healthy
      app:
        condition: service_healthy
    restart: unless-stopped

  # ─── Infraestrutura ──────────────────────────────────────────
  db:
    image: postgres:17
    environment:
      POSTGRES_USER: superadmin
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-88AlwaysTimeToWin88}
      POSTGRES_DB: casebender
    ports:
      - "5433:5432"
    volumes:
      - pgdata:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U superadmin -d casebender"]
      interval: 5s
      timeout: 5s
      retries: 10
      start_period: 30s
    restart: unless-stopped

  redis:
    image: redis:7.2-alpine
    command: redis-server --protected-mode no
    ports:
      - "6379:6379"
    volumes:
      - redis_data:/data
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 5s
      timeout: 3s
      retries: 5
    restart: unless-stopped

  minio:
    image: quay.io/minio/minio
    mem_limit: 512m
    command: ["minio", "server", "/data", "--console-address", ":9090"]
    environment:
      - MINIO_ROOT_USER=minioadmin
      - MINIO_ROOT_PASSWORD=minioadmin
    ports:
      - "9090:9090"
      - "9000:9000"
    volumes:
      - "miniodata:/data"
    restart: unless-stopped

  # ─── Proxy Reverso ───────────────────────────────────────────
  nginx:
    image: nginx:alpine
    ports:
      - "443:443"
      - "80:80"
    volumes:
      - ./nginx.conf:/etc/nginx/nginx.conf:ro
      - ./local-casebender.crt:/etc/nginx/certs/local-casebender.crt:ro
      - ./local-casebender.key:/etc/nginx/certs/local-casebender.key:ro
    depends_on:
      app:
        condition: service_healthy
    restart: unless-stopped

volumes:
  miniodata:
  pgdata:
  redis_data:
  casebender_secret:

Passo 6: Configurar DNS Local

Adicione a seguinte entrada ao seu arquivo hosts:

Para macOS e Linux:

sudo echo "127.0.0.1 local.casebender.com" >> /etc/hosts

Para Windows:

Adicione a seguinte linha ao arquivo C:\Windows\System32\drivers\etc\hosts:

127.0.0.1 local.casebender.com

Passo 7: Iniciar a Aplicação

Baixe as imagens necessárias:

docker compose pull

Inicie todos os serviços:

docker compose up -d

Monitore os logs:

docker compose logs -f

Acesse a aplicação em https://local.casebender.com

Após implantar o CaseBender, você pode fazer login com as seguintes credenciais padrão:

Usuário: admin@casebender.app
Senha: secret1234

Por razões de segurança, recomendamos fortemente que você altere essas credenciais padrão imediatamente após o seu primeiro login.

Executando atrás de um proxy corporativo

Se o seu host só consegue acessar a internet através de um proxy HTTP corporativo (redes “somente proxy”), as chamadas de saída do CaseBender — ativação de licença e integrações como Microsoft Defender e Splunk — precisam ser roteadas através dele. Adicione as variáveis de proxy ao seu .env:

HTTP_PROXY=http://proxy.example.com:8080
HTTPS_PROXY=http://proxy.example.com:8080
# Os serviços internos do Docker (e quaisquer destinos on-premise) DEVEM ignorar o proxy:
NO_PROXY=127.0.0.1,localhost,db,redis,minio,api,ingestion,worker,workflow-processor,misp-processor,search-sync,opensearch

Em seguida, passe-as para cada serviço do CaseBender adicionando estas linhas ao bloco environment: de cada serviço no docker-compose.yml:

      - HTTP_PROXY=${HTTP_PROXY:-}
      - HTTPS_PROXY=${HTTPS_PROXY:-}
      - NO_PROXY=${NO_PROXY:-}

NO_PROXY deve incluir os nomes dos serviços internos do Docker acima. Caso contrário, o tráfego entre contêineres (por exemplo, o app web chamando o serviço de ingestion) é enviado ao proxy corporativo e falha — quebrando a aplicação mesmo sem ter nada a ver com a internet.

Quais destinos passam pelo proxy? Endpoints públicos devem passar pelo proxy e NÃO devem estar em NO_PROXY — por exemplo, Microsoft Defender (login.microsoftonline.com, graph.microsoft.com). Destinos on-premise devem ser listados em NO_PROXY para serem alcançados diretamente — por exemplo, um Splunk HEC interno. Se você usa Splunk Cloud, deixe-o de fora para que seja roteado pelo proxy.

Verifique a conectividade de dentro de um contêiner (usa node, sem precisar de curl):

docker compose exec app node -e "fetch('https://login.microsoftonline.com/',{signal:AbortSignal.timeout(5000)}).then(r=>console.log('OK',r.status)).catch(e=>console.log('FAIL',e.message))"

Quando um proxy está configurado, cada serviço registra [proxy] Outbound fetch routed through corporate proxy (...) na inicialização.

Solução de Problemas

Problemas Comuns

Avisos de Certificado:
- O navegador mostrará um aviso de segurança porque estamos usando um certificado autoassinado
- Clique em “Avançado” e prossiga para o site
- Para fins de desenvolvimento, isso é esperado e seguro
Conflitos de Porta:
- Certifique-se de que as portas 80, 443, 3000, 3001, 3002, 3003, 3004, 3005, 5433, 6379, 9000 e 9090 não estão em uso
- Se necessário, modifique os mapeamentos de porta no docker-compose.yml
Conexão com o Banco de Dados:
- Verifique os logs do PostgreSQL: docker compose logs db
- Verifique as credenciais do banco de dados no arquivo .env
- Certifique-se de que o banco de dados está em execução: docker compose ps db
Dependências de Serviço:
- Se os serviços falharem ao iniciar, verifique suas dependências:
docker compose ps docker compose logs [nome_do_serviço]

Verificando Logs

Visualize logs para serviços específicos:

# Todos os serviços
docker compose logs

# Serviço específico
docker compose logs [nome_do_serviço]

# Acompanhar logs
docker compose logs -f [nome_do_serviço]

Gerenciamento de Serviços

# Reiniciar um serviço específico
docker compose restart [nome_do_serviço]

# Parar todos os serviços
docker compose down

# Remover volumes (excluirá todos os dados)
docker compose down -v

Próximos Passos

Agora que você tem o CaseBender funcionando localmente, você pode querer:

Implantação em Produção

Implante o CaseBender em seu ambiente de produção

Configuração

Aprenda sobre opções avançadas de configuração

Primeiros Passos

Implantação

Gerenciamento de Alertas

Gerenciamento de Casos

Gerenciamento de Tarefas

Análises

Auditorias

Configurações

Guia de Início Rápido

Pré-requisitos

Instalando o Docker

Para macOS:

Para Linux (Ubuntu/Debian):

Para Windows:

Passo 1: Criar Diretório do Projeto

Passo 2: Configurar Variáveis de Ambiente

Passo 3: Gerar Certificados SSL

Passo 4: Configurar Nginx

Passo 5: Criar Configuração do Docker Compose

Passo 6: Configurar DNS Local

Para macOS e Linux:

Para Windows:

Passo 7: Iniciar a Aplicação

Executando atrás de um proxy corporativo

Solução de Problemas

Problemas Comuns

Verificando Logs

Gerenciamento de Serviços

Próximos Passos

Implantação em Produção

Configuração

​Pré-requisitos

​Instalando o Docker

​Para macOS:

​Para Linux (Ubuntu/Debian):

​Para Windows:

​Passo 1: Criar Diretório do Projeto

​Passo 2: Configurar Variáveis de Ambiente

​Passo 3: Gerar Certificados SSL

​Passo 4: Configurar Nginx

​Passo 5: Criar Configuração do Docker Compose

​Passo 6: Configurar DNS Local

​Para macOS e Linux:

​Para Windows:

​Passo 7: Iniciar a Aplicação

​Credenciais de Login Padrão

​Executando atrás de um proxy corporativo

​Solução de Problemas

​Problemas Comuns

​Verificando Logs

​Gerenciamento de Serviços

​Próximos Passos

Implantação em Produção

Configuração

Pré-requisitos

Instalando o Docker

Para macOS:

Para Linux (Ubuntu/Debian):

Para Windows:

Passo 1: Criar Diretório do Projeto

Passo 2: Configurar Variáveis de Ambiente

Passo 3: Gerar Certificados SSL

Passo 4: Configurar Nginx

Passo 5: Criar Configuração do Docker Compose

Passo 6: Configurar DNS Local

Para macOS e Linux:

Para Windows:

Passo 7: Iniciar a Aplicação

Credenciais de Login Padrão

Executando atrás de um proxy corporativo

Solução de Problemas

Problemas Comuns

Verificando Logs

Gerenciamento de Serviços

Próximos Passos