plompy-engine.Docs
DocumentationBuild from source

Build a selected source revision

The starter kit is the shortest route to a running gateway. Use this guide when you want to inspect or modify the implementation and build your own images. Source builds require Git and Docker Compose; the Docker build installs the locked Node dependencies.

Check out the release#

sh
git clone --branch v0.13.0 --depth 1 https://github.com/dalkedev/plompy-engine.git
cd plompy-engine
docker compose -f compose.local.yaml build local
docker compose -f compose.local.yaml run --rm -T local \
  node scripts/integrations.mjs init --mode local
docker compose -f compose.local.yaml up -d local
docker compose -f compose.local.yaml exec -T local \
  node scripts/integrations.mjs test --mode local

The repository's compose.local.yaml builds Dockerfile.local and uses development image names. The repository's plain compose.yaml starts the separate Discord engine. Always keep -f compose.local.yaml on source-build commands.

The Local source Compose project and downloaded starter kit both use the project name plompy-local. Do not start both at once. For an independent development instance, choose a different project name and host port and initialize separate volumes. Do not accidentally reuse production credentials or artifacts.

Build the browser variant#

sh
docker compose -f compose.local.yaml stop local
docker compose -f compose.local.yaml --profile browser build local-browser
docker compose -f compose.local.yaml --profile browser run --rm -T local-browser \
  node scripts/integrations.mjs add playwright --mode local
docker compose -f compose.local.yaml --profile browser up -d local-browser

The browser sandbox still applies. The source seccomp profile is scripts/docker-browser-seccomp.json; a release bundle places its corresponding file beside compose.yaml. For Linux AppArmor requirements, see Browser setup. The source profile is scripts/docker-local-apparmor. If adapting the release kit's Compose override for this checkout, use seccomp=./scripts/docker-browser-seccomp.json and retain -f compose.local.yaml as the base file.

Continue with Choose your client, using docker compose -f compose.local.yaml wherever a guide shows plain docker compose. Use local-browser instead of local when the browser variant is running.

The host agent and model remain outside the gateway. Building from source does not create model access, vendor credentials or new tool permissions.

Rebuild after a source change#

Stop the selected service, build that target, and start it again using the same Compose project and volumes. Repeat its authenticated protocol check and inspect a saved artifact. Keep the previous revision and a private volume backup until the new image works.

The local MCP test guide documents fixture-based acceptance checks. Fixture endpoints and test model servers are development tools, not normal research configuration.

Find your next step

Search titles and guide content.