Repository administration
Sign in
Open /admin. On first initialization, the repository writes a random administrator password to <root>/.admin/bootstrap-password; read that file on the server. Initialization options do not replace an existing password. Use HTTPS for non-local access. Sessions last eight hours and expire on restart; mutations require the session's CSRF token.
Manage submitters
In Submitter Tokens, issue a Token for a named submitter or revoke an existing Token. A new Token is displayed once and stored only as a hash. Use distinct submitter names for different people. A replacement Token with the same name represents the same submitter. Revocation applies to subsequent API calls.
Review submissions
Review submissions shows source-publication declarations, private source materials, scan findings, build state and generated packages. Refresh to retrieve asynchronous progress. Failed builds and failed scans cannot be approved. Select or create category labels and choose the final 0–5 trust score, initially taken from the scan. Explain adjustments and approvals below 3 in the review note. Approve to make the version public or reject to keep it private.
Only approved versions enter public search and downloads. Approved versions cannot be overwritten. Rejected submissions may be corrected and resubmitted under a new submission ID. Published categories and icons can be updated in the review panel without replacing approved code or its trust assessment.
Manage runtime records
Use Runtimes to register names and versions, pinned execution/build image identities, uploaded archives, supported languages/executors and dependency information. Registered runtime entries and archives are public; versions are immutable. The administrator is responsible for the compatibility of execution and build environments. Environment construction and operator deployment instructions are maintained on the XStream website.
The build service verifies runtime archive SHA-256 and size before import. A Docker-local image ID can differ from the registered config or manifest digest. Imported tags only discover candidates: the service verifies the declared digest in the immutable candidate image’s exported contents before using it. It never changes registered identities or accepts a same-name tag without verification. Resolution is shared by compiler selection, binary-platform checks and dependency preparation. Verification reads image contents without executing the runtime or operator; the first resolution may take longer for large images. A mismatch fails the private build before compilation.
Storage and recovery
Back up the complete repository root, including .admin and blobs/sha256. Only one process may own a root. Password verification data, hashed submitter Tokens, runtime records, submissions, analysis/build results and review decisions persist; login sessions do not. Queued or running builds resume after restart. Retained upload blobs are not automatically garbage-collected.
Binary-wrapper review
Third-party executable submissions retain wrapper source for review and declare provenance, version, platform and license. Automated scanning covers wrapper source only. Approval requires an explicit administrator trust score and review explanation; inspect the executable separately. All artifacts stay private until approval. Locked dependency environments are prepared before compilation and cached by immutable content.
Public author and publication dates
Every public operator includes a publication object. author is the authenticated submitter name, assigned with the submission credential. submitted_at_ms and approved_at_ms are the selected version’s submission and approval timestamps. last_submitted_at_ms covers all submissions for the same operator name and author, including pending or rejected submissions; last_approved_at_ms covers approved versions only. Timestamps are Unix milliseconds. Public cards omit author and publication dates. Version details show the author and that version’s submission and approval dates, in UTC. Category and icon edits do not change approval dates. Private submission contents and credentials remain private.
Usage documentation
New source and binary-wrapper submissions must include public documentation with descriptions for every input port and at least one output, descriptions/filling instructions/schema-valid examples for every parameter, and a complete example_job for the exact submitted version. Incomplete documentation is rejected before queuing a build. Review the example for meaningful parameters and compatible data; structural validation does not execute it.
To correct a published version, POST {"documentation": {...}} to /api/admin/submissions/{id}/documentation with an administrator session and CSRF token. This records documentation_updated_at_ms and does not change the package, trust or approval timestamp. Documentation updates are validated by the same rules. The local administrative helper scripts/complete-operator-docs.py --url http://localhost:8820 --password-file /secure/admin-password supplies reviewed descriptions/examples for the known demonstration operators and updates all their published versions. It rejects unknown operator names rather than inventing domain-specific instructions. Operator development details belong in the XStream authoring guide.
Operator icons contain only an SVG path. Colors are assigned by role: Source green (#16835d), Transform blue (#376ac7) and Sink orange (#bf7416). Submission and icon-edit APIs reject an icon.color field.