diff --git a/README.md b/README.md index 38beff99..4cc99a71 100644 --- a/README.md +++ b/README.md @@ -49,10 +49,10 @@ To launch OpenRAG with the TUI, do the following: For the full TUI guide, see [TUI](https://docs.openr.ag/get-started/tui). -## Docker Deployment +## Docker installation If you prefer to use Docker to run OpenRAG, the repository includes two Docker Compose `.yml` files. -They deploy the same applications and containers, but to different environments. +They deploy the same applications and containers locally, but to different environments. - [`docker-compose.yml`](https://github.com/langflow-ai/openrag/blob/main/docker-compose.yml) is an OpenRAG deployment for environments with GPU support. GPU support requires an NVIDIA GPU with CUDA support and compatible NVIDIA drivers installed on the OpenRAG host machine. @@ -60,7 +60,7 @@ They deploy the same applications and containers, but to different environments. Both Docker deployments depend on `docling serve` to be running on port `5001` on the host machine. This enables [Mac MLX](https://opensource.apple.com/projects/mlx/) support for document processing. Installing OpenRAG with the TUI starts `docling serve` automatically, but for a Docker deployment you must manually start the `docling serve` process. -To deploy OpenRAG with Docker: +To install OpenRAG with Docker: 1. Clone the OpenRAG repository. ```bash @@ -121,7 +121,7 @@ To deploy OpenRAG with Docker: uv run python scripts/docling_ctl.py stop ``` -For more information, see [Deploy with Docker](https://docs.openr.ag/get-started/docker). +For more information, see [Install with Docker](https://docs.openr.ag/get-started/docker). ## Troubleshooting diff --git a/docs/docs/get-started/docker.mdx b/docs/docs/get-started/docker.mdx index ebf86554..fd098a80 100644 --- a/docs/docs/get-started/docker.mdx +++ b/docs/docs/get-started/docker.mdx @@ -23,7 +23,7 @@ Both Docker deployments depend on `docling serve` to be running on port `5001` o - Create an [OpenAI API key](https://platform.openai.com/api-keys). This key is **required** to start OpenRAG, but you can choose a different model provider during [Application Onboarding](#application-onboarding). - Optional: GPU support requires an NVIDIA GPU with CUDA support and compatible NVIDIA drivers installed on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment. -## Deploy OpenRAG with Docker Compose +## Install OpenRAG with Docker Compose To install OpenRAG with Docker Compose, do the following: @@ -82,7 +82,7 @@ The following values are **required** to be set: PID: 27746 ``` -7. Deploy OpenRAG with Docker Compose based on your deployment type. +7. Deploy OpenRAG locally with Docker Compose based on your deployment type. For GPU-enabled systems, run the following commands: ```bash