Install supervisor on AWS EB with Laravel
Tags: laravel, aws, elasticbeanstalk
Published: 2021-06-05 20:24:14

---
title: Install supervisor on AWS EB with Laravel
published: true
description: How to install supervisor to run queue in background
tags: laravel, AWS, ElasticBeanstalk
cover_image: https://dev-to-uploads.s3.amazonaws.com/uploads/articles/mfpzmj33amrkxbpkczjo.png
---

In this article, we will see how to install Supervisor on AWS Elastic Beanstalk with Laravel.

## Prerequisites:

• I assume you deployed your Laravel project on AWS Elastic Beanstalk & make all configurations of queue & etc.
• Connect to SSH.
• I'm using Amazon Linux 2 (Nginx server).
• PHP 7.4 installed on AWS.

After connect to ssh follow these steps:

## Step 1: Install EPEL

The EPEL repository is an additional package repository that provides easy access to install packages for commonly used software.

```
$ sudo amazon-linux-extras install epel
```

## Step 2: Install supervisor

Let's install supervisor run the following command.

```
$ sudo yum install -y supervisor
```


## Step 3: Edit configuration file

Go to the default configuration file.

```
$ sudo vim /etc/supervisord.conf
```

Change the include directory at the end to:

```
files = supervisord.d/*.conf
```

## Step 4: Create new files

Add a new configuration file. If the directory doesn’t exist, then make one.

```
$ sudo vim /etc/supervisord.d/NameYouLike.conf
```
Give the setting:
```
[program:laravel-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /var/app/current/artisan queue:work sqs --sleep=3 --tries=3 --max-time=3600
autostart=true
autorestart=true
stopasgroup=true
killasgroup=true
user=root
numprocs=8
redirect_stderr=true
stdout_logfile=/var/app/current/storage/worker.log
stopwaitsecs=3600
```
###Note ⭕️
In `command` line, I'm using SQS for the queue, if you are using (Database or Redis) you should change it to the thing that you are using.


## Step 5: Launch Supervisor
```
$ sudo supervisord -c /etc/supervisord.conf
```

## Step 6: Apply The Changes
Apply new setting and check the status

```
$ sudo supervisorctl update;
$ sudo supervisorctl status
```

You should see something like that:

![Superviser](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/gywxyztbgjvh3nuubqu5.png)


## Step 7: Automatic start after system reboot
- Add a new configuration of restart Supervisor

```
$ sudo vim /etc/init.d/supervisord
```

Give this settings inside the file:

```
#! /bin/sh
### BEGIN INIT INFO
# Provides:          supervisord
# Required-Start:    $remote_fs
# Required-Stop:     $remote_fs
# Default-Start:     2 3 4 5
# Default-Stop:      0 1 6
# Short-Description: Example initscript
# Description:       This file should be used to construct scripts to be
#                    placed in /etc/init.d.
### END INIT INFO

# Author: Dan MacKinlay <danielm@phm.gov.au>
# Based on instructions by Bertrand Mathieu
# http://zebert.blogspot.com/2009/05/installing-django-solr-varnish-and.html

# Do NOT "set -e"

# PATH should only include /usr/* if it runs after the mountnfs.sh script
PATH=/sbin:/usr/sbin:/bin:/usr/bin
DESC="Description of the service"
NAME=supervisord
DAEMON=/usr/local/bin/supervisord
DAEMON_ARGS=""
PIDFILE=/var/run/$NAME.pid
SCRIPTNAME=/etc/init.d/$NAME

# Exit if the package is not installed
[ -x "$DAEMON" ] || exit 0

# Read configuration variable file if it is present
[ -r /etc/default/$NAME ] && . /etc/default/$NAME

# Load the VERBOSE setting and other rcS variables
. /lib/init/vars.sh

# Define LSB log_* functions.
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
. /lib/lsb/init-functions

#
# Function that starts the daemon/service
#
do_start()
{
	# Return
	#   0 if daemon has been started
	#   1 if daemon was already running
	#   2 if daemon could not be started
	start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
		|| return 1
	start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
		$DAEMON_ARGS \
		|| return 2
	# Add code here, if necessary, that waits for the process to be ready
	# to handle requests from services started subsequently which depend
	# on this one.  As a last resort, sleep for some time.
}

#
# Function that stops the daemon/service
#
do_stop()
{
	# Return
	#   0 if daemon has been stopped
	#   1 if daemon was already stopped
	#   2 if daemon could not be stopped
	#   other if a failure occurred
	start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
	RETVAL="$?"
	[ "$RETVAL" = 2 ] && return 2
	# Wait for children to finish too if this is a daemon that forks
	# and if the daemon is only ever run from this initscript.
	# If the above conditions are not satisfied then add some other code
	# that waits for the process to drop all resources that could be
	# needed by services started subsequently.  A last resort is to
	# sleep for some time.
	start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
	[ "$?" = 2 ] && return 2
	# Many daemons don't delete their pidfiles when they exit.
	rm -f $PIDFILE
	return "$RETVAL"
}

#
# Function that sends a SIGHUP to the daemon/service
#
do_reload() {
	#
	# If the daemon can reload its configuration without
	# restarting (for example, when it is sent a SIGHUP),
	# then implement that here.
	#
	start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
	return 0
}

case "$1" in
  start)
	[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
	do_start
	case "$?" in
		0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
		2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
	esac
	;;
  stop)
	[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
	do_stop
	case "$?" in
		0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
		2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
	esac
	;;
  #reload|force-reload)
	#
	# If do_reload() is not implemented then leave this commented out
	# and leave 'force-reload' as an alias for 'restart'.
	#
	#log_daemon_msg "Reloading $DESC" "$NAME"
	#do_reload
	#log_end_msg $?
	#;;
  restart|force-reload)
	#
	# If the "reload" option is implemented then remove the
	# 'force-reload' alias
	#
	log_daemon_msg "Restarting $DESC" "$NAME"
	do_stop
	case "$?" in
	  0|1)
		do_start
		case "$?" in
			0) log_end_msg 0 ;;
			1) log_end_msg 1 ;; # Old process is still running
			*) log_end_msg 1 ;; # Failed to start
		esac
		;;
	  *)
	  	# Failed to stop
		log_end_msg 1
		;;
	esac
	;;
  *)
	#echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
	echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
	exit 3
	;;
esac

:
```
- Add execute authority

```
$ sudo chmod +x /etc/init.d/supervisord
```

- Add the configuration into system

```
$ sudo chkconfig --add supervisord
```

- Switch on the configuration and start

```
$ sudo service supervisord start
```


##That it 🥳🚀