Skip to main content

Getting Started

TrustGraph is a fully containerized Agentic Graph RAG platform. A full discussion of TrustGraph use cases can be found here.TrustGraph deploys in minutes locally with Docker, Podman, or Minikube. TrustGraph can also be deployed in Google Cloud with Kubernetes. There are currently 4 deployment options:

Container DepoloymentHost EnvironmentContainer Orchestration
Docker ComposeLocalDocker Engine
Podman ComposeLocalPodman Machine
MinikubeLocalKubernetes
KubernetesGoogle CloudKubernetes
tip

Before launching TrustGraph, be sure to have either the Docker Engine, Podman Machine, or Minikube installed and running on the host machine.

caution

TrustGraph has been tested on Linux and MacOS with Docker, Podman, and Minikube. Windows deployments have not been tested.

Install the TrustGraph CLI​

pip3 install trustgraph-cli==0.20.9
note

The TrustGraph CLI version must match the desired TrustGraph release version.

Full TrustGraph CLI documentation can be found here.

Configuration Portal​

While TrustGraph is endlessly customizable through the YAML launch files, the Configuration Portal can build a custom configuration in seconds that deploys with Docker, Podman, Minikube, or Google Cloud. There is a Configuration Portal for the both the lastest and stable TrustGraph releases.

The Configuration Portal has 4 important sections:

  • Component Selection ✅: Choose from the available deployment platforms, LLMs, graph store, VectorDB, chunking algorithm, chunking parameters, and LLM parameters
  • Customization 🧰: Customize the prompts for the LLM System, Data Extraction Agents, and Agent Flow
  • Data Workbench 🕵️: Add the Data Workbench to the configuration available on port 8888
  • Finish Deployment 🚀: Download the launch YAML files with deployment instructions

The Configuration Portal will generate the YAML files in deploy.zip. Once deploy.zip has been downloaded and unzipped, launching TrustGraph is as simple as navigating to the deploy directory and running:

docker compose up -d
tip

Docker is the recommended container orchestration platform for first getting started with TrustGraph.

When finished, shutting down TrustGraph is as simple as:

docker compose down -v

Prebuilt Configuration Files​

TrustGraph YAML files are available here. Download deploy.zip for the desired release version.

Release TypeRelease Version
Latest0.20.11
Stable0.20.9

TrustGraph is fully containerized and is launched with a YAML configuration file. Unzipping the deploy.zip will add the deploy directory with the following subdirectories:

  • docker-compose
  • minikube-k8s
  • gcp-k8s
note

As more integrations have been added, the number of possible combinations of configurations has become quite large. It is recommended to use the Configuration Portal to build your deployment configuration. Each directory contains YAML configuration files for the default component selections.

Launching TrustGraph​

Navigate to the subdirectory for your chosen deployment method. You will then select a YAML file based on your desired model deployment and graph store combination. Once you've selected your YAML configuration file, you will run:

Docker​

docker compose -f <config-file.yaml> up -d

Podman​

podman compose -f <config-file.yaml> up -d

Minikube​

kubectl apply -f <config-file.yaml>
danger

Support for Google Cloud and Kubernetes is still experimental. Please join the TrustGraph Discord Community for testing this deployment option.

Running TrustGraph​

caution

Prior to launching TrustGraph, be sure to set all required environment varibles.

While the trustgraph-cli downloads all the packages needed to run TrustGraph, there are slight differences in commands depending on whether you deploy with a Docker or Kubernetes approach. Refer to the below guides for a step-by-step process for running TrustGraph once deployed.