Deploy button

One link in your README copies your project into the reader's Git account and deploys it on their own Deplo.

The Deploy on Deplo button puts your project one click away from anyone who runs Deplo. It opens their Deplo, copies your code into a new repository in their Git account, and puts it online on their server. Every push to that repository deploys again.

Deploy on Deplo

Try it: the button above copies Astroship, a small website starter, into your Git account and deploys it on your Deplo.

Quick start

Copy a snippet and put your repository's address after repo=.

[![Deploy on Deplo](https://deplo.build/button.svg)](https://deplo.build/deploy?repo=https://github.com/acme/app)

The repository has to be public, on GitHub or GitLab. No account, nothing to register.

What happens on click

deplo.build finds their Deplo. The first time, it asks for its address, like deplo.acme.com. After that, a 3-second countdown, with Deploy now, Change instance and Cancel.

They pick where the copy goes. The new-app screen shows Cloning from GitHub, then:

  • Git account: any GitHub account, or GitLab, Bitbucket or Gitea account or group, the team has connected.
  • Repository name: your project's name to start with. The lock switch makes it private, and it is on by default.

They review and deploy. App name, build and start commands, server and variables are the same as for any app from Git. Nothing is created until they click Deploy.

Deplo then creates the repository with your code in one commit, Initial commit from https://github.com/acme/app (main), and builds it with Railpack, which works out most languages and frameworks on its own.

Pick a branch or a compose file

LinkDeploys
?repo=https://github.com/acme/appThe default branch, built with Railpack
?repo=https://github.com/acme/app/tree/v1.2.0The v1.2.0 tag or branch
?repo=https://github.com/acme/app&compose=https://github.com/acme/app/blob/main/docker-compose.ymlmain, built with that compose file
?compose=https://github.com/acme/app/blob/v1.2.0/deploy/compose.ymlv1.2.0, built with deploy/compose.yml

A compose= link alone names the repository too. When both are there, they must point at the same repository. GitLab links work the same way: https://gitlab.com/acme/app/-/blob/main/compose.yml.

Older compose links

A compose= link to a file anywhere other than GitHub or GitLab still opens the template wizard, as before: Deplo reads that one file, plus a template.toml and a logo beside it.

Before the first deploy from GitHub

Deplo's GitHub App needs two more permissions to create a repository:

PermissionUsed for
Administration: Read and writeCreating the new repository
Contents: Read and writePutting your code in it

A GitHub App connected from a recent Deplo already has both. An older one shows Recreate GitHub App in the wizard: GitHub creates a new App with everything it needs, you install it on the same account, and your apps move to it on their own. The old App leaves that account, and you can delete it from your GitHub settings once nothing else uses it.

Deplo only creates a repository and writes its first commit. It never deletes or changes another one, and the access it hands a server to build is read-only.

A personal GitHub account needs one more step: the first time, Sign in with GitHub in the wizard, as that account. GitHub only lets an app create a repository in a personal account for the person who owns it. Organisations skip this step.

Limits

  • Public GitHub or GitLab repositories. Private ones, and other hosts, are not supported.
  • Size: 50 MiB download, 150 MiB of files, 5,000 files.
  • Symbolic links in the repository are left out of the copy.
  • Needs Deplo 0.8.2 or later. An older one opens an empty new-app screen.

Troubleshooting

MessageWhat to do
This Deploy button has to link to a public GitHub or GitLab repository.Check the link after repo= or compose=.
acme/app isn't a public GitHub repository, or it doesn't exist.Make the repository public, or fix the name.
acme/app has no compose.yml on main.The compose link names a file or branch that isn't there.
Deplo's GitHub App on acme can't create repositories.Click Recreate GitHub App in the wizard.
Sign in to GitHub as jane to create a repository there.Click Sign in with GitHub in the wizard, as that account.
acme already has a repository called app. Pick another name.Change Repository name.
Deplo created https://github.com/acme/app but couldn't copy the code into it.Delete that empty repository on GitHub, then try again.

Next steps

Did this page help you?

On this page