Supervisors

Generality

Supervisor is a process control system that allows you to monitor and control a number of processes on UNIX-like operating systems. It provides a reliable way to keep processes running and automatically restart them if they crash. You can use it to run queues, websockets, laravel-echo-server, and other long-running processes. FlashPanel uses Supervisor to manage your processes and ensure they continue to work reliably.

Supervisor configuration

You can set up a supervisor process via the server's Supervisor tab. Steps to configure a supervisor process:

1. At the Supervisor tab > Select New Supervisor

2. Fill in the process information you want to set up:

   • Description (Optional): Brief description of the supervisor process
   • Command: Command to run. For example: php artisan queue:work
   • User: System user used to invoke the command, default flashpanel will be used
   • Directory (Optional): Directory to run your command from. This field can be left blank.
   • Number Processes: This option determines the number of instances of the process that will continue to run
   • Start Seconds: The total number of seconds the program needs to stay active for it to be considered a successful start

3. Select Save

After the supervisor process is successfully created, you will be able to easily perform operations on the process as follows:

Available operations include:

• Show Log: View the process log output
• Show Status: View the current status of the process
• Clear Log: Clear the process log file
• Restart: Restart the process
• Start: Start the process if it's stopped
• Stop: Stop the process
• Delete: Remove the supervisor configuration

Log files

FlashPanel automatically configures your supervisor to write to the log file. The logs can be found in the /home/flashpanel/.flashpanel/ directory. The log files are named supervisor-*.log. If the supervisor process is run with the system user root, the log file will be saved at /root/.flashpanel/.

WARNING

If you are using the user isolation feature of FlashPanel, you should navigate to the .flashpanel folder in the /home/flashpanel directory based on the user the supervisor belongs to locate the log file.