ConvoyDocs

Deploy Your First App

Go from zero to a live application in under 5 minutes.

This guide walks you through deploying your first application on Convoy Cloud. By the end, your app will be live at a *.convoy-tech.com URL with TLS.

Prerequisites

Create a new deployment

  1. Go to Apps in the sidebar and click New Application.
  2. The deployment wizard has three steps: Source, Build, and Resources.

Step 1: Source

  • Application name — lowercase letters, numbers, and hyphens. This becomes part of your app's URL.
  • Source — select Code to deploy from a GitHub repository, or Existing image to deploy a pre-built container image.
  • For Code: select a repository, branch, and commit. The latest commit on the default branch is pre-selected.

Step 2: Build configuration

  • Build method — Convoy Cloud auto-detects whether your repo has a Dockerfile:
    • Dockerfile found → defaults to Dockerfile mode
    • No Dockerfile → defaults to Buildpack (automatic language detection)
    • You can override this.
  • Application port — the port your app listens on (default: 8080). A PORT environment variable is injected automatically.
  • Environment variables — add any variables your app needs, one per line in KEY=value format.
  • Health check — enabled by default. Convoy Cloud sends HTTP GET requests to verify your app is healthy. You can customize the path or disable it.

Step 3: Resources

Choose a preset or configure manually:

PresetCPUMemoryBest for
Nano50m64 MiBMinimal apps, health check endpoints
Micro100m128 MiBStatic sites, simple APIs
Starter250m256 MiBDev apps, low-traffic services
Standard500m512 MiBProduction workloads
  • Replicas — number of instances (1–10).
  • Estimated cost — shown in EUR per hour and per 14-day cycle.

Click Deploy to start.

Watch the build

After clicking Deploy, you land on the deployment detail view:

  • Live build logs stream in real time
  • Progress phases: Validation → Build → Push → Deploy → Live
  • Status: Pending → Building → Deploying → Deployed

Most builds complete in 1–3 minutes.

Your app is live

Once status shows Deployed, click the URL on the app detail page to open your application.

View metrics and logs

Click Observability in the sidebar, then Open Grafana to view metrics and logs. Access is provisioned automatically — no setup needed. See Observability overview.

View activity

Click Audit in the sidebar to see the full timeline of events for this deployment and your workspace.

Next steps