Skip to content

Add Deploy Button Documentation #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add Deploy Button Documentation #196

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
74c9035
Update apps/deploy.mdx
mintlify[bot] Feb 4, 2026
07f7d7b
Update apps/deploy.mdx
mintlify[bot] Feb 4, 2026
abdba1b
Update apps/deploy.mdx
mintlify[bot] Feb 4, 2026
1d37e35
Update apps/deploy.mdx
mintlify[bot] Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions apps/deploy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,39 @@ SUCCESS Total deployment time: 2.78s
```

Once deployed, you can [invoke](/apps/invoke) your app from anywhere.

## Deploy Button

The Deploy Button lets users deploy your Kernel app with a single click. It's ideal for sharing open-source projects, templates, or example apps that others can deploy to their own Kernel account.

### How it works

1. Go to the [Deploy Button generator](https://dashboard.onkernel.com/deploy-button) in the Kernel dashboard
2. Enter your public GitHub repository URL
3. Specify the required environment variables (API keys, secrets, etc.) that users need to provide
4. Copy the generated button snippet or link

When someone clicks your Deploy Button, they're taken to a deployment flow where they:
- Connect their Kernel account
- Enter the required environment variable values you specified
- Deploy the app to their account

### Use cases

- **Open-source projects**: Let users deploy your app without cloning repos or running CLI commands
- **Templates and starters**: Share ready-to-deploy examples that others can customize
- **Documentation**: Embed deploy buttons in READMEs so readers can try your code instantly

### Adding the button to your repository

After generating your button, add it to your README or documentation:

```markdown
[![Deploy](https://www.kernel.sh/brand_assets/kernel_deploy.svg)](https://dashboard.onkernel.com/deploy?repo=https%3A%2F%2Fgithub.com%2Forg%2Frepo&entrypoint=index.ts)
```

Or use HTML:

```html
<a href="https://dashboard.onkernel.com/deploy?repo=https%3A%2F%2Fgithub.com%2Forg%2Frepo&entrypoint=index.ts"><img src="https://www.kernel.sh/brand_assets/kernel_deploy.svg" alt="Deploy" /></a>
```