Skip to main content
Use GitHub deploys when your source code already lives in a repository. Hyze downloads the branch, installs dependencies, detects the start command, and starts the app.

Prerequisites

Connect GitHub in the dashboard before using this flow: Dashboard → GitHub (or check status with GET /api/integrations/github/status).

Deploy a repository

With autoDeploy: true, every push to the selected branch triggers a new deploy automatically.

Verify the result

  1. Check status: GET /api/apps/:appId — wait for status: running
  2. Open the logs: GET /api/apps/:appId/logs to watch startup

Common problems

The GitHub integration isn’t connected for the workspace, or the app was installed with access restricted to other repositories. Reconnect at Dashboard → GitHub.
Check build history: GET /api/apps/:appId/builds. Common causes: missing lockfile, incompatible runtime version, or a wrong start command. startupCommand is optional — omit it and Hyze detects (Vite, Next, Node, static, Python).
Check exposePort: it must match the port your server listens on, and the server must accept connections on 0.0.0.0.

Next steps

View logs

Inspect startup and runtime output.

Apps reference

All app endpoints, including ZIP deploy.
Last modified on September 1, 2026