Deploy on Railway Button
Railway makes it easy to deploy any public GitHub repo with the Deploy on Railway button. The button transforms any Railway Template into a 1-click deployable project.
Button
The button is located at https://railway.app/button.svg.
You can also copy the button below:
The button should link to the desired template. Instructions are below for Starting with a New Template and Starting with an Existing Template.
Markdown
To render the button in Markdown, copy the following code and replace the link with your desired template:
HTML
To render the button in HTML, copy the following code and replace the link with your desired template:
Use Cases
Since the Deploy on Railway button generates a deterministic and reproducible deployment, it is an excellent way to share your project with the public and let others clone your project.
Use cases include the following:
- README files
- Tutorials and guides
- Getting Started docs
- Websites and social profiles
The button is also a way to take advantage of the Railway Open Source Kickback program, which provides open source maintainers a financial incentive to maintain templates on Railway.
Deploy on Railway Examples
Any Template on Railway can be made into a Deploy on Railway button.
Here are some example templates from the template gallery in button form:
Icon | Template | Button |
---|---|---|
Node | ||
Deno | ||
Bun | ||
SvelteKit | ||
Gin | ||
Flask | ||
Rails | ||
Django | ||
Sinatra | ||
Laravel |
Requirements
The only requirement to create a Deploy on Railway button is to first create a template. Services within a template can point to any public repository.
Services can be specified with environment variables, and additional configuration options like a start command.
Starting with a New Template
To create a Deploy on Railway button, you'll first need a public template. We've made it easy to get everything you need at railway.app/button.
This page is designed to guide you through the template creation process. The requirements are as follows:
- Template Name - Name the template:
- Services - Specify one or multiple services:
- Databases - Add the databases needed for the template:
- Demo Project - Choose a public project as a preview for the template:
That's all there is to it!
Starting with an Existing Template
To start with an existing template, log in to the Railway Dashboard and visit https://railway.app/account/templates.
From this page, you'll be able to create and share templates.
Edit this file on GitHub