Skip to main content

​
Container Compose Installation

This guide provides comprehensive instructions for deploying the NeuralTrust Data Plane using Container Compose for development, testing, and smaller-scale production environments. Container Compose offers a simple yet powerful way to deploy all necessary components on a single machine or cluster, making it ideal for getting started quickly or for organizations that prefer containerized deployments with simplified management.

​
Prerequisites

Ensure the following tools are installed and properly configured on your system before beginning the installation: • Container Engine - Latest stable version recommended • Container Compose - Version 2.0 or higher • System Requirements: Minimum 4 CPU cores and 8GB RAM for optimal performance • Storage: At least 50GB available disk space for container images and data storage • Network: Internet connectivity for downloading container images and external service integration • Ports: Ensure ports 80, 443, and 8000-8010 are available for service communication Container Compose provides an excellent starting point for NeuralTrust deployments, particularly for development environments, proof-of-concept implementations, and smaller production deployments that don’t require the complexity of full container orchestration platforms.

​
Installation Process

​
Step 1: Repository Setup

Begin by cloning the NeuralTrust Deployment Charts repository, which contains all necessary configuration files and Container Compose definitions for deployment: 
git clone https://github.com/NeuralTrust/neuraltrust-deployment-charts.git
cd neuraltrust-deployment-charts/container-compose
This repository includes pre-configured Container Compose files, environment templates, and all necessary configuration files to deploy a complete NeuralTrust Data Plane environment with minimal manual configuration.

​
Step 2: Environment Configuration

Create and customize your environment configuration file: 
cp .env.example .env
nano .env  # Configure with your specific settings
Required Configuration Variables: 
# API Configuration
DATA_PLANE_API_URL=https://your-domain.com
JWT_SECRET=your-jwt-secret-key

# Database Configuration
DB_PASSWORD=secure-database-password
ANALYTICS_DB_PASSWORD=analytics-database-password

# External Service Integration
OPENAI_API_KEY=your-openai-api-key
HUGGINGFACE_TOKEN=your-huggingface-token

​
Step 3: Service Deployment

Deploy the complete NeuralTrust Data Plane stack using Container Compose with a single command: 
container-compose up -d
This command automatically downloads all required container images, creates the necessary networks and volumes, and starts all required infrastructure services, including message queue for real-time data streaming, coordination service for distributed operations, and analytics database for high-performance analytics storage. The deployment process typically takes 3-5 minutes depending on your internet connection speed and system performance. All services are configured with health checks and automatic restart policies to ensure reliable operation.

​
Step 4: Service Verification

Verify that all services are running correctly: Check Service Status: 
container-compose ps
Monitor Service Logs: 
container-compose logs api
container-compose logs worker
container-compose logs analytics
Access the Data Plane API: 
curl http://localhost:8000/health
Troubleshooting Common Issues: • Port conflicts: Modify port mappings in container-compose.yml if default ports are unavailable • Memory issues: Increase container memory limits in the compose file for resource-intensive workloads • Permission errors: Ensure the container engine has proper permissions to create volumes and networks • Network connectivity: Verify that the container engine can access external registries and repositories • Service startup failures: Check service logs with container-compose logs <service-name> for detailed error information • Database connection issues: Verify that database services are healthy and accessible • Analytics database startup: Verify that the analytics service is running and healthy using container-compose ps • Analytics service logs: Check analytics service logs for startup errors or configuration issues

​
Post-Deployment Configuration

​
Control Plane Integration

After successful deployment, connect your Data Plane to the NeuralTrust Control Plane for centralized management. This integration enables unified monitoring and control across multiple deployments and environments. Integration Steps:
  1. Access Control Plane: Log in to the NeuralTrust Portal using your provided credentials
  2. Add Data Plane: Navigate to Data Plane management and select “Add New Data Plane”
  3. Configure Connection: Enter your API endpoint and authentication credentials
  4. Verify Connection: Test the connection and ensure successful communication

​
Scaling and Optimization

Once your Container Compose deployment is operational, consider the following next steps to maximize your NeuralTrust experience: Performance Optimization: • Monitor resource usage and adjust container limits as needed for optimal performance • Configure appropriate log retention policies to manage disk space usage effectively • Set up automated backups for persistent data volumes to ensure data protection • Consider implementing container orchestration for larger-scale deployments requiring high availability Security Hardening: • Implement proper network security controls and firewall configurations • Configure SSL/TLS certificates for secure external communication • Review and customize authentication and authorization settings for your environment • Regular security updates and container image updates to maintain security posture
Development Ready: Container Compose deployment provides a complete NeuralTrust Data Plane environment suitable for development, testing, and smaller production deployments with simplified management and rapid deployment capabilities.
⌘I