Skip to main content
One Docker image runs the whole Mixpeek platform on your machine: the API, Studio, the Ray engine, MVS, MongoDB, Redis and an S3-compatible object store. Docker is the only prerequisite to run it.
Mixpeek does not publish this image to a public registry. It bundles MongoDB Community Server (SSPL-1.0) and MinIO (AGPL-3.0). You build it from the Mixpeek repository, which needs repository access.

Requirements

Set it up

1

Build the image

Clone the repository. Stage Studio into the build context, then build.
The build targets your machine’s architecture. Add --platform linux/arm64 or --platform linux/amd64 to choose one.A cold build on an 8-CPU arm64 Linux VM with no cached images took 13 minutes 4 seconds. Later builds reuse cached layers.
2

Start the container

Set Docker’s memory to 16 GB first. In Docker Desktop, open Settings, then Resources.
The volume mixpeek-data holds all state. Publish only these three ports.--stop-timeout 60 gives the stack time to shut down. MVS needs about 10.6 seconds to stop cleanly. Docker waits 10 seconds by default, then kills the container. With the flag, docker stop takes about 23 seconds and exits 0.
3

Wait until it is healthy

The endpoint reports starting while Ray builds its Serve applications. In a clean-host run, /ready answered after 44 seconds and the seed step finished after 48 seconds. A restart with data on the volume takes about a minute. Allow up to 10 minutes on a cold start.If the status becomes degraded, run docker logs mixpeek and look for the component named in /health.
4

Read your credentials

The container creates one organization on first start and writes its API key to the volume.
The command prints five lines: MIXPEEK_API_KEY, MIXPEEK_NAMESPACE_ID, MIXPEEK_ORG_NAME, MIXPEEK_ORG_ID and MIXPEEK_API_URL. The key survives restarts.Export them into your shell:
5

Call the API

List the buckets in your namespace. The response includes the starter bucket the container seeds.
The SDKs take the local address as well: Mixpeek(api_key=..., base_url="http://localhost:8000") in Python and new Mixpeek({ apiKey, baseUrl: "http://localhost:8000" }) in JavaScript.
6

Open Studio

Open http://localhost:3000. Studio needs no sign-in. A banner across the top says authentication is bypassed. Studio calls the API in this container with the seeded key.The seeded namespace default holds a starter bucket, a starter collection and a retriever named search.

Check that everything works

Two test suites ship inside the image. Both run against the container itself.
The matrix prints one row per primitive and operation. A row is PASS, FAIL, or VOID when the container cannot exercise it. The command exits with status 1 on any FAIL that is not a documented known failure. The report is at /data/logs/lifecycle-matrix/lifecycle-matrix.md inside the container.

Choose the default extractor

The seeded namespace uses text_extractor. It runs the MiniLM model (all-MiniLM-L6-v2, 384 dimensions), and the image carries the weights. This default needs no API key and makes no paid call. It works with the network off. To use the multimodal universal_extractor instead, pass a Gemini or OpenAI key and name the extractor. The container applies the default when it creates the organization, so start from an empty volume with docker rm -f mixpeek && docker volume rm mixpeek-data.
Calls to Gemini or OpenAI bill your provider account for each object processed. /health reports "mode": "keyed" when a key is present.

Media extractors

The image serves two inference apps: MiniLM and taxonomy_join. It carries no GPU models. The image, audio and video extractors resolve to models such as SigLIP, CLAP or ArcFace, and the image does not include them. The image accepts media files, detects their type, stores them and lists them. Only the embedding step cannot run. The media test driver reports that step as VOID and names the missing model:
In keyed mode, universal_extractor embeds media through the Gemini API.

Add an extractor with YAML

Put a *.yaml file in a directory, mount it at /data/plugins, and restart the container. The extractor appears in the API next to the built-in ones. You write no Python and rebuild nothing.
extends reuses a built-in extractor’s definition and Ray pipeline. The model registry sets the vector dimensions, so the YAML does not state them. A spec that fails to load stops the container.

Operate the container

The volume survives docker stop, docker start and replacing the container. If you delete the volume, the container creates a new organization and a new API key on the next start. The image runs no Celery process and no broker. A Mongo-backed work ledger and a Ray dispatcher run the background tasks. celery-worker and celery-beat show as disabled in /health.

Memory

Give Docker 16 GB. The idle container uses about 7.8 GiB, and 7.4 GiB of that is Ray.

What the image leaves out

Quickstart

Create a namespace, add data and search.

Concepts

Namespaces, buckets, collections and retrievers.

Studio

Work with the same platform in the UI.

Deployment

Kubernetes and managed Ray topologies.