Appearance
Deploy button
Add a Deploy on Fjordrun button to your README, blog post or docs so readers can deploy your project in a few clicks.
Deploy a GitHub repository
markdown
[](https://app.fjordrun.com/deploy?repo=owner/repo)Link parameters:
| Parameter | Required | Meaning |
|---|---|---|
repo | yes | The GitHub repository, owner/repo |
branch | no | Branch to deploy (default: the repository's default branch) |
root | no | Root directory for monorepos, for example apps/web |
Example for a monorepo app on a release branch:
text
https://app.fjordrun.com/deploy?repo=acme/shop&branch=release&root=apps/webThe reader logs in (or signs up), picks a team and project, and Fjordrun builds the repository with the Fjordrun builder. The repository must be public, or the reader must have access to it through their connected GitHub account.
Deploy a template
markdown
[](https://app.fjordrun.com/deploy?template=postgres)Template codes: postgres, mysql, redis, mongodb, minio, umami, n8n, langflow, ollama, qdrant. See Templates, or run fjordrun templates list.
HTML
html
<a href="https://app.fjordrun.com/deploy?repo=owner/repo">
<img src="https://fjordrun.com/button.svg" alt="Deploy on Fjordrun" />
</a>Make your repository deploy smoothly
- Make sure it builds without manual steps: a Dockerfile, or a framework the builder detects.
- Listen on
0.0.0.0:$PORT. - Document the variables readers must set (an
.env.examplehelps), and give safe defaults where possible. - If it needs a database, say which, for example "add PostgreSQL and set
DATABASE_URL=${{Postgres.DATABASE_URL}}".