Deploy a Laravel App

Laravel is a PHP framework designed for web artisans who value simplicity and elegance in their code. It stands out for its clean and expressive syntax, and offers built-in tools to handle many common tasks found in modern web applications, making development smoother and more enjoyable.

This guide covers how to deploy a Laravel app on Railway in three ways:

1. One-click deploy from a template.
2. From a GitHub repository.
3. Using the CLI.

One-Click Deploy from a Template

This template sets up a basic Laravel application along with a Postgres database on Railway. You can also choose from a variety of Laravel app templates created by the community.

We highly recommend that you eject from the template after deployment to create a copy of the repo on your GitHub account.

Deploy from a GitHub Repo

To deploy a Laravel app on GitHub to Railway, follow the steps below:

1. Create a New Project.
2. Click Deploy from GitHub repo.
3. Select your GitHub repo.
   • Railway requires a valid GitHub account to be linked. If your Railway account isn't associated with one, you will be prompted to link it.
4. Click Add Variables.
   • Add all your app environment variables.
5. Click Deploy.

Once the deployment is successful, a Railway service will be created for you. By default, this service will not be publicly accessible.

Note: Railway will automatically detect that it's a Laravel app during deploy and run your app via php-fpm and nginx.

To set up a publicly accessible URL for the service, navigate to the Networking section in the Settings tab of your new service and click on Generate Domain.

Note: Jump to the Set Up Database, Migrations, Crons and Workers section to learn how to run your Laravel app along with a Postgres(or MySQL) database, cron jobs, and workers.

Deploy from the CLI

If you have your Laravel app locally, you can follow these steps:

1. Install and authenticate with the Railway CLI.
2. Run railway init within your Laravel app root directory to create a new project on Railway.
   • Follow the steps in the prompt to give your project a name.
3. Run railway up to deploy.
   • The CLI will now scan, compress and upload our Laravel app files to Railway's backend for deployment.
   • Your terminal will display real-time logs as your app is being deployed on Railway.
4. Once the deployment is successful, click on View logs on the recent deployment on the dashboard.
   • You'll see that the server is running. However you'll also see logs prompting you to add your env variables.
5. Click on the Variables section of your service on the Railway dashboard.
6. Click on Raw Editor and add all your app environment variables.
7. Click on Deploy to redeploy your app.

To set up a publicly accessible URL for the service, navigate to the Networking section in the Settings tab of your new service and click on Generate Domain.

Note: The next step shows how to run your Laravel app along with a database, migrations, cron jobs, and workers.

Set Up Database, Migrations, Crons and Workers

This setup deploys your Laravel app on Railway, ensuring that your database, scheduled tasks (crons), and queue workers are all fully operational.

The deployment structure follows a "majestic monolith" architecture, where the entire Laravel app is managed as a single codebase but split into four separate services on Railway:

• App Service: Handles HTTP requests and user interactions.
• Cron Service: Manages scheduled tasks (e.g., sending emails or running reports).
• Worker Service: Processes background jobs from the queue.
• Database Service: Stores and retrieves your application's data.

My Majestic Monolith Laravel app

Please follow these steps to get started:

1. Create three bash scripts in the root directory of your Laravel app: run-app.sh, run-worker.sh, and run-cron.sh.

   These scripts will contain the commands needed to deploy and run the app, worker, and cron services for your Laravel app on Railway.

   • Add the content below to the run-app.sh file:

     Note: You can add any additional commands to the script that you want to run each time your App service is redeployed.

     #!/bin/bash
     # Make sure this file has executable permissions, run `chmod +x run-app.sh`
     
     # Build assets using NPM
     npm run build
     
     # Clear cache
     php artisan optimize:clear
     
     # Cache the various components of the Laravel application
     php artisan config:cache
     php artisan event:cache
     php artisan route:cache
     php artisan view:cache
     
     # Run any database migrations
     php artisan migrate --force

   • Add the content below to the run-worker.sh file:

     #!/bin/bash
     # Make sure this file has executable permissions, run `chmod +x run-worker.sh`
     
     # This command runs the queue worker. 
     # An alternative is to use the php artisan queue:listen command
     php artisan queue:work

   • Add the content below to the run-cron.sh file:

     #!/bin/bash
     # Make sure this file has executable permissions, run `chmod +x run-cron.sh`
     
     # This block of code runs the Laravel scheduler every minute
     while [ true ]
         do
             echo "Running the scheduler..."
             php artisan schedule:run --verbose --no-interaction &
             sleep 60
         done

2. Create a Postgres Database service on the Project Canvas.

   • Click on Deploy.

3. Create a new service on the Project Canvas.

   • Name the service App service, and click on Settings to configure it.
   • Connect your GitHub repo to the Source Repo in the Source section.
   • Add chmod +x ./run-app.sh && sh ./run-app.sh to the Custom Build Command in the Build section.
   • Head back to the top of the service and click on Variables.
   • Add all the necessary environment variables required for the Laravel app.
   • Click Deploy.

4. Create a new service on the Project Canvas.

   • Name the service cron service, and click on Settings.
   • Connect your GitHub repo to the Source Repo in the Source section.
   • Add chmod +x ./run-cron.sh && sh ./run-cron.sh to the Custom Start Command in the Deploy section.
   • Head back to the top of the service and click on Variables.
   • Add all the necessary environment variables.
   • Click Deploy.

5. Create a new service again.

   • Name the service worker service, and click on Settings.
   • Connect your GitHub repo to the Source Repo in the Source section.
   • Add chmod +x ./run-worker.sh && sh ./run-worker.sh to the Custom Start Command in the Deploy section.
   • Head back to the top of the service and click on Variables.
   • Add all the necessary environment variables.
   • Click Deploy.

At this point, you should have all three services deployed and connected to the Postgres Database service:

• Cron Service: This service should run the Laravel Scheduler to manage scheduled tasks.

• Worker Service: This service should be running and ready to process jobs from the queue.
• App Service: This service should be running and is the only one that should have a public domain, allowing users to access your application.

App service

Note: There is a community template available that demonstrates this deployment approach. You can easily deploy this template and then connect it to your own GitHub repository for your application.

Can I deploy with Laravel Sail?

You may be thinking about using Laravel Sail, which is the standard approach for deploying Laravel applications with Docker. At its core, Sail relies on a docker-compose.yml file to manage the environment.

However, it's important to note that Railway currently does not support Docker Compose.

Next Steps

Explore these resources to learn how you can maximize your experience with Railway:

• Monitoring
• Deployments