One-click deployment
Add a Deploy to Flux button
Let users deploy your GitHub, GitLab, or Bitbucket repository through Orbit directly from its README. The link opens the deployment wizard with your chosen settings already filled in.
Button preview
Click it to test the generated deployment link.
Button generator
A repository URL is required. Branch, project path, and plan are optional and use the repository default or Orbit default when omitted.
https://orbit.runonflux.com/?repo=https://github.com/RunOnFlux/deploy-with-git-samples&branch=master&projectPath=express&plan=freeAdd it to your README
Copy either snippet, paste it into your README, and commit the change. Explicitly including the repository URL makes the button reliable wherever the README is displayed.
Markdown
[](https://orbit.runonflux.com/?repo=https://github.com/RunOnFlux/deploy-with-git-samples&branch=master&projectPath=express&plan=free)HTML
<a href="https://orbit.runonflux.com/?repo=https://github.com/RunOnFlux/deploy-with-git-samples&branch=master&projectPath=express&plan=free"><img src="https://orbit.runonflux.com/deploytoflux.png" alt="Deploy to Flux" /></a>Supported parameters
repo- Full HTTPS repository URL.
branch- Branch to deploy.
projectPath- App directory for a monorepo.
plan- One of free, standard, pro, or custom.