Skip to main content

Getting started

Deploy your first application in five minutes. You need an API token from whoever runs Pagifier at your company — that's it. No kubectl, no Docker, no cloud console.

Running Pagifier yourself?

If nobody runs Pagifier for you yet, start with the installation guide — it gets a complete platform running on your laptop in ~15 minutes, then come back here.

1. Create pagifier.toml​

In your repository root:

pagifier.toml
version = 1

name = "my-app"
template = "react-static"
environment = "prod"
ingress = "my-app.company.com"

Four lines of substance. The react-static template already knows how to build a React app (npm ci && npm run build), where the output goes (dist/), what serves it (nginx), and how to cache it. The prod profile brings replicas, high availability, and rollout policy. You only say what's unique to your app.

Prefer YAML? pagifier.yaml with the same keys works identically.

Ask your platform team which templates exist — typical ones are react-static, vite-static, vue-static, nestjs, express, fastapi, and go-api.

2. Check it before deploying​

curl -H "Authorization: Bearer $PAGIFIER_TOKEN" \
     --data-binary @pagifier.toml \
     https://pagifier.company.com/v1/validate

Good config → 200 with the fully resolved configuration (your file + everything the templates added). Bad config → 400 with every problem listed, including typo suggestions:

{"valid": false, "errors": ["unknown field \"artefact\" — did you mean \"artifact\"?"]}

3. Deploy​

zip -r app.zip . -x '.git/*' -x 'node_modules/*'

curl -H "Authorization: Bearer $PAGIFIER_TOKEN" \
     -F config=@pagifier.toml \
     -F archive=@app.zip \
     "https://pagifier.company.com/v1/applications/my-app/environments/prod/deployments?wait=true"

?wait=true streams progress until the app is live:

{"releaseId":"r20260714-101530-ab12cd34","status":"Pending"}
{"phase":"Building"}
{"phase":"Built"}
{"phase":"Available","url":"https://my-app.company.com","done":true,"success":true}

If the build fails, the compiler output arrives right there in the stream — no cluster access needed to debug.

4. Something went wrong? Roll back​

Every deploy is an immutable release. Rolling back redeploys the previous image instantly — no rebuild:

curl -X POST -H "Authorization: Bearer $PAGIFIER_TOKEN" \
     https://pagifier.company.com/v1/applications/my-app/environments/prod/rollback

Next steps​

  • Wire up CI so deploys happen on merge — one pipeline step: CI integration
  • Follow a complete worked example: static site · backend API with secrets · monorepo
  • Get editor autocomplete: for TOML, add #:schema https://pagifier.company.com/v1/schema/pagifier.json as the first line (Even Better TOML / taplo); for YAML, use # yaml-language-server: $schema=… with the same URL.
  • See everything you can set: the configuration reference