​
Docker Compose Installation

This guide provides comprehensive instructions for deploying the NeuralTrust Data Plane using Docker Compose.

​
Prerequisites

Ensure you have the following tools installed:

Additionally, ensure you have:

  • An OpenAI API key
  • A HuggingFace token (provided by NeuralTrust)
  • A Google Container Registry (GCR) service account key (provided by NeuralTrust)

​
1. Clone the Repository

Begin by cloning the NeuralTrust Helm Charts repository:

git clone https://github.com/NeuralTrust/neuraltrust-helm-charts.git
cd neuraltrust-helm-charts/docker-compose

​
2. Configure Environment Variables

Create a .env file in the docker-compose directory:

cp .env.example .env

Define the following variables in your .env file:

  • ENVIRONMENT: Set to dev or prod based on your deployment.
  • EMAIL: Email address for Let’s Encrypt certificates.
  • OPENAI_API_KEY: Your OpenAI API key.
  • HUGGINGFACE_TOKEN: The HuggingFace token provided by NeuralTrust.
  • GCR_KEY_FILE: Path to the Google Container Registry service account key file provided by NeuralTrust.

Ensure all placeholders are replaced with your actual values.

​
3. Start the Services

Run the following command to start the deployment:

docker compose up -d

This command will:

  1. Start the required infrastructure services, including:
    • Kafka
    • Zookeeper
    • ClickHouse
  2. Deploy the Data Plane components:
    • API service
    • Worker service

​
4. Connect to the Control Plane

After the Data Plane installation is complete:

  1. Log in to the NeuralTrust Portal.
  2. Navigate to the Data Plane section.
  3. Add a new Data Plane connection.
  4. Enter your Data Plane API endpoint.
  5. Enter the JWT secret that was generated during installation.
  6. Save the connection.

​
Troubleshooting

  • Service startup failures: Check service logs with docker-compose logs <service-name>.
  • Database connection issues: Ensure ClickHouse service is running.
  • API key errors: Verify your OpenAI API key and HuggingFace token are correctly set in the .env file.
  • Control Plane connection issues: Ensure your Data Plane API endpoint is accessible from the internet and the JWT token is correct.

For further assistance, contact NeuralTrust support at support@neuraltrust.ai.