Docs

EnvForge documentation starts with the workspace loop.

Start with the workflow every user sees: connect identity and repos, prepare service contracts, open a shell with envforge up, share signed dev links, and let runtime billing follow awake service work.

1Install GitHub App

2Review envforge.yml PRs

3envforge login

4envforge up

First-release map

First-release docs map.

Start with the pages that explain first-release behavior: how the first workspace opens, how signed dev URLs are shared, how trust boundaries work, and when runtime billing starts or stops.

Decision paths

Route the first product question to the right page.

The landing page should help evaluators choose by workflow instead of making them know EnvForge internals first.

Read first

Product concepts before infrastructure names.

Each page should explain product concepts without exposing raw VM names, ports, IP addresses, runtime IDs, or implementation-specific checkout details.

First workspace

Connect GitHub, prepare per-repo envforge.yml PRs, create project services and bindings, install the CLI, then run envforge login, envforge up, and envforge workspace resources.

Branch workspaces

Follow a workspace from branch selection through shell attach, runtime wake, signed review links, idle sleep, and cleanup.

Workspace policies

Review workspace metadata, runtime size, idle sleep, caps, retained state, and cleanup boundaries before branch workspaces wake services.

Repository contracts

Understand the per-repo envforge.yml model: services describe themselves, declare inputs, and avoid depends_on or cross-service references.

Repo-prep PR flow

Use envforge repo connect and envforge prepare-pr to open a small setup PR that repo owners can review before branch workspaces depend on it.

Resource modes

Map database, cache, storage, mail, and queue references to managed local, provided, customer-cloud, or disabled workspace resources.

Safe resource outputs

Show resource references, modes, readiness, and consumer services in handoffs while keeping credentials, provider IDs, and private console links hidden.

Service commands

Run setup and test commands against workspace services, then review command receipts by workspace, service, status, and limit without exposing secrets.

Workspace logs

Use envforge logs to filter workspace logs by source, level, limit, and since/until windows before sharing debugging context.

Signed dev links

Use dev.envforge.ai hosts for workspace-scoped browser sessions while SSH, secrets, logs, and runtime admin stay private.

Dev URL model

Explain dev.envforge.ai wildcard hostnames, short service/workspace/org slugs, and why new workspaces do not require new DNS records.

Access model

Separate Auth0 login, GitHub App scope, signed dev link sessions, optional Tailscale, and root policy before sharing workspace access.

Auth0 identity setup

Configure the EnvForge Auth0 tenant, Web App, CLI, Gateway, and API audience while keeping owner/admin/developer/viewer/billing permissions in EnvForge.

Tailscale private access

Connect a tailnet for private shell or runtime routes while signed dev links keep their public app-only scope.

Runtime billing

Separate always-ready shell access from awake-only runtime usage, caps, live usage, and idle sleep behavior.

Security model

Review organization-exclusive VMs, Auth0 identity, EnvForge authorization, SSM SecureString secrets, signed dev links, Tailscale, root policy, and audit logs.