meilisearch v0.1.0

Meilisearch — a fast, typo-tolerant open-source search engine with instant full-text search and a simple REST API. Deployed as a host-networked Nomad service with a persistent Docker volume.

nomad-pack run meilisearch --registry nomploy

…or one line (add registry + run)

curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- meilisearch

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

Source ↗ Project ↗ ★ 59.6k ⚑ Report an issue

1 task http 7700 1 volume image getmeili/meilisearch:latest tracks :latest image bumped 1 mo ago

Variables 9

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run meilisearch -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "meilisearch"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The Meilisearch container image. Pin a tag in production.
image = "getmeili/meilisearch:latest"

# Host port for the Meilisearch HTTP API.
port = 7700

# Master API key. Set it (>= 16 bytes) to run in production mode with authentication. Leave empty to run in development mode — OPEN, no auth (fine only on a trusted network). Baked into the job env; treat it as a secret.
master_key = ""

# Docker named volume for /meili_data (the search database). Meilisearch runs as root, so a fresh volume is writable. Back it up.
data_volume = "meilisearch_data"

# Placement constraints — pin to one node so the local volume stays put. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources. Raise memory for large indexes.
resources = {
    cpu    = 500
    memory = 512
  }

Name	Type	Default	Description
job_name	string	"meilisearch"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"getmeili/meilisearch:latest"	The Meilisearch container image. Pin a tag in production.
port	number	7700	Host port for the Meilisearch HTTP API.
master_key key	string	""	Master API key. Set it (>= 16 bytes) to run in production mode with authentication. Leave empty to run in development mode — OPEN, no auth (fine only on a trusted network). Baked into the job env; treat it as a secret.
data_volume	string	"meilisearch_data"	Docker named volume for /meili_data (the search database). Meilisearch runs as root, so a fresh volume is writable. Back it up.
constraints	list	[]	Placement constraints — pin to one node so the local volume stays put. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 500 memory = 512 }	The task resources. Raise memory for large indexes.

Back up this pack

This pack stores data in one Docker named volume: meilisearch_data

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/meilisearch_data/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/meilisearch_data/_data backup:<bucket>/meilisearch_data

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

meilisearch

Meilisearch — a fast, typo-tolerant open-source search engine with instant full-text search and a simple REST API. Drop-in search for your apps. Host-networked Nomad service with a persistent Docker volume.

Usage

nomad-pack registry add nomploy github.com/Nomploy/nomad-packs
nomad-pack run meilisearch --registry nomploy

In nomploy: create a Compose service, type Nomad Pack, pack meilisearch, custom registry github.com/Nomploy/nomad-packs, then Deploy.

API at http://<node-ip>:7700 (/health to check).

Authentication

Follows the optional-auth pattern:

master_key empty → development mode, API is open (no auth). Fine on a trusted network.
master_key set (≥ 16 bytes) → production mode; clients send Authorization: Bearer <master_key>. Derive scoped API keys from /keys.

Key variables

Variable	Default	Notes
`image`	`getmeili/meilisearch:latest`	Pin a tag in production.
`port`	`7700`	HTTP API host port.
`master_key`	`""`	Set for production auth; empty = open dev mode.
`data_volume`	`meilisearch_data`	`/meili_data`. Back it up.
`constraints`	`[]`	Pin to a node so the local volume stays put.
`resources`	`cpu 500 / mem 512`	Raise memory for large indexes.

Notes

Single node. count is fixed to 1 (local volume). Pin with constraints.
Meilisearch runs as root in the image, so a fresh volume is writable (no chown).
Backups: snapshot the data_volume, or use Meilisearch dumps.