Quantux Deployment Overview on Server¶

Prerequisites¶

The following configuration parameters are required for the application to function correctly:

Parameter	Value
Operating System	Ubuntu
External Port	`443` (HTTPS)
Internal Port	`8082`
Docker Access	Docker and Docker Compose must be installed

FQDN of the final panel on hostkey.in domain¶

The domain name is formed according to the following pattern:

Parameter	Value
Prefix	`quantux`
Domain	`hostkey.in`
Full Pattern	`quantux{Server_ID_from_Invapi}.hostkey.in`

File and Directory Structure¶

Main directories used in the system:

/opt/quantux — application working directory (contains quantux-compose.yml).
/root/nginx — Nginx reverse proxy configuration.
/data/nginx/user_conf.d — custom Nginx configurations.
/data/nginx/nginx-certbot.env — environment variables for Certbot.
/opt/quant-ux/data — MongoDB database data.
/opt/quant-ux/quant-ux-data — application user data (images and files).

Application Installation Process¶

Deployment is performed by running containers via Docker Compose. The application consists of the core Quantux software and an Nginx reverse proxy for SSL certificate management. First, the application infrastructure is deployed in the /opt/quantux directory, followed by the configuration of the nginx-certbot reverse proxy in the /root/nginx directory.

Docker Containers and Execution¶

Proxy Server (Nginx Certbot)¶

The container is responsible for managing SSL certificates via Let's Encrypt.

Image Name: jonasal/nginx-certbot:latest
Network: host
Volumes:
nginx_secrets:/etc/letsencrypt
/data/nginx/user_conf.d:/etc/nginx/user_conf.d
Environment Variables: [email protected]
Restart Policy: unless-stopped

Core Application Containers (Quantux)¶

Container Name	Image Name	Ports	Volumes	Restart Policy
`quant-ux-smtp-sink`	`axllent/mailpit`	—	—	`always`
`quant-ux-mongo`	`mongo`	—	`/opt/quant-ux/data:/data/db`	`always`
`quantux{Server_ID}.hostkey.in`	`klausenschaefersinho/quant-ux`	`127.0.0.1:8082:8082`	—	`always`
`quant-ux-backend`	`bmcgonag/qux-be`	—	`/opt/quant-ux/quant-ux-data:/app-data`	`always`
`quant-ux-websocket-server`	`klausenschaefersinho/quant-ux-websocket`	—	—	`always`

Databases¶

MongoDB is used as the database management system.

Container Name: quant-ux-mongo
Data Storage Path: /opt/quant-ux/data:/data/db
Connection Settings (in backend): mongodb://quant-ux-mongo:27017, database quantux.

Application Update¶

Updates are performed by pulling new image versions and restarting containers. To update, execute the following commands in the project directories:

docker compose pull && docker compose up -d

Permissions Settings¶

Access permissions for the main directories are configured as follows:

/opt/quantux: owner root, group root, mode 0750.
/opt/quantux/quantux-compose.yml: owner root, group root, mode 0640.
/root/nginx: owner root, group root, mode 0755.

Available Ports for Connection¶

Port	Purpose	Accessibility
`443`	Web Interface (HTTPS)	External
`8082`	Internal Frontend Access	Local only (`127.0.0.1`)

Starting and Stopping the Application¶

Container management is performed via Docker Compose in the /opt/quantux and /root/nginx directories.

Start all services:

docker compose up -d

Stop all services:

docker compose down