Devyzer
Search…
⌃K

Creating a 'Deploy to Devyzer' Button

The ‘Deploy to Devyzer’ button enables users to deploy apps to Devyzer without leaving the web browser and with little or no configuration. 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 and configure a Devyzer silo
The button is well-suited for use in README files and is intended to serve as a replacement for a list of manual steps typically required to configure an app.
Here’s an example button that deploys a sample Node.js app to Heroku:
Deploy to Devyzer
This document describes the requirements for apps that use the ‘Deploy to Devyzer’ service, and how to use these buttons to make it easy to deploy the source code you maintain to a Devyzer silo.

Button Terms of Use

The Devyzer Terms of Use governs the Terms of Use of your button unless you provide your own Terms of Use in your GitHub repository. It is common practice to link to your Terms of Use in your README file or to add them as a license file to your GitHub repository.

Adding the Devyzer button

You can do it by using an explicit repo-url the parameter that points to the repo - useful for buttons sitting outside of the GitHub repositories, in blog posts for example, and for private GitHub repositories.
Here’s an example:
[![Deploy](https://www.devyzer.io/deploy/button.svg)](https://devyzer.io/silos/new)
Here’s the equivalent content as HTML if you’d prefer not to use Markdown:
<a href="https://devyzer.io/silos/new">
<img src="https://www.devyzer.io/deploy/button.svg" alt="Deploy">
</a>
button.png is also available.

Adding an explicit parameter

Use the following Markdown snippet as a template, change the template query parameter to the URL of your repository:
[![Deploy](https://www.devyzer.io/deploy/button.svg)](https://devyzer.io/silos/new?repo-url=https://github.com/devyzer/laravel-getting-started)
Here’s the equivalent content as HTML if you’d prefer not to use Markdown:
<a href="https://devyzer.io/silos/new?repo-url=https://github.com/devyzer/laravel-getting-started"> <img src="https://www.devyzer.io/deploy/button.svg" alt="Deploy"></a>

Parametrizing buttons

It’s possible to supply URL parameters in the Button URL, For example, you might have the following button URL:
https://devyzer.io/silos/new?source=git&repo-url=htthttps://github.com/devyzer/laravel-getting-started&name=Demo+App&branch=master&container=php-74&type=laravel&source=git
The below are the supported parameters:
  1. 1.
    name: The name of your app/silo
  2. 2.
    repo-url: The URL of the repository you would like to deploy
  3. 3.
    type: Type of your project (Framework), Example: laravel, wordpress
  4. 4.
    container: The container that you need to use to deploy your silo on. The current supported containers are php-80|php74|php73|php72|php71
  5. 5.
    source: The source type of your repo-url, such as: github, git, version. If you are using a public repository or a repo url with a token, you can use the type git, and if you are targeting your private GitHub repo, use the github type, otherwise if your project type is WordPress and you would like to specify its version, then use version type
  6. 6.
    branch: The target branch that you want to deploy
  7. 7.
    wordpress-version: Use this to specify the WordPress version you need to deploy, in case the project type is WordPress, and the source is set to version.

Button image

When linking to the Devyzer Button set-up flow, you can either use a raw link or an image link. If using an image, Devzyer makes available both PNG and SVG versions at these URLs:
  • https://devyzer.io/deploy/button.png
  • https://devyzer.io/deploy/button.svg

Private GitHub repos

Devyzer Button works on both public and private GitHub repos. Using Devyzer Button on private repos comes with some limitations like when setting up an silo from a button hosted in a private GitHub repo, the current Devyzer user must be linked with GitHub and have access to the repo