LinuxCommandLibrary

zinc

Lightweight full-text search engine

TLDR

Start Zinc server

$ zinc
copy
Start on specific port
$ zinc --port [4080]
copy
Start with custom data directory
$ zinc --data-dir [/var/lib/zinc]
copy
Start with authentication
$ ZINC_FIRST_ADMIN_USER=[admin] ZINC_FIRST_ADMIN_PASSWORD=[password] zinc
copy

SYNOPSIS

zinc [options]

DESCRIPTION

Zinc is a lightweight, full-text search engine designed as an alternative to Elasticsearch. It provides log search and analytics with significantly lower resource requirements.
Zinc features a web UI for management, REST API compatible with Elasticsearch's search syntax, and supports various data ingestion methods including bulk insert and fluentd/fluent-bit integration.
The search engine is written in Go and uses BlugeSearch as its indexing library. It runs as a single binary with embedded storage, requiring no external dependencies.
Common use cases include log aggregation, application search, and replacing Elasticsearch in resource-constrained environments.

PARAMETERS

--port port

HTTP port to listen on (default: 4080)
--data-dir path
Directory for data storage
--sentry-dsn dsn
Sentry DSN for error tracking
--prometheus
Enable Prometheus metrics endpoint

ENVIRONMENT

ZINC_FIRST_ADMIN_USER

Initial admin username
ZINC_FIRST_ADMIN_PASSWORD
Initial admin password
ZINC_DATA_PATH
Data storage directory
ZINC_SERVER_ADDRESS
Server bind address
ZINC_SERVER_PORT
Server port
ZINC_MAX_RESULTS
Maximum search results

CAVEATS

Zinc is not a drop-in Elasticsearch replacement. While it supports similar query syntax, not all Elasticsearch features are implemented.
For high-availability deployments, additional architecture (load balancers, replication) must be implemented manually.
Memory usage scales with index size. Monitor resources for large deployments.
First admin credentials must be set via environment variables before first run.

SEE ALSO

> TERMINAL_GEAR

Curated for the Linux community

Copied to clipboard

> TERMINAL_GEAR

Curated for the Linux community