diff --git a/README.md b/README.md index c7a44d3b..0a7af82a 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/README.quickstart-docker-compose.md b/docs/README.quickstart-docker-compose.md index cb2eaded..25752017 100644 --- a/docs/README.quickstart-docker-compose.md +++ b/docs/README.quickstart-docker-compose.md @@ -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`: