Skip to main content

Indexlume documentation

Indexlume is an open-source, self-hosted search operations platform built around Typesense. It combines a web console, REST API, background worker, PostgreSQL metadata store, Redis-backed job queue, and a bundled or external Typesense connection.

Use Indexlume to:

  • create workspaces and projects with owner, admin, editor, and viewer roles;
  • connect read-only PostgreSQL datasets or upload JSONL data;
  • create mapped search collections and alias-backed generations;
  • build versioned relational projections from catalog-backed relationships;
  • run, inspect, retry, cancel, and reconcile indexing jobs;
  • test queries and presets in Search Studio;
  • issue revocable, project-scoped read-only search keys; and
  • inspect aggregate request metrics, latency estimates, and audit activity.
Release boundary

The 0.1.x line is distributed as source and targets a self-hosted, single-machine Docker Compose deployment. Oryxsol does not publish modified Typesense or Redis images with this release.

  1. Install the verified release.
  2. Replace development secrets.
  3. Create the first owner.
  4. Connect PostgreSQL or upload JSONL.
  5. Create a collection and run an indexing job.
  6. Test in Search Studio.
  7. Integrate the public search API.

What Indexlume is not​

Indexlume is not a hosted multi-tenant service, a replacement for Typesense, an arbitrary SQL execution console, or a complete change-data-capture system. Deployment owners remain responsible for TLS, network access, secrets, retention, backups, updates, and capacity.