OpenQDA Dev Docs

Appearance

OpenQDA Deployment ​

This guide describes how to deploy OpenQDA to your custom infrastructure. Currently, there are two options for deployment:

Backup and Recovery ​

OpenQDA includes a comprehensive backup script that can be scheduled to run automatically. The backup script creates a complete snapshot of your application data including database, storage files, and configuration. For detailed information on setting up automated backups, see the Backup & Recovery Guide.

Via Docker ​

Please note, that deployment via Docker is different from the Docker setup, described in the docker installation guide for local development!!

We will provide a comprehensive guide very soon. Until then, we would like to point you to the following resources:

Manual ​

Manual installation has great overlap with the manual development installation. We will soon provide this guide to cover topics, specific to the production installation (webserver, certificates etc.).

Supervisor Configuration for Production ​

OpenQDA requires background processes for WebSocket (Reverb) and queue workers. Supervisor is recommended for managing these processes in production.

Installing Supervisor ​

On Ubuntu/Debian:

bash
sudo apt-get update
sudo apt-get install supervisor

Configuration Files ​

Template configuration files are provided in web/docker/8.3/:

  1. supervisor-reverb.conf.example - WebSocket server configuration
  2. supervisor-queue.conf.example - Queue worker configuration
  3. supervisor-docker.conf.example - Complete configuration for Docker deployments

Setting Up Reverb WebSocket Server ​

  1. Copy the template:
bash
sudo cp web/docker/8.3/supervisor-reverb.conf.example /etc/supervisor/conf.d/reverb.conf
  1. Edit the configuration:
bash
sudo nano /etc/supervisor/conf.d/reverb.conf

  1. Update these values:

    • Replace /var/www/html with your Laravel application path
    • Set REVERB_HOSTNAME environment variable (e.g., your-domain.com)
    • Change user to match your web server user (typically www-data, nginx, or your app user)

  2. Update supervisor and start the service:

bash
sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start reverb

Setting Up Queue Worker ​

  1. Copy the template:
bash
sudo cp web/docker/8.3/supervisor-queue.conf.example /etc/supervisor/conf.d/queue-worker.conf
  1. Edit the configuration:
bash
sudo nano /etc/supervisor/conf.d/queue-worker.conf

  1. Update these values:

    • Replace /var/www/html with your Laravel application path
    • Adjust queue names if different from conversion,default
    • Change user to match your web server user

  2. Update supervisor and start the service:

bash
sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start queue-worker

Managing Supervisor Services ​

Check status of all services:

bash
sudo supervisorctl status

Restart a specific service:

bash
sudo supervisorctl restart reverb
sudo supervisorctl restart queue-worker

Stop a service:

bash
sudo supervisorctl stop reverb

View logs:

bash
sudo tail -f /var/log/supervisor/reverb.log
sudo tail -f /var/log/supervisor/queue-worker.log

Docker Deployment ​

For Docker deployments, use the supervisor-docker.conf.example template:

  1. In your Dockerfile, copy the configuration:
dockerfile
COPY web/docker/8.3/supervisor-docker.conf.example /etc/supervisor/conf.d/supervisord.conf
  1. Set required environment variables in your docker-compose.yml:
yaml
environment:
  - SUPERVISOR_PHP_COMMAND=/usr/bin/php -d variables_order=EGPCS /var/www/html/artisan serve --host=0.0.0.0 --port=80
  - SUPERVISOR_PHP_USER=sail
  - REVERB_HOSTNAME=localhost
  1. Ensure supervisor is installed in your Docker image and started as the entrypoint.

SSL Certificate Configuration ​

For SSL certificate setup with the WebSocket server, refer to: