Getting started

Go from a GitHub repo to a live URL in a few minutes. There's no server to set up, no Dockerfile to write, and no YAML to maintain: we detect your stack, build it, and deploy it on every push.

Before you start

• A GitHub account, and a repo containing the app you want to deploy.
• An app that starts an HTTP server (or, for a bot or queue consumer, a long-running process; see Web services & background workers).
• For web apps, listen on 0.0.0.0 and read the port from the PORT environment variable. Most frameworks already do this; the framework guides cover the exceptions.

Deploy your first project

1. Sign in with GitHub.Click “Sign in with GitHub” and authorize the app.
2. Install the GitHub App. Install EthioDeploy on the account or org that owns your repo, and choose the specific repos it can access. It only sees the repos you select.
3. Create a project.From the dashboard, click “New Project” and pick the repo.
4. Watch it build.We detect your stack, build it, and run a health check. Build logs are available in the dashboard, so you can see exactly what's happening.
5. Open your URL. Once the health check passes, your project is live at <project-slug>.ethiodeploy.com.

What happens on every push

Every push to your project's default branch triggers a new build and deploy automatically. The previous version keeps serving traffic until the new one passes its health check, so a broken build never takes your site down. Details are in How deploys work.

If the first deploy fails

Open the deployment's build log in the dashboard. It shows the exact step and error. The usual causes are a missing dependency, a wrong start command, or an env var the build expects that hasn't been set yet. More on these in Troubleshooting.

Next steps

• Add environment variables for API keys and config.
• Add a Postgres or Redis addon if your app needs a database.
• Connect a custom domain instead of the default subdomain.
• Invite teammates with Viewer, Developer, or Admin roles.