LinuxCommandLibrary
GitHubF-DroidGoogle Play Store

zinc

Lightweight full-text search engine

TLDR

Start Zinc server with initial admin credentials
$ ZINC_FIRST_ADMIN_USER=[admin] ZINC_FIRST_ADMIN_PASSWORD=[password] zinc
copy
Start on specific port
$ ZINC_SERVER_PORT=[4080] zinc
copy
Start with custom data directory
$ ZINC_DATA_PATH=[/var/lib/zinc] zinc
copy
Ingest data via API
$ curl -u [admin:password] -X POST http://localhost:4080/api/[index]/_doc -d '{"field": "value"}'
copy

SYNOPSIS

zinc [options]

DESCRIPTION

ZincSearch (formerly 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.ZincSearch 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 Bluge 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. The project has since evolved into OpenObserve.

PARAMETERS

Note: ZincSearch (now OpenObserve) is primarily configured via environment variables rather than command-line flags.

ENVIRONMENT

ZINC_FIRST_ADMIN_USER

Initial admin username (required on first run)
ZINC_FIRST_ADMIN_PASSWORD
Initial admin password (required on first run)
ZINC_DATA_PATH
Data storage directory (default: ./data)
ZINC_SERVER_ADDRESS
Server bind address (default: 0.0.0.0)
ZINC_SERVER_PORT
Server port (default: 4080)
ZINC_MAX_RESULTS
Maximum search results returned (default: 100)
ZINC_BATCH_SIZE
Internal batch size for bulk indexing (default: 1024)
ZINC_SHARD_NUM
Number of shards for improved performance (default: 3)
ZINC_ICE_COMPRESSOR
Compression algorithm: snappy, s2, zstd (default: zstd)
ZINC_WAL_SYNC_INTERVAL
Write-ahead log sync frequency (default: 1s)
ZINC_TELEMETRY
Anonymous usage data (default: true)
ZINC_PROMETHEUS_ENABLE
Enable Prometheus metrics endpoint (default: false)
GIN_MODE
Set to "release" for production mode

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

Copied to clipboard
Kai