Skip to main content

Documentation Index

Fetch the complete documentation index at: https://unkey.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Unkey Deploy is in public beta. To try it, open the product switcher in the top-left of the dashboard and select Deploy. During beta, deployed resources are free. We’re eager for feedback, so let us know what you think on Discord, X, or email support@unkey.com.
This guide walks you through deploying an application on Unkey for the first time. You’ll create a project, connect a GitHub repository, and have a running app with a live URL.

​
Prerequisites

  • An Unkey account
  • A GitHub repository with a Dockerfile

​
Create a project

1

Start a new project

Navigate to your workspace and click New project. Enter a project name and slug, then click Create Project.
Create project form
2

Import from GitHub

Click Import from GitHub. If you haven’t installed the Unkey GitHub App yet, you’ll be prompted to install it on your organization or personal account.
Import from GitHub
3

Select a repository

Choose your repository and branch. Unkey auto-detects Dockerfiles and shows their status next to each repo.
Repository selection
Don’t have a repository ready or want to deploy with the CLI instead? Click Skip for now to finish onboarding without selecting a repository. You can connect GitHub later from your project’s settings.
4

Configure build settings

Review the defaults for root directory, Dockerfile path, and watch paths. Expand Runtime settings to configure regions, CPU, and memory. Expand Advanced configurations to add environment variables.
Configure deployment
5

Deploy

Click Deploy. Unkey builds your image, provisions infrastructure across your selected regions, and assigns domains.
Deployment progress
Once the deployment reaches Ready, your app is live. Unkey assigns several domains automatically, including an environment domain and a commit-specific domain.

​
What happens next

After the initial setup, every push to your repository triggers a new deployment automatically:
  • Pushes to the default branch (typically main) deploy to production.
  • Pushes to any other branch deploy to preview.
Each deployment gets its own unique URL, so you can test any version independently.

​
Next steps

GitHub integration

Branch mapping, fork protection, and watch paths

App settings

Configure regions, CPU, memory, health checks, and more

Variables

Add environment-specific configuration

Custom domains

Serve your app from your own domain
Last modified on April 28, 2026