8kit/8kit repository overview

⁠8kit Service – Automation Memory for Every Workflow

Part of the 8kit⁠ n8n integration framework. See 8kit.io⁠⁠ for full details.

⁠Overview

8kit is a comprehensive automation toolkit that allows you to build bulletproof n8n workflows with proven patterns making 8kit + n8n a fully fledged iPaas Solution.

The 8kit docker image allows you to create your own 8kit server which you can use to connect from our community n8n node. It provides the underlying 8kit service with admin UI to manage your 8kit data.

⁠Highlights

• Persistent automation state – Track processed IDs, cross-system mappings, and "last run" timestamps.
• Duplicate prevention – Deterministic checks stop the same payload from running twice across retries.
• Distributed Transactions – Ensure only one worker handles a critical section at a time.

⁠Getting Started

⁠Quick Start (Docker Compose)

Complete setup with PostgreSQL database included:

services:
  db:
    image: postgres:16-alpine
    container_name: 8kit-postgres
    environment:
      - POSTGRES_DB=service_db
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
      - POSTGRES_INITDB_ARGS=--auth-host=scram-sha-256 --auth-local=trust
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres -d service_db"]
      interval: 5s
      timeout: 3s
      retries: 20
    restart: unless-stopped
    volumes:
      - 8kit_data:/var/lib/postgresql/data

  app:
    image: 8kit/8kit:latest
    container_name: 8kit
    ports:
      - "3000:3000"
    environment:
      - DATABASE_URL=postgresql://postgres:postgres@db:5432/service_db?schema=public
      # - JWT_SECRET=your-custom-minimum-32-char-secret
      # - [email protected]
      # - SUPER_ADMIN_PASSWORD=demo123
      # - LOG_LEVEL=error
      # - JWT_EXPIRES_IN=7d
      # - MAX_REQUEST_SIZE=100kb
      # - DATABASE_CONNECTION_POOL_SIZE=5
    depends_on:
      db:
        condition: service_healthy
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "/health-check.sh"]
      interval: 30s
      timeout: 3s
      start_period: 40s
      retries: 3

volumes:
  8kit_data:

Run with: docker compose up -d

For more configuration options visit 8kit.io/docs⁠.

⁠Configuration

⁠Minimum Required

Only one environment variable is required:

That's it! Everything else has smart defaults.

⁠Optional Configuration

Customize these for production deployments:

⁠Security Best Practices

Generate secure secrets:

# Generate JWT_SECRET (32+ characters)
openssl rand -hex 32

# Or use: https://jwtsecrets.com/#generator

Default credentials:

• Email: [email protected]
• Password: demo123

⚠️ Change these in production!

⁠What's Included

This single Docker image contains:

• ✅ Express API - RESTful backend service
• ✅ React Dashboard - Built-in admin UI (served at /)
• ✅ PostgreSQL Client - Prisma ORM pre-configured
• ✅ Health Checks - Built-in monitoring endpoints
• ✅ Auto-migrations - Database schema updates on startup

⁠Data & Persistence

The application itself is stateless; all data lives in PostgreSQL:

⁠Networking & Health

• Default Port: 3000 (configurable via PORT env var)
• Dashboard: http://localhost:3000/
• API: http://localhost:3000/api/v1
• API Docs: http://localhost:3000/api/docs
• Health Check: GET /health (returns 200 when ready)

Health Check Response:

{
  "status": "healthy",
  "timestamp": "2025-10-01T12:00:00.000Z",
  "uptime": 123.45,
  "environment": "production",
  "version": "1.0.1"
}

⁠Upgrading

Tags follow semantic releases (X.Y.Z). Pin to a specific version in production and upgrade intentionally:

docker pull 8kit/8kit:1.4.0

⁠Resources & Support

• 📘 Documentation: 8kit.io/docs⁠
• 💬 Discord: Discord Community⁠

⁠Documentation

• Service documentation – https://8kit.io/docs⁠ provides deployment guides, API references, and operations playbooks.

⁠Database Compatibility

• Recommended: postgres:16-alpine - Lightweight and production-ready
• Supported: PostgreSQL 14, 15, 16+
• Schema: Managed automatically via Prisma migrations

⁠License

• 📜 8kit License⁠

Built and maintained by Stratagems⁠.