Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zincsearch/zincsearch

ZincSearch . A lightweight alternative to elasticsearch that requires minimal resources, written in Go.
https://github.com/zincsearch/zincsearch

elasticsearch go golang modern opensearch search searchengine vuejs

Last synced: 3 days ago
JSON representation

ZincSearch . A lightweight alternative to elasticsearch that requires minimal resources, written in Go.

Host: GitHub
URL: https://github.com/zincsearch/zincsearch
Owner: zincsearch
License: other
Created: 2021-12-02T12:49:41.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-06-21T07:23:00.000Z (6 months ago)
Last Synced: 2024-09-25T09:05:46.339Z (3 months ago)
Topics: elasticsearch, go, golang, modern, opensearch, search, searchengine, vuejs
Language: Go
Homepage: https://zincsearch-docs.zinc.dev
Size: 11.1 MB
Stars: 16,919
Watchers: 156
Forks: 730
Open Issues: 41
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-go - zincsearch/zincsearch
awesome - zincsearch/zincsearch - ZincSearch . A lightweight alternative to elasticsearch that requires minimal resources, written in Go. (Go)
awesome - zincsearch/zincsearch - ZincSearch . A lightweight alternative to elasticsearch that requires minimal resources, written in Go. (Go)
awesome-ops - zincsearch/zincsearch - 12-02|2024-10-03 | 一个进行全文索引的搜索引擎。它是 Elasticsearch 的轻量级替代品，运行时只使用一小部分资源。它使用蓝色作为底层索引库 | (Search-Engine)
awesome-repositories - zincsearch/zincsearch - ZincSearch . A lightweight alternative to elasticsearch that requires minimal resources, written in Go. (Go)
awesome-codebases - ZincSearch - A lightweight alternative to elasticsearch that requires minimal resources, written in Go. (**Awesome Codebases** [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome))
stars - zincsearch/zincsearch - ZincSearch . A lightweight alternative to elasticsearch that requires minimal resources, written in Go. (Go)
StarryDivineSky - zincsearch/zincsearch
my-awesome - zincsearch/zincsearch - 10 star:17.1k fork:0.7k ZincSearch . A lightweight alternative to elasticsearch that requires minimal resources, written in Go. (Go)

README

        [![Go Report Card](https://goreportcard.com/badge/github.com/zincsearch/zincsearch)](https://goreportcard.com/report/github.com/zincsearch/zincsearch)

[![Docs](https://img.shields.io/badge/Docs-Docs-green)](https://zincsearch-docs.zinc.dev/) [![codecov](https://codecov.io/github/zincsearch/zincsearch/branch/main/graph/badge.svg)](https://codecov.io/github/zinclabs/zincsearch)

❗Note: If your use case is of log search (app and security logs) instead of app search (implement search feature in your application or website) then you should check [openobserve/openobserve](https://github.com/openobserve/openobserve) project built in rust that is specifically built for log search use case.

# ZincSearch

ZincSearch 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](https://github.com/blugelabs/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 ZincSearch. ZincSearch provides its own UI).

Check the below video for a quick demo of ZincSearch.

[![Zinc Youtube](./screenshots/zinc-youtube.jpg)](https://www.youtube.com/watch?v=aZXtuVjt1ow)

# Why ZincSearch

While Elasticsearch is a very good product, it is complex and requires lots of resources and is more than a decade old. I built ZincSearch 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 disk

8. aggregation support

# Documentation

Documentation is available at [https://zincsearch-docs.zinc.dev/](https://zincsearch-docs.zinc.dev/)

# Screenshots

## Search screen

![Search screen](./screenshots/search_screen.jpg)

## User management screen

![Users screen](./screenshots/users_screen.jpg)

# Getting started

## Quickstart

Check [Quickstart](https://zincsearch-docs.zinc.dev/quickstart/)

# Releases

ZincSearch has hundreds of production installations.

# ZincSearch Vs OpenObserve

| Feature              | ZincSearch                                                       | OpenObserve                                                                               |

| -------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |

| Ideal use case       | App search                                                       | Logs, metrics, traces (Immutable Data)                                                    |

| Storage              | Disk                                                             | Disk, Object (S3), GCS, MinIO, swift and more.                                            |

| Preferred Use case   | App search                                                       | Observability (Logs, metrics, traces)                                                     |

| Max data supported   | 100s of GBs                                                      | Petabyte scale                                                                            |

| High availability    | Not available                                                    | Yes                                                                                       |

| Open source          | Yes                                                              | Yes, [OpenObserve](https://github.com/openobserve/openobserve)                            |

| ES API compatibility | Yes                                                              | Yes                                                                                       |

| GUI                  | Basic                                                            | Very Advanced, including dashboards                                                       |

| Cost                 | Open source                                                      | Open source                                                                               |

| Get started          | [Open source docs](https://zincsearch-docs.zinc.dev/quickstart/) | [Open source docs](https://openobserve.ai/docs) or [Cloud](https://cloud.openobserve.ai) |

# Community

- How to develop and contribute to ZincSearch

  Check the [contributing guide](./CONTRIBUTING.md) . Also check the [roadmap items](https://github.com/orgs/zinclabs/projects/3)

# Examples

You can use ZincSearch to index and search any data. Here are some examples that folks have created to index and search enron email dataset using zincsearch:

1. https://github.com/jorgeloaiza48/Enron-Email-DataSet

1. https://github.com/jhojanperlaza/email_search_engine

1. https://github.com/carlosarraes/zinmail

1. https://github.com/devjopa/golab-search

1. https://github.com/avaco2312/zincsearch

1. https://github.com/paolorossig/email-indexer