On-premises preparation and first use
Use this guide for an organization-managed environment. It is a preparation and verification procedure; obtain the supported deployment instructions and packages for your exact delivery. The public manual download is documentation, not an appliance installer.
1 · Choose the network mode and collect prerequisites
Online and Offline are both supported setup choices
Online uses the network access approved for your installation. Offline is the closed on-premises option: prepare the exact OS/target toolchain and dependency set before transfer. The manual ZIP contains documents and synthetic inputs, not product binaries or Rust toolchains.
- Record OS, architecture, delivery version, installer digest, responsible administrator, approved endpoint, data location and rollback/retention plan. Store credentials separately from worksheets.
- For Online, record allowed destinations, proxy and certificate requirements before installation. Use the supplied supported procedure; do not disable certificate validation to make a connection work.
- For Offline, collect the matching product packages, licenses or authorization material through the approved channel, Rust/native toolchains if needed, dependency archives, manifests and manuals before entering the closed environment. Verify OS, target and versions as a set.
2 · Check package identity before installation
Compare the digest with the manifest delivered through the approved channel. These command examples only calculate a digest; they do not establish the authenticity of an untrusted manifest. Substitute the actual supplied filename.
# macOS
shasum -a 256 supplied-package.zip
# Linux
sha256sum supplied-package.zip
# Windows PowerShell
Get-FileHash -Algorithm SHA256 .\supplied-package.zip
If the digest or target differs, keep the file and mismatch record separate, do not install it, and obtain the correct package. Do not overwrite the known package or its manifest.
3 · Install and follow the tool sequence
- Part.1 · Install and prepare
- Part.2 · Observe structure with GAPE
- Part.3A · Plan with Integration Helper
- Part.4 · Write the source Document and bind the published target Contract
- Part.3B · Check the complete request and identify implementation needs
- Part.5 if needed · SDK candidate, implementation review and separate registration
- Part.6 if needed · Builder Pack candidate and its approval path
- Part.7 · Permitted GUI or headless operation
- Part.8 · Results, troubleshooting and human review
Helper B checks the completed declarations before you decide whether implementation or a new Pack is needed. After an implementation or declaration change, repeat only the affected supported checks and finish the separate implementation/registration/Pack approval path before operation. A generated candidate grants no operating authority.
Select only the route needed for your goal. Retained PoC reading can begin without installation. A supplied local SDK exercise uses Part.1 → Part.5 and does not require a new GAPE scan or appliance account. An existing approved Pack can use Part.1 → Part.7 → Part.8 after its current prerequisites are checked. New integration/Pack authoring follows the full conditional sequence.
Skip SDK authoring only when an implemented, registered integration compatible with the installed release already meets the need. Skip Builder authoring only when an existing approved Pack meets the goal and installation scope. Keep declaration checks, integration validation and result review in either case.
4 · Validate the SDK dependency scope when needed
If the supplied Golden environment already has the compatible dependencies and tools, reuse that documented setup. Otherwise prepare the separate matching dependency package. An offline dependency set covers its declared crates and targets; it does not promise every possible Rust crate, compiler, linker or external tool.
Use a fresh output directory for the documented SDK exercise. Verify adapter.rs, manifest.json and any required compiled artifact, plus the package validation result. On a truly disconnected target, record that the selected exercise completed without an additional download; copying a cache alone is insufficient proof.
5 · Review results and close or hand off
Keep the selected input, exact versions, output location and digests, verbatim error if any, validation result and reviewer decision. Keep failed and successful candidates separate. Use the Common PoC scorecard for the evaluation and Part.8 for the support record.
Troubleshooting cases
Common PoC Guide · Open Parts 1–8 · Custom Execution Guide