8kit/service-8kit-community 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 with three core components: an n8n node for workflow integration, a lightweight service for data synchronization, and an admin dashboard for management — making your automations faster, safer, and smarter.

⁠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

⁠One-liner (Docker Run)

⚠️ Database Required: 8kit requires a PostgreSQL database to function. Choose one of the options below:

⁠Option 1: Local Database (PostgreSQL running on your host)

If you have PostgreSQL running locally on your machine:

docker pull 8kit/service-8kit-community:latest

docker run -d \
  --name 8kit-service \
  --network host \
  -e DATABASE_URL="postgresql://postgres:[email protected]:5432/8kit" \
  -e API_KEY="replace-with-admin-key" \
  -e JWT_SECRET="replace-with-32-char-secret" \
  8kit/service-8kit-community:latest

• Uses --network host for local database connectivity
• Access via http://localhost:3000
• Health probe: curl http://localhost:3000/health

⁠Option 2: Managed Database (External PostgreSQL service)

If you're using a managed database service (AWS RDS, Google Cloud SQL, Azure Database, etc.):

docker pull 8kit/service-8kit-community:latest

docker run -d \
  --name 8kit-service \
  -p 4000:3000 \
  -e DATABASE_URL="your-managed-database-connection-string" \
  -e API_KEY="replace-with-admin-key" \
  -e JWT_SECRET="replace-with-32-char-secret" \
  8kit/service-8kit-community:latest

• Replace your-managed-database-connection-string with your actual database URL
• Container listens on port 3000 by default, mapped to host port 4000
• Health probe: curl http://localhost:4000/health

⁠Docker Compose (service + Postgres + UI)

For complete docker compose visit 8kit.io/docs⁠ for more configuration options and examples.

⁠Configuration

⁠Generating Secure Secrets

For the JWT_SECRET requirement (32+ characters), you can use this online generator: https://jwtsecrets.com/#generator⁠

⁠Super Admin Credentials

The SUPER_ADMIN_EMAIL and SUPER_ADMIN_PASSWORD are required for accessing the 8kit admin dashboard. These credentials will be used to log into the web interface at https://hub.docker.com/r/8kit/ui-8kit-community⁠.

⁠Data & Persistency

The application itself is stateless; persistence lives in Postgres. Typical mounts:

⁠Networking & Health

• Default listener: 0.0.0.0:3000
• Built-in health check: GET /health (returns 200 when ready)
• If you override PORT, ensure your orchestration health probes hit the new port—Docker’s built-in check assumes 3000.

⁠Upgrading

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

docker pull 8kit/service-8kit-community:1.4.0

⁠Resources & Support

• 📘 Documentation: 8kit.io/docs⁠
• 🧑‍💻 Source code: https://github.com/8kit-io/service-8kit-community⁠
• 💬 Discord: Discord Community⁠
• 🐞 Issues / feature requests: open a ticket on GitHub

⁠Documentation

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

⁠Companion Images

• 8kit/ui-8kit-community⁠ – Admin dashboard that surfaces sets, lookups, locks, and violations.
• postgres:16-alpine⁠ – Recommended Postgres base image for production-grade persistence.

⁠License

• 📜 8kit License⁠

Built and maintained by Stratagems⁠.