Creating a Deploy to drie button

Warning

drie push is currently in beta and the APIs are subject to change as we stabilise the product. If something that was working stops working, please come back to the documentation to see if new behaviour is documented. If there’s no explanation, then please let us know.

The ‘Deploy to drie’ button enables users to deploy simple, buildpack-based apps to drie without leaving the web browser. The button is ideal for customers, open-source project maintainers or add-on providers who wish to provide their customers with a quick and easy way to deploy an app to drie.

The button is well-suited for use in README files, and is intended to serve as a replacement to a list of manual steps typically required to quickly deploy an app.

Here’s an example button that deploys a sample PHP app to drie:

_images/deploy-drie-app.png

This document describes the requirements for apps that use the ‘Deploy to drie’ service, and how to use these buttons make it easy to deploy source code you maintain to drie.

Warning

Please treat app instances spun up using these buttons as “test/throwaway/demo instances”. Although this is the fastest way to quickly deploy your app to the cloud, this method of deploying apps to drie is not the recommended way as it has some limitations:

  • At this time, private repos cannot be deployed using this method.
  • Every time you deploy an app using these buttons, a new instance with a new random app name and new URL are created each and every time.

Embedding the button in GitHub

If you’re embedding the button in a GitHub repository’s README file, drie deployer will automatically infer the repository URL from the referer header when someone clicks on the button.

Note

This is convenient because it avoids hard-coding the specific repository URL into the button, allowing forks and branches of the repository to work properly wthout a change to the button href.

Here’s an example:

[![Deploy to drie](http://master.driefiles.app.push.drieapp.co/images/deploy-drie-app.png)](https://deploy-button.push.drie.co/deploy)

Here’s the equivalent content as HTML if you’d prefer not to use Markdown:

1
2
3
<a href="https://deploy-button.push.drie.co/deploy">
  <img src="http://master.driefiles.app.push.drieapp.co/images/deploy-drie-app.png" alt="Deploy">
</a>

Adding an explicit parameter

Use the following Markdown snippet as a tenplate, changing the git_repo_url query parameter to the URL of your repository:

[![Deploy to drie](http://master.driefiles.app.push.drieapp.co/images/deploy-drie-app.png)](https://deploy-button.push.drie.co/deploy?git_repo_url=https://github.com/drie/drie-php-getting-started.git)

Here’s the equivalent content as HTML if you’d prefer not to use Markdown:

1
2
3
<a href="https://deploy-button.push.drie.co/deploy?git_repo_url=https://github.com/drie/drie-php-getting-started.git">
  <img src="http://master.driefiles.app.push.drieapp.co/images/deploy-drie-app.png" alt="Deploy">
</a>