Update README.md

Updating REST server README.md
This commit is contained in:
Samuel Fajreldines 2025-07-14 10:55:36 -03:00 committed by GitHub
parent 3200afa363
commit 9f34628bd0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -23,36 +23,46 @@ Graph service is a fast api server implementing the [graphiti](https://github.co
An example of docker compose setup may look like this: An example of docker compose setup may look like this:
```yml ```yml
version: '3.8' version: '3.8'
services: services:
graph: graph:
image: zepai/graphiti:latest image: zepai/graphiti:latest
ports: ports:
- "8000:8000" - "8000:8000"
depends_on:
environment: neo4j:
- OPENAI_API_KEY=${OPENAI_API_KEY} condition: service_healthy
- NEO4J_URI=bolt://neo4j:${NEO4J_PORT} restart: unless-stopped
- NEO4J_USER=${NEO4J_USER} environment:
- NEO4J_PASSWORD=${NEO4J_PASSWORD} - OPENAI_API_KEY=${OPENAI_API_KEY}
neo4j: - NEO4J_URI="bolt://neo4j:${NEO4J_PORT}"
image: neo4j:5.22.0 - NEO4J_USER=neo4j
- NEO4J_PASSWORD=${NEO4J_PASSWORD}
ports:
- "7474:7474" # HTTP neo4j:
- "${NEO4J_PORT}:${NEO4J_PORT}" # Bolt image: neo4j:5.22.0
volumes: ports:
- neo4j_data:/data - "7474:7474"
environment: - "${NEO4J_PORT}:${NEO4J_PORT}"
- NEO4J_AUTH=${NEO4J_USER}/${NEO4J_PASSWORD} volumes:
- neo4j_data:/data
volumes: environment:
neo4j_data: - NEO4J_AUTH=neo4j/${NEO4J_PASSWORD}
restart: unless-stopped
healthcheck:
test: ["CMD", "cypher-shell", "-u", "neo4j", "-p", "${NEO4J_PASSWORD}", "RETURN 1"]
interval: 30s
timeout: 10s
retries: 5
start_period: 30s
volumes:
neo4j_data:
``` ```
5. Once you start the service, it will be available at `http://localhost:8000` (or the port you have specified in the docker compose file). 5. Once you start the service, it will be available at `http://localhost:8000` (or the port you have specified in the docker compose file).
6. You may access the swagger docs at `http://localhost:8000/docs`. You may also access redocs at `http://localhost:8000/redoc`. 6. You may access the swagger docs at `http://localhost:8000/docs`. You may also access redocs at `http://localhost:8000/redoc`.
7. You may also access the neo4j browser at `http://localhost:7474` (the port depends on the neo4j instance you are using). 7. You may also access the neo4j browser at `http://localhost:7474` (the port depends on the neo4j instance you are using).