Documenting Podman support

This commit is contained in:
JackColquitt 2024-08-27 14:41:31 -07:00
parent e4c4774b5d
commit 2622c48690
2 changed files with 10 additions and 4 deletions

View file

@ -39,7 +39,7 @@ by deploying multiple containers.
- Embedding query service
- Graph RAG query service
- All procesing integrates with [Apache Pulsar](https://github.com/apache/pulsar/)
- Containers, so can be deployed using Docker Compose or Kubernetes
- Containers, can be deployed using `Docker` or [Podman](http://podman.io/)
- Plug'n'play architecture: switch different LLM modules to suit your needs
## Architecture
@ -108,7 +108,7 @@ package installed can also run the entire architecture.
## Quickstart Guide
See [Quickstart on Docker Compose](docs/README.quickstart-docker-compose.md)
[🚀 Quickstart](docs/README.quickstart-docker-compose.md)
## Development Guide

View file

@ -2,10 +2,16 @@
# Getting Started
> [!TIP]
> Before launching `TrustGraph` with `Docker Compose`, be sure to have the `Docker Engine` installed and running on the host machine. Installation instructions for the `Docker Engine` can be found [here](https://docs.docker.com/engine/install/).
> Before launching `TrustGraph`, be sure to have the `Docker Engine` or `Podman Machine` installed and running on the host machine.
>
> - [Install the Docker Engine](https://docs.docker.com/engine/install/)
> - [Install the Podman Machine](http://podman.io/)
> [!NOTE]
> The `Docker Compose` files have been tested on `Linux` and `MacOS`. `Windows` deployments have not been tested.
> `TrustGraph` has been tested on `Linux` and `MacOS` with `Docker` and `Podman`. `Windows` deployments have not been tested.
> [!TIP]
> If using `Podman`, the only change will be to substitute `podman` instead of `docker` in all commands.
All `TrustGraph` components are deployed through a `Docker Compose` file. There are **16** `Docker Compose` files to choose from, depending on the desired model deployment and choosing between the graph stores `Cassandra` or `Neo4j`: