Software Installation Instructions
Before starting the installation, make sure the environment is prepared and you have the deployment package for the system.
Prerequisites
- Docker and Docker Compose are installed
- The project directory with compose files and the environment template is prepared
- External ports
3000,8001,9000, and9001are free; if Adminer is used,8080must also be available - Credentials for accessing the Container Registry have been provided
Step 1. Prepare the Working Directory
Navigate to the project directory that contains the deployment files:
cd blast4d-compose-develop
Ensure the directory structure matches the expected layout:
blast4d-compose-develop/
├── services/ # Backend microservices (FastAPI)
├── frontend/ # Interface (Next.js)
├── shared/ # Shared modules
├── database/ # SQL schemas
├── keycloak/ # Authentication
├── nginx/ # Reverse proxy configuration
├── scripts/ # Deployment scripts
├── docker-compose.yml
├── docker-compose.prod.yml
├── .env.local # Environment variables template
└── ЗАПУСК_СИСТЕМЫ.md # Main startup guide
Step 2. Configure Environment Variables
Create a working environment file from the template:
cp .env.local .env
If necessary, open .env and fill in the values provided for your deployment: service addresses, credentials, and access parameters.
Step 3. Connect to the Container Registry
Log in to the Container Registry using the provided credentials:
docker login <container-registry-address>
Then pull the system container images:
docker compose -f docker-compose.yml -f docker-compose.prod.yml pull
Step 4. Review the Network Layout
Keep the distinction between internal and external ports in mind:
- Internal service ports inside the Docker network
xblast4d-network:8201,8202,8203,8204,8205,8206,8207,8209,8210,8212 - PostgreSQL, Redis, and MinIO ports are used by system services and do not require separate user-facing exposure
- External host ports are used to access the web interface and service components
The base compose file defines the system services and the internal network. The system is run using the operational deployment configuration.
System Components
The XBlast4D system includes the following components deployed via Docker Compose:
| Component | Description |
|---|---|
| Frontend | Web interface built on Next.js |
| API Gateway | API request routing |
| Computation Services | Backend modeling microservices |
| PostgreSQL | Relational database |
| MinIO | Object file storage |
| Keycloak | Authentication server |
| Nginx | Reverse proxy |
| Redis | Caching and task queues |
All application dependencies are already included in the container images provided through the Container Registry. Manual installation of Python, Node.js, or application libraries on the host system is not required.