Deployment Overview of Quant-UX on Server¶

Prerequisites and Basic Requirements¶

To ensure the successful deployment of Quant-UX, the following requirements must be met:

• Operating System: Ubuntu (recommended).

• Privileges: Root or sudo access is required for installation.

• Ports:

• 443/tcp: External HTTPS traffic.

• 8082/tcp: Internal application access.

• 1025/tcp: SMTP testing (Mailpit).

FQDN of the final panel on the hostkey.in domain¶

The application is accessible via a dynamically generated subdomain based on the server ID.

File and Directory Structure¶

The application utilizes the following directory structure for configuration, data persistence, and proxy management:

• /opt/quantux/: Main application deployment directory containing the Docker Compose configuration.

• /opt/ant-ux/data/: MongoDB database storage.

• /opt/quant-ux/quant-ux-data/: Application backend data (images and app files).

• /root/nginx/: Nginx reverse proxy configuration files.

• /data/nginx/user_conf.d/: SSL and Nginx site configurations.

Application Installation Process¶

The installation is performed using a combination of system package management and Docker Compose:

1. System Preparation: The server environment is prepared, and the docker engine is installed to manage containerized services.

2. Directory Setup: A dedicated directory /opt/quantux is created with restricted permissions (0750).

3. Configuration Generation: A Docker Compose file (quantux-compose.yml) is generated in /opt/quantux.

4. Image Retrieval: The required Docker images are pulled from their respective registries.

5. Service Orchestration: Docker Compose is used to launch the application stack, ensuring all dependencies (database, backend, frontend) start in the correct order.

6. Proxy Configuration: An Nginx container is deployed via a separate compose file located in /root/nginx to handle SSL termination and reverse proxying.

Access Rights and Security¶

• Permissions: Application directories are configured with strict ownership (root) and specific modes (0750 or 0640) to prevent unauthorized access.

• Network Isolation: The application backend is bound to 127.0.0.1:8082 to ensure it is not directly accessible from the public internet, forcing all traffic through the Nginx proxy.

• SSL/TLS: SSL certificates are managed via Certbot and served through an Nginx container using external secrets volumes.

Databases¶

The application uses MongoDB as its primary data store.

Docker Containers and Their Deployment¶

The deployment consists of several containers managed via Docker Compose.

Application Stack (quantux-compose.yml)¶

Proxy Stack (compose.yml)¶

Application Update Instructions¶

To update the Quant-UX application, perform the following steps:

1. Navigate to the application directory:

   cd /opt/quantux
   

2. Pull the latest images and restart the services:

   docker compose pull && docker compose up -d