iPolloWork Docs

Production operations

Prepare a private or organization deployment with explicit ownership, health, recovery, and release gates.

Production readiness is not a single command. It is a set of verified boundaries: what is local, what is organization-managed, which service owns a credential, how a runtime becomes healthy, and how an operator restores state after a failure.

The iPolloWork repository supports a local desktop and local server path without a Cloud control plane. A private organization deployment should add only the control-plane and hosted-runtime capabilities it actually needs.

Operations topologyOperate each layer through its owning health and recovery path

The diagram separates user work, local runtime, optional organization services, and the operational evidence that proves each layer is safe to use.

01
Person and device

Local-first user path

Desktop client

The Electron client and editable work surfaces.

Local workspace

Repositories, artifacts, and user-controlled work material.

02
Local runtime

Work execution

iPolloWork server

Workspace HTTP API, approval gates, audit, artifacts, and runtime adapters.

OpenCode sidecar

A separately managed agent runtime checked through the supported adapter.

03
Organization plane

Deploy only when required

Identity and policy

Organization access, roles, shared configuration, and governance.

Workers and connectors

Hosted runtime lifecycle and external integration state.

04
Operations evidence

What an operator can verify

Health and capability probes

Reachability, runtime compatibility, and scoped readiness checks.

Backup and audit trail

Restorable data, owner, recovery procedure, and exported evidence.

Pick a deployment profile

ProfileIncludeUse whenDo not assume
Local desktopElectron app, local server, supported sidecars, local project filesOne person or a local project needs agent work against filesOrganization identity or remote Workers are required
Private workspace serveripollowork-server, workspace configuration, a bounded network pathA controlled machine or VPC hosts a workspace runtimeIt automatically provides a complete organization control plane
Organization control planeIdentity, organization resources, connectors, shared capabilities, optional WorkersTeams need policy, shared configuration, and managed runtime lifecycleIt replaces the local editable Work experience

Configure the local server intentionally

The local server can run from the compiled binary:

ipollowork-server --workspace /path/to/workspace --approval auto

Or from source during development:

pnpm --filter ipollowork-server dev -- \
  --workspace /path/to/workspace \
  --approval auto

The default configuration file is ~/.config/ipollowork/server.json. It holds host, port, approval mode and timeout, known workspaces, and CORS origins. Environment variables can override the config path, host and port, tokens, approval mode, workspace list, CORS origins, OpenCode connection, token store, and related runtime settings.

For a normal human-operated installation, preserve the default manual approval behavior. --approval auto is useful for local development or a tightly governed automation boundary, not as an unreviewed production default.

Health and readiness checks

Use health checks to prove the layer you will actually route traffic to:

CheckMeaningOperational response
GET /healthLocal server reachability and server version informationFail closed for new traffic if the process is unavailable.
GET /status and /capabilitiesServer state and supported runtime featuresReconcile incompatible clients or disabled capability boundaries.
GET /w/{workspaceId}/healthScoped workspace server healthIsolate one bad workspace instead of declaring every workspace unavailable.
Supported OpenCode health pathSidecar reachability through the server adapterRepair the sidecar boundary, not the client UI, when it is unhealthy.

Do not publish a path externally merely because a generic health endpoint responds. Health endpoints prove liveness, not authorization scope, data recovery, or tenant isolation.

Release gates

Release gateA narrow, verifiable production change

Run the gates in order. If one fails, stop the rollout at that boundary and fix the owner rather than widening the change.

  1. 01Configuration

    Review resolved host, workspace, CORS, approval, credential, and ingress configuration without exposing secrets.

  2. 02Build and checks

    Run the repository check flow, narrow tests, and diff validation before producing an artifact.

  3. 03Staged health

    Verify server, scoped workspace, sidecar, and enabled control-plane endpoints through their real route.

  4. 04Recovery proof

    Name the backup location, restore owner, rollback condition, and audit evidence before broad traffic changes.

Recovery and evidence

Before an organization rollout, document these answers in the operator runbook:

  1. Which state is on the local device, in a workspace, and in the organization control plane?
  2. Who can rotate each server, host, owner, session, and provider credential?
  3. Where is the backup, how recently was it restored in a test, and who owns the restore decision?
  4. Which health result blocks new task execution, and which result only degrades an optional Cloud feature?
  5. Which resource IDs, deployment revision, and audit records are needed to investigate an incident without leaking secrets?

For repeatable development and release commands, follow Local development and Desktop packaging. For specific private runtime boundaries, read Self-hosted topology.