Home/Docs
Documentation / Forge runtime v1.0.0

What you install, how it fits, and what changed.

Quickstart, deployment guide, architecture reference, schema and API reference, the connector library and the support policy. Full operator documentation ships inside every release bundle; this page is the public index. Docs are how you verify that software exists, so this page is public and does not sit behind a form.

01 / quickstart

From a signed licence to a typed record, in six steps.

This is the shape of a deployment, not a substitute for the operator guide in the release bundle. Steps one to four are the platform team’s work and take a day or two; steps five and six are what the three weeks of Fitting exist to do properly.

StepWhat you doWhat you end up with
01 Pull the imagePull the signed runtime image for the version on the changelog and verify the signature locally. No call home is required, including on the offline channel.verified image, v1.0.0
02 InstallHelm chart, containers with compose or OpenShift, or the offline bundle. Same artifact in every case; the install profile differs.runtime and control plane up
03 Apply the licence fileA signed file, checked locally. It carries your tier, your volume band and your entitled packs.entitlements resolved
04 Install the estate packThe versioned pack for your estate: schema, field definitions, gate defaults, validation rules and the reference ground-truth set.schema loaded, e.g. wm.v1.0.0
05 Point the connectorsSources, masters and targets from the released connector library, under credentials you issue. Configuration, not code.estate reachable
06 Set gates and scoreYour risk function sets per-field thresholds; your experts label a ground-truth set; the eval harness scores the run against it.typed records, cited and scored
You do not need any of this to see the output. Send twenty-five documents and get typed records, lineage and a score against your own labels without installing anything.
02 / deployment guide

Four ways to install the same runtime.

Kubernetes

Helm chart

EKS, AKS, GKE or self-managed. Namespaced install, your ingress, your secrets manager, your object store for the page cache.

AWSAzureGCP
On-prem

Container images + compose or OpenShift

The same images, pulled from a registry you mirror. GPU nodes optional; CPU-only extraction profiles are supported at lower throughput.

Air-gapped

Offline bundle

A signed tarball with images, charts, models, packs and a licence file. Applied with the bundled installer; verified against a public key you pin at first install.

Sovereign cloud

Region-pinned

The Kubernetes path with region and residency constraints enforced in the chart values, for regulated estates on a national or sector cloud.

Prerequisites

What we ask for at onboarding

A namespace or cluster, an identity provider integration, object storage, a database, network reach to your sources and targets, and a licence file.

Sizing

By page volume

Reference profiles for 10k, 100k and 1M pages a month are in the operator guide. The control plane reports throughput and queue depth so you can resize.

03 / architecture reference

The five stages, the control plane and the licence file.

Walk the pipeline
ComponentRunsStoresTalks to
Ingest connectorsIn your boundaryPage IDs, source referencesSharePoint, mailboxes, scan queues, object stores, APIs
Clean & classify workersIn your boundary, GPU optionalCanonical copies, candidate fieldsModels deployed with the runtime
Govern serviceIn your boundaryConfidence, lineage, steward queue, correctionsYour identity provider, your party and product masters
Serve APIIn your boundaryTyped records, audit traceERP, CRM, master data, RAG index, agent tool schemas
Control planeIn your boundaryAccuracy trend, drift, licence state, release inventoryYour monitoring stack via OpenTelemetry
Licence fileRead locallyTier, expiry, packs, signatureNothing — no outbound call
05 / connector library

Versioned artefacts under the licence.

Every connector is released, versioned and patched with the runtime. Missing one is a request under the Extend tier or an onboarding item.

Sources

Where documents arrive

SharePointExchange / M365 mailGmailS3 / Blob / GCSSFTPScan queuesBoxREST upload
Masters

What fields resolve against

SnowflakeDatabricksSQL ServerPostgreSQLOracleMDM via REST
Targets

Where records land

SAPOracle ERPSalesforceServiceNowGuidewireDuck CreekWebhooksKafka
Identity & ops

How it fits your platform

OIDC / SAMLEntra IDOktaOpenTelemetryPrometheusVault / KMS
Optim sources

Billing and token meters

AWS CURAzure Cost ExportsGCP BillingKubernetes usageLLM gateway logsProvider APIs
Missing one?

Extend tier or onboarding

New connectors are scheduled quarterly under Extend, or scoped into onboarding. Either way they join the library and are maintained under the licence.

04 / schema & API reference

What a typed record looks like, and how to ask for one.

Every value Forge asserts carries the evidence for itself. That is the whole shape of the contract: a field, a value, a confidence, and the file, page and region it came from. Full reference documentation ships in the release bundle; this is the part worth reading before you install anything.

Record contract

Field, value, confidence, lineage

Every extracted field carries a confidence score and a lineage reference to file · page · region. A field that could not be asserted above its gate is present and explicitly abstained, never silently absent and never guessed.

Schema versioning

Packs pin a schema version

A pack ships a named, versioned schema — wm.v1.0.0, ins.v1.0.0. Breaking schema changes are a major version and are announced twelve months ahead.

Extension

Your fields sit alongside the pack’s

Fields your systems of record need but the pack does not carry are added as schema entries during Fitting. They are configuration in your deployment, and they do not fork the pack.

API

Records, lineage and exceptions

Read typed records, resolve the lineage behind any field to its source page, list and act on the exception queue, and submit a steward decision. Authenticated under your own IAM.

API

Webhooks on gate events

Fire on abstention, on steward decision and on record promotion, so your workflow systems react to a gate rather than polling for one.

API

The eval harness

Submit a labelled ground-truth set and score any release against it — the same surface the evaluation uses. Regression-test an upgrade before you promote it.

Where the release notes went. Version history now lives on its own page so it can be read without wading through installation docs. See the changelog →
06 / supported versions and support policy

Current and previous major, twelve months' notice.

Supported

Current and previous major version

Both receive security patches. Feature releases land on the current major only.

End of support

Published twelve months ahead

Dates appear on this page and in the control plane. Sovereign-tier licensees receive a named upgrade window.

Cadence

Quarterly feature releases, patches as needed

Pack updates ship on their own cadence, driven by form and rule changes in the industry.

Standard support

Business hours, email and portal

Included in every licence. Severity-based response targets are in the licence agreement.

Priority and 24×7

Enterprise and Sovereign tiers

Priority response on Enterprise; 24×7 for severity 1 with a named security contact on Sovereign.

After a licence lapses

The software keeps running

No patches, packs or support — but nothing switches off. That is the ownership guarantee.

The ask / licence plus onboarding, never onboarding alone

Read the docs, then see it run on your documents.

Onboarding is where the reference architecture meets your estate.

1

Score us on your documents

Twenty-five documents from your own estate, labelled by your own experts. Free, no contract, and you keep the report either way.

2

Three-week Fitting

Schema mapping, confidence gates and a ground-truth set, at a fixed price with a fixed end date. Exit at the pilot gate having paid the first milestone only.

3

Run software, not a project

Go live on the licence with the tuned weights handed over. Releases, packs and support carry on from there.