Documentation

Getting started

From zero to a production deploy: create an account, connect a repository, and learn the day-to-day workflow.

1. Create an account

Sign up on the Free plan (you can upgrade later), or log in.
From the dashboard, create a site. Pick a GitHub or Gitea repository, or start from a template.
Chapong detects the framework and fills in the install, build and start commands. Check them and create the site.

2. Your first deploy

The first build starts right away. When it finishes, the site is live at its default address. Supported frameworks include Vite, React, Vue, Next.js, Nuxt, Astro, Create React App, plain Node servers and static sites.

Static sites and single-page apps are served directly. Server apps (for example Next.js, Nuxt or Express) run as processes, and a new version must pass its health check before traffic is switched to it.

Git deploys & previews

Pushes to the production branch deploy to production.
Other pushes, and every pull request, get a preview URL. Chapong posts a commit status with the link back to the pull request.
Builds can be cancelled while they run, which is handy when a newer push supersedes one.

Deploying from the CLI instead

shell

$ avoca login
$ cd my-app
$ avoca sites link my-app
$ avoca deploy             # preview → unique URL
$ avoca deploy --prod      # production

The CLI isn’t on npm yet; see the CLI docs for its status and every option.

Deployment protection

Any deploy can be password-protected, which is useful for client previews and staging. Turn it on from the site’s settings in the dashboard.

Deploy hooks

Deploy hooks let a CMS or any other service trigger a new deploy. Create one in the dashboard; you get a URL of this form:

http

POST https://sites.<host>/hooks/deploy/<site>/<secret>

shell

$ curl -X POST https://sites.<host>/hooks/deploy/<site>/<secret>

Treat the URL like a password: anyone holding it can trigger a deploy. Delete and recreate the hook to rotate it.

Rollback

Every deploy is an immutable build. Rolling back atomically switches the live pointer to an earlier build, with no rebuild.

shell

$ avoca deployments        # find the deploy id
$ avoca rollback <deploy-id>

You can also roll back from the site’s Deployments list in the dashboard. The response cache is purged on every deploy and rollback.

Analytics & Web Vitals

Each site’s dashboard shows traffic analytics and Core Web Vitals from real visits.