Server setup

This guide contains the commands to install a Rocket-ready server but can also be used for any other Laravel project.

This guide is intended for beginners. If you already know how to deploy a Laravel project, go to the Deploying Rocket page.

It was written and tested on Ubuntu 20.10 and should work on any system using apt.

Installing the packets

System utilities

sudo apt install \
    git curl zip unzip sl \
    redis supervisor

Web server

First, add ondrej/php PPA

sudo add-apt-repository ppa:ondrej/php
sudo apt-get update

Then install the web-server required packages

sudo apt install \
    apache2 php8.0 libapache2-mod-php \
    php8.0-bcmath php8.0-cli php8.0-common php8.0-curl php8.0-fpm php8.0-gd php8.0-gmp php8.0-intl php8.0-mbstring php8.0-mysql php8.0-opcache php8.0-pgsql php8.0-readline php8.0-xml php8.0-zip php8.0-imagick php8.0-redis

Composer

sudo wget https://getcomposer.org/download/2.0.0/composer.phar
sudo chmod +x composer.phar
sudo mv composer.phar /usr/bin/composer
sudo composer self-update

Node, npm and Yarn

sudo curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt update
sudo apt install yarn npm -y

MySQL

sudo apt install mysql-server -y
sudo mysql_secure_installation

Your server should be ready to run any PHP project.

Configuration

Cloning Rocket

CURRENTUSER=$(whoami)
sudo chmod 777 /var/www
sudo chown -R $CURRENTUSER:$CURRENTUSER /var/www

mkdir -p /var/www/rocket/current
git clone https://github.com/deploywithrocket/core /var/www/rocket/current

cd /var/www/rocket/current
cp .env.example .env
composer install --no-dev
yarn
yarn prod
php artisan key:generate
php artisan migrate --seed
php artisan storage:link
chmod 777 -R storage bootstrap/cache

Create the database

Don't forget to replace MYSQL_PASSWORD with a randomly generated password.

sudo mysql --execute="create database rocket;"
sudo mysql --execute="create user 'rocket'@'localhost' identified by 'MYSQL_PASSWORD';"
sudo mysql --execute="grant all privileges on rocket.* to rocket@localhost;"
sudo mysql --execute="flush privileges;"

Create the virtual host

cd /etc/apache2/sites-available
sudo nano rocket.conf

Don't forget to replace ServerName and DocumentRoot properties.

<VirtualHost *:80>
  ServerAdmin contact@rocket.org
  ServerName deploywithrocket.dev

  DocumentRoot /var/www/rocket/current/public

  <Directory /var/www/rocket/current>
          AllowOverride All
  </Directory>

  ErrorLog /var/log/apache2/rocket/error.log
  CustomLog /var/log/apache2/rocket/access.log combined
</VirtualHost>

sudo mkdir -p /var/log/apache2/rocket
sudo a2enmod rewrite
sudo a2ensite rocket
sudo a2dissite 000-default
sudo apachectl restart

Setup a queue listener

cd /etc/supervisor/conf.d/
nano rocket-worker.conf

[program:rocket-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/rocket/current/artisan queue:work --tries=3
autostart=true
autorestart=true
user=www-data
numprocs=4
redirect_stderr=true
stdout_logfile=/var/www/rocket/storage/logs/worker.log

sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start rocket-worker:*

Schedule the scheduler

sudo crontab -e

* * * * * cd /var/www/rocket/current && php artisan schedule:run >> /dev/null 2>&1