Skip to content

Quickstart

We will do 2 things as part of the quickstart:

  1. Install ZincSearch
  2. Load sample data and perform search operations on it.

Installation

You would need ZINC_FIRST_ADMIN_USER and ZINC_FIRST_ADMIN_PASSWORD environment variables when you start ZincSearch for the first time. You don't need them on subsequent runs of ZincSearch.

Binaries can be downloaded from releases page for appropriate platform.

set ZINC_FIRST_ADMIN_USER=admin
set ZINC_FIRST_ADMIN_PASSWORD=Complexpass#123
mkdir data
zincsearch.exe

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

In your terminal:

brew tap zinclabs/tap
brew install zinclabs/tap/zincsearch
mkdir data
ZINC_FIRST_ADMIN_USER=admin ZINC_FIRST_ADMIN_PASSWORD=Complexpass#123 zincsearch

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

Binaries can be downloaded from releases page for appropriate platform.

Create a data folder that will store the data

mkdir data
ZINC_FIRST_ADMIN_USER=admin ZINC_FIRST_ADMIN_PASSWORD=Complexpass#123 ./zincsearch

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

Docker images are available at https://gallery.ecr.aws/zinclabs/zincsearch

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 zincsearch public.ecr.aws/zinclabs/zincsearch:latest

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

Error pulling image if you have AWS CLI installed?

If you have AWS CLI installed and get login error then run below command:

aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws

Create a namespace:

kubectl create ns zincsearch

Create the deployment and port forward:

kubectl apply -f https://raw.githubusercontent.com/zincsearch/zincsearch/main/k8s/kube-deployment.yaml

Expose the zincsearch service by port-forwarding:

kubectl -n zincsearch port-forward svc/z 4080:4080

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

Update Helm values located in values.yaml

Create the namespace:

kubectl create ns zincsearch

Install the chart:

helm install zincsearch helm/zincsearch -n zincsearch

ZincSearch can be made available with an ingress or port-forward:

kubectl -n zincsearch port-forward svc/zincsearch 4080:4080

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

Load sample data

We will use bulk API to load sample data

curl -L https://github.com/zincsearch/zincsearch/releases/download/v0.1.1/olympics.ndjson.gz -o olympics.ndjson.gz
gzip -d  olympics.ndjson.gz 
curl http://localhost:4080/api/_bulk -i -u admin:Complexpass#123  --data-binary "@olympics.ndjson"

Search for data

Point your browser to http://localhost:4080 and login

  1. Select the index olympics from drop down in the left
  2. Search for the word Gold in search bar and presse enter.

Click on the info button next to the search bar to see examples on how to search.