Exporting a project

By the end of this page you will have run an appliance export and know what to prepare in a project beforehand so nothing is silently left out.

Running the export

Open the Appliance page

Open the project and go to Appliance. It lists every previous export with its version and status, and a button to start a new one.

A project's Appliance page, showing past exports with their version, status and a New export button

Choose what to include

The wizard walks you through what travels in the archive: which agents, multi-agent systems and knowledge bases to include, how much data (schema only, or schema and rows), whether to carry the app’s documents, and whether to bundle telemetry.

The export wizard's Contents step, with agents, multi-agent systems and knowledge bases listed as checkboxes to include

Run a dry run first

Before building anything, run a dry run. It does the same project read and coherence check as a real export — missing agents, empty governed tables, an LLM route with no credential — and reports problems without building an image or consuming a version number.

Run the real export

Once the dry run is clean, export for real. It runs seven stages: read project state, check coherence, build the app’s two images, write the sealed bundle, pin every image digest, scan for secrets and sign, then archive.

The export's progress view in Studio, listing all seven stages with the completed ones checked off

Knowledge bases and schedules

Include a project’s knowledge bases (RAG stores) when you start the export, and their documents, chunks and embeddings travel inside the bundle — search works against them immediately on install, with no re-crawl and no connection back to qRaptor. Authoring a knowledge base (crawling new sources) still happens in the Studio; the appliance serves what was included at export time.

Any enabled schedules on the agents you export travel too — you can’t choose or change them in the wizard yet. The appliance runs them itself from the moment it starts. A schedule that was due while the appliance was down fires once to catch up and is skipped if it’s more than five minutes overdue, rather than queuing every missed run. The export’s warnings list the schedules that will run, with their cron expression and timezone, so you know before you install that the box will begin doing work on its own.

Documents

Select Documents and assets to carry the files your app’s users uploaded — attachments, receipts, images. They keep their original IDs, so links to them in your data keep working once installed. Only each document’s latest version travels.

Large libraries make large archives. If a document can’t be fetched, or the export reaches its size limit, the export finishes with a warning that says how many documents were left out — it never leaves them out silently. Without this option, existing links to files answer “document not found” in the appliance.

Agent exposure

Every export lists the endpoints of each agent and multi-agent system it carries. Open the export on the Appliance page and go to the API access tab, or read the archive’s README.md. Nothing is callable until whoever installs it exposes the agent and creates a key — see Agent exposure.

Data and telemetry

Exports are schema only by default — you get the structure and an empty database. Including data is an explicit opt-in when you start the export.

Telemetry is off by default. You choose at export time:

Disabled — no exporter is constructed.
Your collector — spans go to an OTLP endpoint you name. Nothing is sent to qRaptor.
Bundled — a collector runs inside the appliance and writes to its own disk. It publishes no host port.

LLM usage is metered into the appliance’s own database either way, not reported anywhere.

Installing it — next step once you have the archive.
Appliance export overview — what this is and whether you need it.