Deploy Laravel on Railway
Tags: laravel, beginners, tutorial, devops
Published: 2022-08-04 13:43:09

In this article, I will show you how to properly deploy a Laravel project on Railway, an infrastructure platform that handle all the system administration and DevOps tasks for you.

Making Laravel work on Railway is easy enough, but there are a few catches that deserve a thorough explanation. Unless you want to spend an entire day browsing the internet like I did to search for nonexistent explanations, perks of being an early adopter!

One of Railway characteristic is that every time a deployment occurs, your project server is rebuilt with your new code, which mean that everything stored on the file system is erased. 

If you're not familiar with PHP deployment on horizontally scaled architecture or blue-green deployment, we will cover all the configuration tweaks that you need to do to make your Laravel project work properly.

## 1. First deployment

Railway deployments are based on Nixpacks, an open source tool (developed by the Railway team) that read your project source code and create a compatible image where it can run.

On a standard Laravel project, Nixpacks will set up nginx to handle requests, PHP with your project's required version, NodeJS with your favorite package manager Yarn, pnpm or npm.

Creating a project is straightforward, just head to [Railway.app/new](https://railway.app/new), set up your account, and choose the repository to deploy.

![New Railway project](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/wlg8qf92de2ctqkwd4x1.png) 

If you gave Railway access to a GitHub repository, you automatically got push-to-deploy setup, pretty nice.

Your project is now deploying, the build step should work fine, but you won't be able to visit your landing page because Laravel need a few environment variables to run.

![First project build](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/3nqffbvvzkg0izmegd0r.png)

You can paste the content of your `.env` file in the raw editor with the values you would like for production.

We can also tell Nixpacks to add a few dependencies when building our project with the `NIXPACKS_PKGS` env variable, like PHP Redis to communicate with a Redis server, and PHP GD to work with images file.

![Project environment variables](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/eb4h751lbs5q5720gj44.png) 

You can search for [available packages here]( https://search.nixos.org/packages) to make sure you get the syntax right.

A new deployment will automatically start to rebuild your project with the provided environment variables.

By default, your project will not be publicly accessible, you can head to the settings panel and generate a Railway subdomain with SSL, or follow instructions to use your own domain.

![Railway subdomain](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/o0zueyzjxm9dcqdhbykr.png)

## 2. Database creation

Because the file system is reset on every deployment, using a local database like SQLite is not possible. No worries, Railway offers MySQL, PostgreSQL, MongoDB and Redis.

In your Railway project, click on the **new** button, and choose your favorite database management system.

![New service](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/my572joxllfkuneb40de.png)
 
Once created, you will be able to retrieve the credentials in the **Variables** panel.

![MySQL credentials](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/0synf4kvompmlmotfqgq.png) 

You can copy these values in your Laravel project environment variable to give your code access to the database.

![Laravel database environment variable](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/016c07u1b146xuk121z9.png)
 
A new deployment will automatically rebuild your project with the provided environment variables and give your code access to the database. Keep in mind the database does not yet contain any table as we did not run Laravel's migration.

## 3. Redis

No persistent file system means that the default Laravel drivers for cache, queue, and session will not work properly, disconnecting our users at every deployment.

To fix this we need Redis, it can be created the same way as our MySQL/PostgreSQL database.

Again, you will need to copy the credentials found in the **Variables** panel to your `.env` file, and configure Laravel session, cache, and queue to use the Redis driver.

![Redis credentials](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/x5apl4d58xgoa6n1vb7j.png)

![Laravel Redis environment variable](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/jb16wz7evi1zt03l49r6.png)
  
## 4. Customizing the build step

During deployment, Nixpack will install your project dependencies and run the **build** command of your `package.json` to build assets:

- composer require
- [yarn|npm|pnpm] install
- [yarn|npm|pnpm] run build

This is fine if you are serving a simple static site, but it is missing some Laravel specific steps.

The best way to do this is to set the `NIXPACKS_BUILD_CMD` environment variable to run the following commands:

- [yarn|npm|pnpm] run build
- php artisan optimize
- php artisan migrate --force

Notice that we need to include the assets building step, as it will be otherwise replaced by our new commands.

![Custom build environment variable](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/sy46pdxybdox2v4cl7o6.png)

I illustrate a simple approach here by running each command in a chain with `&&`, but you could put all this in a composer script, a bash script or a Makefile.

## 5. Creating a worker server

Railway only allows a single process by server, you currently have a web process running nginx and serving your PHP code. 

What if you need another process to run a queue job in your app?

Then we just create a new server to serve that exact purpose! 

In your Railway project, click on the **new** button, and choose your code repository again to create a second server.

Copy all your environment variable to make sure both code instances run with the same configuration, and override the `NIXPACKS_START_CMD` variable to run Laravel queue worker instead of a web server.

![Custom start environment variable](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/7dxtrh4cmukmm5pieslb.png)
 
Your worker should now process your queue jobs. You can create as many workers as you want with different configuration to suit your project's needs.

## 6. Make signed route works

You might already experience issues with signed routes if you worked with a load balancer before.

When setting up a project, Railway will receive the request and proxy it to your server with the HTTP protocol.

```
Request -https-> Railway -http-> Server
```

When generating a signed route, Laravel with create a hash value of the full URL (which will be https), but when a user clicks the link, your code will verify the signature hash with a URL starting with `http` instead of https, making the signature invalid.

There are two things you can add to your code to prevent this, first force all URLs to be generated with the `https` protocol. This can be done in your `AppServiceProvider` boot method:

```php
public function boot()
{
    if ($this->app->environment('production')) {
        URL::forceScheme('https');
    }
}
```

Then we need to trust Railway proxy to serve `https`, this can be configured in the `TrustProxies` middleware by setting the `proxies` property to a wildcard `*`:

```php
<?php

namespace App\Http\Middleware;

use Illuminate\Http\Middleware\TrustProxies as Middleware;
use Illuminate\Http\Request;

class TrustProxies extends Middleware
{
    protected $proxies = '*';
    
    ...
}
```

Using a wildcard might not be a best practice, but I could not find a list of Railway IPs, let me know if you find one!

## 7. Blue green deployment

Finally, we need to make deployment zero-downtime. For this, we need to make sure that when a new deployment is creating a new server, Railway can verify our code run properly before switching user traffic to the new server and shutting down the previous one.

Railway offers health checks that do exactly this, you can choose the route that will be requested, and when it returns a success code (2xx), Railway will know that your server is ready to receive requests.

![Health checks](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/7h1qy21o2eh70k9vboiv.png)

## Conclusion

I've been looking for the "Vercel for PHP" for a long time, Railway is still a young service that lacks some flexibility, but the developer experience make up for it. I can't wait to see it evolve in the following years!

That said, I still use services like Laravel Vapor or Laravel forge, that are pricier but offer better performance, flexibility, configuration and remain my go-to platforms for serious professional project.