Deploy on Skytells
Add a one-click Deploy on Skytells button to your README or documentation — let anyone deploy your project to Skytells in seconds.
The Deploy on Skytells button lets anyone deploy your open-source project or template to Skytells with a single click. Add it to your README, documentation, or landing page to give users a frictionless path from "I want to try this" to a running app.
The button
[](https://console.skytells.ai/deploy)It renders as:
Deploy on SkytellsWhen a user clicks the button, Skytells opens the New App flow pre-loaded with your repository so they can deploy it in one step — no manual URL pasting required.
Adding your repository to the button URL
To pre-fill the user's deploy flow with your specific repository, add a repo query parameter:
[](https://console.skytells.ai/deploy?repo=https://github.com/your-org/your-repo)Replace https://github.com/your-org/your-repo with your repository URL. The user's Skytells Console opens with the repository already imported — they only need to confirm and deploy.
What happens when a user clicks
User Lands on the Deploy Page
The user is taken to console.skytells.ai/deploy (with your repo parameter if provided).
Sign In or Create Account
If they are not signed in, they are prompted to sign in or create a Skytells account.
Select a Project
The New App page opens pre-filled with the repository URL. The user selects or creates a project to deploy into.
Review Build Settings
Skytells detects the framework and pre-configures the build settings. The user can review or adjust environment variables before deploying.
Deploy the App
The user selects Deploy. Skytells builds the image and provisions a live app with a *.skytells.app domain.
Button variants
Skytells provides six badge variants. Choose the one that fits your background.
Dark compact
Best for light-colored README backgrounds and most documentation sites.
Deploy on Skytells[](https://console.skytells.ai/deploy?repo=YOUR_REPO_URL)Light compact
Best for dark-colored README backgrounds (e.g. GitHub dark mode profiles).
Deploy on Skytells[](https://console.skytells.ai/deploy?repo=YOUR_REPO_URL)Dark (standard)
Full-width badge, dark variant. Use when you have more horizontal space.
Deploy on Skytells[](https://console.skytells.ai/deploy?repo=YOUR_REPO_URL)Light (standard)
Full-width badge, light variant.
Deploy on Skytells[](https://console.skytells.ai/deploy?repo=YOUR_REPO_URL)Dark large
Prominent badge for landing pages and product pages.
Deploy on Skytells[](https://console.skytells.ai/deploy?repo=YOUR_REPO_URL)Light large
Large badge for light-on-dark landing pages.
Deploy on Skytells[](https://console.skytells.ai/deploy?repo=YOUR_REPO_URL)Deploy URL parameters
All variants link to https://console.skytells.ai/deploy. The following query parameters customize the deploy flow:
| Parameter | Required | Description |
|---|---|---|
repo | No | Full URL of the Git repository to pre-fill in the import field. Example: https://github.com/your-org/your-repo. The user must have GitHub OAuth access to the repository. |
Usage in HTML
<a href="https://console.skytells.ai/deploy?repo=YOUR_REPO_URL">
<img
src="https://console.skytells.ai/brand/deploy-buttons/dark-compact.svg"
alt="Deploy on Skytells"
width="180"
height="36"
/>
</a>Environment variables
If your project requires environment variables to run, document them clearly near the deploy button so users know what to fill in before deploying. Example README pattern:
## Deploy
[](https://console.skytells.ai/deploy?repo=https://github.com/your-org/your-repo)
**Required environment variables:**
| Variable | Description |
|---|---|
| `DATABASE_URL` | PostgreSQL connection string |
| `API_SECRET` | Your secret API key |
| `NEXT_PUBLIC_API_URL` | Public API base URL |The Deploy on Skytells button works best for open-source repositories where Skytells can read the source code. For private repositories, the deploying user must connect their own GitHub account with OAuth access to the repository.
Related
- Create App — all ways to create a new app manually.
- GitHub Integration — connect GitHub via OAuth for CI/CD.
- Settings — Build — configure the build system automatically detected for your framework.
How is this guide?
Templates
Clone a production-ready starter template and deploy it to Skytells in seconds — no boilerplate setup required.
Overview
Skytells managed databases run as containers inside your project's private network. They are internal-only by default and reachable by all apps in the same project without any configuration. You can expose a database to the internet when needed.