You can now turn any Git repo into a one-click deploy. Drop a "Deploy on Suga" button in your README, and anyone who clicks it lands in Suga with your project ready to configure and deploy.
If your repo already has a compose file, that's all you need. Suga reads it, wires up the services, and asks for any variables before deploying. No extra config to maintain alongside your project.
It works from a signed-out state, so the button is genuinely one click for whoever finds your repo. It's an easy way to share a working template, hand someone a starting point, or let people try your project without walking them through a setup.
Adding one is two lines of markdown. Point the link at your repo and use our badge as the image:
[](https://dashboard.suga.app/new/template?repo=your-org/your-repo)
Swap your-org/your-repo for your GitHub repo and you're done. A few options if you need them:
- If your compose file isn't on the default branch or at the repo root, add
&branch=and&path=to the link. - To point straight at a compose file anywhere, use
?compose=<url>instead of?repo=. - For READMEs with a dark background, swap the badge for
https://suga.app/badge-light.svg.
This will render like this: