diff --git a/docs/docs/get-started/docker.mdx b/docs/docs/get-started/docker.mdx index 01ef1042..f7ec730b 100644 --- a/docs/docs/get-started/docker.mdx +++ b/docs/docs/get-started/docker.mdx @@ -95,12 +95,35 @@ The following values are **required** to be set: -## Rebuild all Docker containers +## Container management commands -If you need to reset state and rebuild all of your containers, run the following command. +Manage your OpenRAG containers with the following commands. +These commands are also available in the TUI's [Status menu](/get-started/tui#status). + +### Upgrade containers + +Upgrade your containers to the latest version while preserving your data. + +```bash +docker compose pull +docker compose up -d --force-recreate +``` + +### Rebuild containers (destructive) + +Reset state by rebuilding all of your containers. Your OpenSearch and Langflow databases will be lost. Documents stored in the `./documents` directory will persist, since the directory is mounted as a volume in the OpenRAG backend container. ```bash docker compose up --build --force-recreate --remove-orphans ``` + +### Remove all containers and data (destructive) + +Completely remove your OpenRAG installation and delete all data. +This deletes all of your data, including OpenSearch data, uploaded documents, and authentication. +```bash +docker compose down --volumes --remove-orphans --rmi local +docker system prune -f +``` \ No newline at end of file diff --git a/docs/docs/reference/configuration.mdx b/docs/docs/reference/configuration.mdx index ebd8dc4d..c8ca7cfa 100644 --- a/docs/docs/reference/configuration.mdx +++ b/docs/docs/reference/configuration.mdx @@ -21,8 +21,6 @@ For an example `.env` file, see [`.env.example` in the OpenRAG repository](https The Docker Compose files are populated with values from your `.env`, so you don't need to edit the Docker Compose files manually. -### Precedence - Environment variables always take precedence over other variables. ### Set environment variables @@ -38,6 +36,20 @@ To set environment variables, do the following. ``` 3. Start OpenRAG. +Updating provider API keys or provider endpoints in the `.env` file will not take effect after [Application onboarding](/install#application-onboarding). To change these values, you must: + +1. Stop OpenRAG. +2. Remove the containers: + ``` + docker-compose down + ``` +3. Update the values in your `.env` file. +4. Start OpenRAG containers. + ``` + docker-compose up -d + ``` +5. Complete [Application onboarding](/install#application-onboarding) again. + ## Supported environment variables All OpenRAG configuration can be controlled through environment variables.