Skip to content
Flapjack

Getting Started

Flapjack is an open-source search engine with an Algolia-compatible API. This guide gets you from zero to searching in under a minute.

Quick start with Docker

Section titled “Quick start with Docker”
Terminal window
docker run -d -p 7700:7700 \
  -e FLAPJACK_ADMIN_KEY=your-secret-key \
  -v flapjack-data:/var/lib/flapjack \
  ghcr.io/flapjackhq/flapjack

Or install the binary with the official installer, which detects your platform and downloads the matching release archive:

Terminal window
curl -fsSL https://install.flapjack.foo | sh
FLAPJACK_ADMIN_KEY=your-secret-key flapjack --data-dir ./data --bind-addr 0.0.0.0:7700

To pin a specific version, pass it to the installer: curl -fsSL https://install.flapjack.foo | sh -s -- v1.0.10.

Verify it’s running

Section titled “Verify it’s running”
Terminal window
curl http://localhost:7700/health

You should see a 200 OK response.

Index some documents

Section titled “Index some documents”
Terminal window
curl -X POST 'http://localhost:7700/1/indexes/movies/batch' \
  -H 'X-Algolia-Application-Id: flapjack' \
  -H 'X-Algolia-API-Key: your-secret-key' \
  -H 'Content-Type: application/json' \
  -d '{
    "requests": [
      {"action": "addObject", "body": {"objectID": "1", "title": "The Matrix", "year": 1999, "genre": "sci-fi"}},
      {"action": "addObject", "body": {"objectID": "2", "title": "Inception", "year": 2010, "genre": "sci-fi"}},
      {"action": "addObject", "body": {"objectID": "3", "title": "The Godfather", "year": 1972, "genre": "crime"}}
    ]
  }'
Section titled “Search”
Terminal window
curl -X POST 'http://localhost:7700/1/indexes/movies/query' \
  -H 'X-Algolia-Application-Id: flapjack' \
  -H 'X-Algolia-API-Key: your-secret-key' \
  -H 'Content-Type: application/json' \
  -d '{"query": "matrix"}'

Response:

{
  "hits": [
    {
      "objectID": "1",
      "title": "The Matrix",
      "year": 1999,
      "genre": "sci-fi",
      "_highlightResult": {
        "title": {
          "value": "The <em>Matrix</em>",
          "matchLevel": "full"
        }
      }
    }
  ],
  "nbHits": 1,
  "page": 0,
  "hitsPerPage": 20,
  "processingTimeMS": 0,
  "query": "matrix"
}

Next steps

Section titled “Next steps”