Skip to content

HTTP app contract

A Forge app is an HTTP process that listens on the runtime-provided port. The app must start without an interactive prompt and return a useful response for its declared routes.

Runtime requirements

Requirement Contract
Port Read the port supplied by the runtime rather than binding a fixed local port.
Startup Start the server with the repository's committed configuration.
Readiness Return a successful response at the serving probe path Forge checks. Forge does not read that path from the manifest.
Errors Return an HTTP error with a useful body when the request cannot succeed.

Local proof

Run the app locally, request its root route, and record the exit code and HTTP responses with the manifest and commit used for the run.

A local response proves the app contract on that machine. It does not prove hosted availability or Forge repository authorization.

Source boundary

Forge deploys committed source selected by the repository origin by default. Automation may select only repository, ref, or commit. The deploy operation does not consume uncommitted files.