xiaojun207/zinc repository overview

⁠Zinc Search Engine

Zinc is a search engine that does full text indexing. It is a lightweight alternative to Elasticsearch and runs using a fraction of the resources. It uses bluge⁠ as the underlying indexing library.

It is very simple and easy to operate as opposed to Elasticsearch which requires a couple dozen knobs to understand and tune which you can get up and running in 2 minutes

It is a drop-in replacement for Elasticsearch if you are just ingesting data using APIs and searching using kibana (Kibana is not supported with zinc. Zinc provides its own UI).

Check the below video for a quick demo of Zinc.

⁠Quickstart

mkdir data
docker run -v /full/path/of/data:/data -e ZINC_DATA_PATH="/data" -p 4080:4080 \
    -e ZINC_FIRST_ADMIN_USER=admin -e ZINC_FIRST_ADMIN_PASSWORD='Complexpass#123' \
    --name zinc xiaojun207/zinc:latest

Now point your browser to http://localhost:4080⁠ and login

⁠Playground Server

You could try ZincSearch without installing using below details:

Note: Do not store sensitive data on this server as its available to everyone on internet. Data will also be cleaned on this server regularly.

⁠Join slack channel

⁠Why zinc

While Elasticsearch is a very good product, it is complex and requires lots of resources and is more than a decade old. I built Zinc so it becomes easier for folks to use full text search indexing without doing a lot of work.

⁠Features:

1. Provides full text indexing capability
2. Single binary for installation and running. Binaries available under releases for multiple platforms.
3. Web UI for querying data written in Vue
4. Compatibility with Elasticsearch APIs for ingestion of data (single record and bulk API)
5. Out of the box authentication
6. Schema less - No need to define schema upfront and different documents in the same index can have different fields.
7. Index storage in s3 and minio (experimental)
8. aggregation support

⁠Roadmap items:

Public roadmap is available at https://github.com/orgs/zinclabs/projects/3/views/1⁠

Please create an issue if you would like something to be added to the roadmap.

⁠Screenshots

⁠Search screen

⁠User management screen

⁠Getting started

⁠Download / Installation / Run

Check installation installation docs⁠

⁠Data ingestion

⁠Single record

Check single record ingestion docs⁠

⁠Bulk ingestion

Check bulk ingestion docs⁠

⁠Fluent bit

Check fluet-bit ingestion docs⁠

⁠Syslog-ng

Check syslog-ng ingestion docs⁠

⁠API Reference

Check Zinc API docs⁠

⁠Releases

ZincSearch currently has most of its API contracts frozen. It's data format may still experience changes as we improve things. Currently ZincSearch is in beta. Data format should become highly stable when we move to GA (version 1).

⁠How to develop and contribute to Zinc

Check the contributing guide⁠ . Also check the roadmap items⁠

⁠Who uses Zinc (Known users)?

1. Quadrantsec⁠
2. Accodeing to you⁠
3. Paopao⁠

Please do raise a PR adding your details if you are using Zinc.