Where to Find ZincSearch Documentation for Installation, Quickstart, and API Reference
The ZincSearch documentation lives at zincsearch-docs.zinc.dev. From that single site you can reach the Getting started, Installation, and Quickstart pages, the full API Reference (including the Elasticsearch-compatible endpoints), plus Concepts, Environment Variables, Monitoring, Roadmap, Storage, and Telemetry. The site also links to Screenshots and Releases, so you can check platform binaries before you install.
Documentation sections at a glance
The navigation on zincsearch-docs.zinc.dev is organized into these areas:
| Section | What it covers |
|---|---|
| Getting started | Entry point for new users |
| Installation | How to install ZincSearch |
| Quickstart | First-run walkthrough |
| Screenshots | Visual reference for the product |
| Concepts | Core ideas behind the search engine |
| Environment Variables | Configuration via environment |
| Monitoring | Observability of a running instance |
| Roadmap | Planned direction of the project |
| Storage | How data is stored |
| Telemetry | Telemetry behavior |
| Releases | Platform binaries |
| API Reference | Index, Document, Search, User, Version, Metrics |
| ES Compatible API Reference | Elasticsearch-compatible endpoints |
Installation and Quickstart
Start with Getting started, then follow Installation and Quickstart. The project ships as a single binary, and binaries for multiple platforms are published under Releases. Because installation is a single binary rather than a multi-service stack, the Quickstart is the fastest way to confirm the server runs and to reach the embedded Web UI.
The embedded Web UI is written in Vue and is included for querying data, so you can verify a working instance without writing API calls first.
API Reference: native and Elasticsearch-compatible
The API Reference is split into functional groups:
- Index — Create / Update, Delete, List, Get Mapping, Update Mapping, Get Settings, Update Settings, Analyze, Refresh, Data Check Exists
- Document — Create, Create with id, Update, Delete, Bulk, BulkV2, Multi Search
- Search — Search, Search Types, Aggregations, Highlight
- User — Create / Update, Delete, List
- Version and Metrics
A separate ES Compatible API Reference documents the Elasticsearch-compatible surface:
- _info, _license, _xpack
- Index — Get Mapping, Update Mapping, Get Settings, Update Settings, Create Template, Delete Template, Get Template, List Template, Analyze
- Document — Create, Update, Delete, Bulk
- Search — Search, Search Types, Multiple Search, Aggregations, Highlight
If you are migrating from Elasticsearch, use the /es endpoints. The documentation states that Elasticsearch API compatibility covers data ingestion (single record and bulk API), and that Elasticsearch DSL compatibility covers querying. It also notes this compatibility work is in progress — if something does not work, the documented path is to raise a GitHub issue.
Ingestion integrations
Beyond direct API calls, the docs include an Ingestion section with pages for:
- Single Record
- Bulk Ingestion
- Filebeat
- Fluent-bit
- Fluentd
- Syslog-ng
These are the documented routes for feeding data from common log and event shippers.
What to know before you commit
ZincSearch is described as Pre-GA (General Availability) and will be marked production ready at v1.0.0. The stated design goals are full text indexing with less setup effort than Elasticsearch, a single binary, an embedded Vue Web UI, out-of-the-box authentication, and a schema-less model — no need to define a schema upfront, and documents in the same index can have different fields. Aggregation and highlight support are listed as features.
If you need a stable, production-declared search backend today, treat the Pre-GA status as a real constraint and check the Roadmap before adopting. If you want a lightweight single-binary full text search engine with Elasticsearch-compatible ingestion and DSL querying, the Installation and Quickstart pages are the right starting point.