Prerequisites:
- A Bun application ready for deployment
- A Railway account
- Railway CLI (for CLI deployment method)
- A GitHub account (for Dashboard deployment method)
Method 1: Deploy via CLI
1
Step 1
Ensure sure you have the Railway CLI installed.
terminal
2
Step 2
Log into your Railway account.
terminal
3
Step 3
After successfully authenticating, initialize a new project.
terminal
4
Step 4
After initializing the project, add a new database and service.
Step 4 is only necessary if your application uses a database. If you don’t need PostgreSQL, skip
to Step 5.
terminal
5
Step 5
After the services have been created and connected, deploy the application to Railway. By default, services are only accessible within Railway’s private network. To make your app publicly accessible, you need to generate a public domain.
terminal
Method 2: Deploy via Dashboard
1
Step 1
Create a new project
- Go to Railway Dashboard
- Click ”+ New” → “GitHub repo”
- Choose your repository
2
Step 2
Add a PostgreSQL database, and connect this database to the service
Step 2 is only necessary if your application uses a database. If you don’t need PostgreSQL, skip
to Step 3.
- Click ”+ New” → “Database” → “Add PostgreSQL”
- After the database has been created, select your service (not the database)
- Go to “Variables” tab
- Click ”+ New Variable” → “Add Reference”
- Select
DATABASE_URL
from postgres
3
Step 3
Generate a public domain
- Select your service
- Go to “Settings” tab
- Under “Networking”, click “Generate Domain”
Configuration (Optional)
By default, Railway uses Nixpacks to automatically detect and build your Bun application with zero configuration. However, using the Railpack application builder provides better Bun support, and will always support the latest version of Bun. The pre-configured templates use Railpack by default. To enable Railpack in a custom project, add the following to yourrailway.json
:
railway.json