Skip to content
This repository was archived by the owner on Jul 11, 2025. It is now read-only.

Commit 0817ee3

Browse files
committed
Claude updates from the website
1 parent 8944598 commit 0817ee3

File tree

1 file changed

+202
-11
lines changed

1 file changed

+202
-11
lines changed

deployment/docker-compose.md

Lines changed: 202 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,32 +12,223 @@ Deploy TrustGraph quickly using Docker Compose for local development and testing
1212

1313
## Overview
1414

15-
Docker Compose provides the easiest way to get TrustGraph running locally with all required services orchestrated together.
15+
Docker Compose provides the easiest way to get TrustGraph running locally with all required services orchestrated together. This deployment method is ideal for:
16+
- Local development and testing
17+
- Proof-of-concept implementations
18+
- Small-scale deployments
19+
- Learning and experimentation
1620

1721
## Prerequisites
1822

19-
Coming soon - detailed content!
23+
### System Requirements
24+
25+
- **Docker Engine** or **Podman Machine** installed and running
26+
- **Operating System**: Linux or macOS (Windows deployments not tested)
27+
- **Python 3.x** for CLI tools
28+
- Sufficient system resources (recommended: 8GB RAM, 4 CPU cores)
29+
30+
### Installation Links
31+
32+
- [Install Docker Engine](https://docs.docker.com/engine/install/)
33+
- [Install Podman Machine](http://podman.io/)
34+
35+
> **Note**: If using Podman, substitute `podman` for `docker` in all commands.
36+
37+
## Configuration Setup
38+
39+
### 1. Create Configuration
40+
41+
Use the [TrustGraph Configuration Portal](https://config-ui.demo.trustgraph.ai/) to generate your deployment configuration:
42+
43+
1. **Select Deployment**: Choose Docker Compose or Podman Compose
44+
2. **Graph Store**: Select Cassandra (recommended for ease of use)
45+
3. **Vector Store**: Select Qdrant (recommended for ease of use)
46+
4. **Chunker Settings**:
47+
- Type: Recursive
48+
- Chunk size: 1000
49+
- Overlap: 50
50+
5. **LLM Model**: Choose your preferred model:
51+
- **Local**: LMStudio or Ollama for local GPU deployment
52+
- **Cloud**: VertexAI on Google (offers free credits)
53+
6. **Output Tokens**: 2048 (safe default)
54+
7. **Customization**: Enable LLM Prompt Manager and Agent Tools
55+
8. **Generate**: Download the deployment bundle
56+
57+
### 2. Install CLI Tools
58+
59+
```bash
60+
python3 -m venv env
61+
source env/bin/activate
62+
pip install trustgraph-cli
63+
```
2064

2165
## Quick Start
2266

23-
Coming soon - detailed content!
67+
### 1. Launch TrustGraph
68+
69+
```bash
70+
docker-compose -f docker-compose.yaml up -d
71+
```
72+
73+
### 2. Wait for Initialization
74+
75+
Allow 120 seconds for all services to stabilize. Services like Pulsar and Cassandra need time to initialize properly.
76+
77+
### 3. Verify Installation
78+
79+
Check that processors have started:
80+
81+
```bash
82+
tg-show-processor-state
83+
```
84+
85+
Verify all containers are running:
86+
87+
```bash
88+
docker ps
89+
```
90+
91+
Check that flows are available:
92+
93+
```bash
94+
tg-show-flows
95+
```
96+
97+
### 4. Load Sample Data
98+
99+
```bash
100+
tg-load-sample-documents
101+
```
102+
103+
## Services & Interfaces
104+
105+
### Web Workbench
106+
107+
Access the TrustGraph workbench at [http://localhost:8888/](http://localhost:8888/)
108+
109+
**Features:**
110+
- Document library management
111+
- Vector search interface
112+
- Graph visualization
113+
- Graph RAG query interface
114+
- Prompt management
24115

25-
## Configuration
116+
### Monitoring Dashboard
26117

27-
Coming soon - detailed content!
118+
Access Grafana monitoring at [http://localhost:3000/](http://localhost:3000/)
28119

29-
## Services
120+
**Default credentials:**
121+
- Username: `admin`
122+
- Password: `admin`
30123

31-
Coming soon - detailed content!
124+
**Features:**
125+
- TrustGraph dashboard
126+
- Processing metrics
127+
- System health monitoring
128+
- Document processing backlog
32129

33-
## Monitoring
130+
## Working with Documents
34131

35-
Coming soon - detailed content!
132+
### 1. Load Documents
133+
134+
**Via Workbench:**
135+
1. Navigate to the Library page
136+
2. Select a document (e.g., "Beyond State Vigilance")
137+
3. Click Submit on the action bar
138+
4. Choose a processing flow (use default)
139+
5. Click Submit to process
140+
141+
**Via CLI:**
142+
```bash
143+
tg-load-pdf path/to/document.pdf
144+
tg-load-text path/to/document.txt
145+
```
146+
147+
### 2. Verify Knowledge Graph
148+
149+
Check graph parsing results:
150+
151+
```bash
152+
tg-show-graph
153+
```
154+
155+
This displays semantic triples in N-Triples format:
156+
157+
```
158+
<http://trustgraph.ai/e/enterprise> <http://trustgraph.ai/e/was-carried> "to altitude and released for a gliding approach" .
159+
<http://trustgraph.ai/e/enterprise> <http://www.w3.org/2000/01/rdf-schema#label> "Enterprise" .
160+
```
161+
162+
### 3. Query with Graph RAG
163+
164+
**Via Workbench:**
165+
1. Navigate to Graph RAG tab
166+
2. Enter your question (e.g., "What is this document about?")
167+
3. View contextual responses
168+
169+
**Via CLI:**
170+
```bash
171+
tg-invoke-graph-rag "What is this document about?"
172+
```
36173

37174
## Troubleshooting
38175

39-
Coming soon - detailed content!
176+
### Common Issues
177+
178+
**Services Not Starting:**
179+
- Wait 120 seconds for full initialization
180+
- Check container status: `docker ps -a`
181+
- Review logs: `docker-compose logs [service-name]`
182+
183+
**Memory Issues:**
184+
- Ensure sufficient RAM (8GB recommended)
185+
- Monitor resource usage: `docker stats`
186+
187+
**Connection Issues:**
188+
- Verify ports are available (8888, 3000)
189+
- Check firewall settings
190+
- Ensure Docker daemon is running
191+
192+
### Debugging Commands
193+
194+
```bash
195+
# Check all containers
196+
docker ps -a
197+
198+
# View logs for specific service
199+
docker-compose logs [service-name]
200+
201+
# Check system resources
202+
docker stats
203+
204+
# Verify TrustGraph flows
205+
tg-show-flows
206+
207+
# Check processor state
208+
tg-show-processor-state
209+
```
210+
211+
## Shutdown
212+
213+
### Clean Shutdown
214+
215+
```bash
216+
docker-compose -f docker-compose.yaml down -v -t 0
217+
```
218+
219+
### Verify Cleanup
220+
221+
```bash
222+
# Confirm no containers running
223+
docker ps
224+
225+
# Confirm volumes removed
226+
docker volume ls
227+
```
40228

41229
## Next Steps
42230

43-
Coming soon - detailed content!
231+
- **Production Deployment**: See [Production Considerations](production-considerations.md)
232+
- **Cloud Deployment**: Explore [AWS](aws.md), [GCP](gcp.md), or [Scaleway](scaleway.md) guides
233+
- **Advanced Configuration**: Check [Security Considerations](security-considerations.md)
234+
- **Scaling**: Review [Minikube](minikube.md) for Kubernetes deployment

0 commit comments

Comments
 (0)