Skip to content
Railpack Docs

Getting Started

The easiest way to use Railpack is to deploy on a platform like Railway. Builds should work out of the box with minimal configuration. From there, you can see the docs for each language that Railpack supports.

If you want to run Railpack locally, follow the steps below. Follow this guide if you want to run Railpack on a platform in production.

Installation

Install Railpack from GH releases (or install with another method)

Terminal window
curl -sSL https://railpack.com/install.sh | sh

Confirm that Railpack is installed correctly:

Terminal window
railpack --help

Building

Before building, you need to have a BuildKit instance running and available through the BUILDKIT_HOST environment variable. The easiest way to do this is to run a BuildKit instance as a container:

Terminal window
docker run --rm --privileged -d --name buildkit moby/buildkit
export BUILDKIT_HOST=docker-container://buildkit

Now you can build your image using Railpack:

Terminal window
railpack build ./path/to/project

(there are many examples in the Railpack repo that you can test with)