> ## Documentation Index
> Fetch the complete documentation index at: https://orbit.nckrtl.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Source alpha

> A bounded trial, known limits, release criteria, and feedback.

# Source alpha

Early users can use this guide to run a bounded Orbit trial and report useful feedback. The trial starts with a source installation and ends with one development Instance that serves a private HTTPS page. Use disposable machines and data that you can replace.

## Trial path

Follow the guides in this order. Record the source commit on each machine.

| Step | Guide | Required observation |
| - | - | - |
| Install the CLI and Gateway | [Quickstart](/docs/quickstart#install-orbit) | Composer platform checks pass and the Gateway services start. |
| Connect the CLI | [Quickstart](/docs/quickstart#connect-the-cli) | A trusted HTTPS request to `gateway:status` succeeds. |
| Add one development Node | [Quickstart](/docs/quickstart#add-a-development-node) | The Node and its `app-dev` role become active over WireGuard. |
| Serve an application | [Quickstart](/docs/quickstart#open-the-page) | Private DNS resolves the returned hostname, and HTTPS serves the expected page. |
| Recover an update | [Gateway recovery](/docs/reference/gateway-recovery) | A restored disposable Gateway reads its saved state and serves the same application through the same fleet. |

A documentation build or an automated test does not prove that this path works on a fresh machine. Only a run on fresh machines proves it.

Run `bin/bootstrap` only in a source checkout. In a Gateway [release](/docs/reference/gateway-recovery#release-layout) it refuses, because a release is immutable; deploy another commit instead. Bootstrap seeds its test and quality caches from the [main caches](/docs/reference/implementation-loop#main-caches) when they exist. It never publishes caches; only main CI does. Bootstrap writes the development Gateway key to `ORBIT_HOME/gateway.app-key` with `bin/gateway-app-key`, and keeps a key that exists. A nonempty `APP_KEY` in the environment [takes precedence](/docs/reference/gateway-recovery#preserve-a-complete-state-set). `--with-bun` and `--with-rust` also install the locked dependencies of the [Bun and Rust projects](/docs/reference/bun-and-rust-projects).

## Limits

The trial has a small environment and workload on purpose.

| Area | Trial boundary |
| - | - |
| Distribution | Full monorepo source at one recorded commit or release tag. The trial needs no [CLI binary](/docs/reference/cli-binaries). |
| Machines | An Ubuntu 26.04 Gateway and managed Nodes. See [what you need](/docs/quickstart#your-part). |
| Application | One standalone development Node and one public Git repository with a static page. Databases and dependency installation need separate application setup. |
| Network | Private HTTPS through WireGuard and Orbit DNS. The trial makes nothing public. |
| Production | Production commands exist, but the trial proves no production readiness, availability, or application data recovery. |
| Updates | Read each release's instructions. A database migration can prevent a code-only downgrade. |

A private Route change can need coordinated runtime and DNS work. Read the refusal rules in [Routes](/docs/reference/routes) before you change hostnames, membership, or routing. An active Instance means that Orbit finished provisioning. It does not mean that the application is healthy.

## Release criteria

The maintainer decides from observed results whether to publish a source alpha tag. The release notes name the exact commit, the supported environment, the known limits, and the results of these checks.

| Check | Evidence needed before the check passes |
| - | - |
| Fresh installation | Start with fresh machines and no Orbit state. Run the published guides and record the commands, exit codes, and machine versions. |
| First application | Open the expected page through private DNS and HTTPS, without bypassing certificate verification. |
| Recovery | Restore a backup from before the update in a disposable environment. Verify the state, the access, and the application URL. |
| Documentation | Check the rendered navigation and guides, and run the documentation and Mintlify checks. |
| Candidate | Keep the local quality check result and the independent review for the exact source commit. |
| Open issues | Sort the open issues against this path. An unresolved failure of the path blocks the release. An unrelated feature does not. |

These criteria are a checklist, not a release approval. A version string in a development checkout does not mean that a release exists.

## Feedback

Use [GitHub issues](https://github.com/nckrtl/orbit/issues) for bugs and questions. Include the source commit from `git rev-parse HEAD`, the CLI output of `orbit --version`, the Gateway version from `orbit gateway:status`, and the operating systems. Describe the command, the expected result, the observed result, and the steps to reproduce it.

Include stable error codes and request IDs when you have them. Check the output before you share it. Remove tokens, private keys, passwords, environment values, repository URLs that carry credentials, and personal data. Never attach the Gateway database or a state backup. The [contributor guide](/docs/contributor-guide) explains the local checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.