Tannur

Quickstart Guide

Deploy your first application to Tannur in under 5 minutes using our REST API.

1. Get Your API Token

All API requests require authentication with an API token. Get yours from the dashboard:

  1. Log in to dashboard.tannur.xyz
  2. Go to Settings → API Tokens
  3. Click Generate New Token
  4. Copy your token and save it somewhere safe
export TANNUR_API_TOKEN="token_your_token_here"

2. Provision Your Project

Send a POST request to start provisioning. You'll get back a provisioningId to track progress.

curl -X POST https://api.tannur.xyz/api/projects/prj_xyz/provision \
  -H "Authorization: Bearer $TANNUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "projectSlug": "my-awesome-app",
    "buildCommand": "npm run build",
    "installCommand": "npm install",
    "startCommand": "npm start"
  }'

Response: You'll receive a JSON response with provisioningId: "pvn_abc123xyz"

3. Monitor Deployment Progress

Poll the status endpoint every 2 seconds to get real-time progress updates.

curl https://api.tannur.xyz/api/provisioning/pvn_abc123xyz/status \
  -H "Authorization: Bearer $TANNUR_API_TOKEN"

Response shows: progressPercentage, currentStep, and estimatedTimeRemaining

4. Access Your Deployed App

Once provisioning completes, your app is live at:

https://my-awesome-app.tannur.xyz

That's it! Your application is now deployed and accessible globally with HTTPS enabled.

Next Steps

Ctrl+I