gmakstutis/openrag
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

peer review and test numbering

Browse source
This commit is contained in:
April M 2025-12-19 07:38:44 -08:00
parent d534785542
commit 30b6d251cd
6 changed files with 27 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/docs/_partial-docker-remove-and-cleanup-steps.mdx
View file

@ -1,4 +1,10 @@
2. Remove all containers, including stopped containers:
import PartialDockerStopAll from '@site/docs/_partial-docker-stop-all.mdx';
1. Stop all running containers:
<PartialDockerStopAll />
1. Remove all containers, including stopped containers:
```bash title="Docker"
docker rm --force $(docker ps -aq)
@ -8,7 +14,7 @@
podman rm --all --force
```
3. Remove all images:
1. Remove all images:
```bash title="Docker"
docker rmi --force $(docker images -q)
@ -18,7 +24,7 @@
podman rmi --all --force
```
4. Remove all volumes:
1. Remove all volumes:
```bash title="Docker"
docker volume prune --force
@ -28,7 +34,7 @@
podman volume prune --force
```
5. Remove all networks except the default network:
1. Remove all networks except the default network:
```bash title="Docker"
docker network prune --force
@ -38,7 +44,7 @@
podman network prune --force
```
6. Clean up any leftover data:
1. Clean up any leftover data:
```bash title="Docker"
docker system prune --all --force --volumes

2
docs/docs/_partial-setup.mdx
View file

@ -63,7 +63,7 @@ If OpenRAG detects OAuth credentials during setup, it recommends **Advanced Setu
</TabItem>
<TabItem value="Advanced setup" label="Advanced setup">
1. In the TUI, select ** Advanced Setup**.
1. In the TUI, select **Advanced Setup**.
2. Enter administrator passwords for the OpenRAG OpenSearch and Langflow services.

8
docs/docs/core-components/ingestion.mdx
View file

@ -115,10 +115,10 @@ You can do this during [initial set up](/docker#setup), or you can add the crede
```
* **Amazon**: Provide your AWS Access Key ID and AWS Secret Access Key with access to your S3 instance. For more information, see the AWS documentation on [Configuring access to AWS applications](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-applications.html).
```env
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
```
```env
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
```
3. Save the `.env` file.

12
docs/docs/get-started/install.mdx
View file

@ -54,14 +54,14 @@ For other installation methods, see [Select an installation method](/install-opt
3. Wait while the installer script prepares your environment and installs OpenRAG.
You might be prompted to install certain dependencies if they aren't already present in your environment.
The entire process can take a few minutes.
Once the environment is ready, the OpenRAG TUI starts.
The entire process can take a few minutes.
Once the environment is ready, the OpenRAG TUI starts.
![OpenRAG TUI Interface](@site/static/img/openrag_tui_dec_2025.png)
![OpenRAG TUI Interface](@site/static/img/openrag_tui_dec_2025.png)
Because the installer script uses `uvx`, it creates a cached, ephemeral environment in your local `uv` cache, and your OpenRAG configuration files and data are stored separately from the `uv` cache.
Clearing the cache doesn't delete your entire OpenRAG installation, only the temporary TUI environment.
After clearing the cache, run `uvx openrag` to [access the TUI](/tui) and continue with your preserved configuration and data.
Because the installer script uses `uvx`, it creates a cached, ephemeral environment in your local `uv` cache, and your OpenRAG configuration files and data are stored separately from the `uv` cache.
Clearing the cache doesn't delete your entire OpenRAG installation, only the temporary TUI environment.
After clearing the cache, run `uvx openrag` to [access the TUI](/tui) and continue with your preserved configuration and data.
If you encounter errors during installation, see [Troubleshoot OpenRAG](/support/troubleshoot).

10
docs/docs/get-started/reinstall.mdx
View file

@ -70,16 +70,12 @@ If you want to reinstall one container, specify the container name in the comman
<PartialExportFlows />
2. Stop all running containers:
<PartialDockerStopAll />
<PartialDockerRemoveAndCleanupSteps />
8. Optional: Edit OpenRAG's `.env` file if needed.
1. Optional: Edit OpenRAG's `.env` file if needed.
9. Optional: If you removed all containers or specifically the OpenSearch container, then you can remove any files from the `~/.openrag/documents` subdirectory that you don't want to reingest after redeploying the containers.
1. Optional: If you removed all containers or specifically the OpenSearch container, then you can remove any files from the `~/.openrag/documents` subdirectory that you don't want to reingest after redeploying the containers.
It is recommended that you preserve OpenRAG's [default documents](https://github.com/langflow-ai/openrag/tree/main/openrag-documents).
10. If you removed all OpenRAG containers, [redeploy OpenRAG](/docker).
1. If you removed all OpenRAG containers, [redeploy OpenRAG](/docker).
If you removed only one container, redeploy that container with the appropriate `docker run` or `podman run` command.

8
docs/docs/get-started/uninstall.mdx
View file

@ -41,15 +41,11 @@ Use these steps to uninstall a self-managed OpenRAG deployment with streamlined
Use these commands to uninstall a self-managed OpenRAG deployment with discrete `docker` or `podman` commands:
1. Stop all running containers:
<PartialDockerStopAll />
<PartialDockerRemoveAndCleanupSteps />
7. Remove OpenRAG's `.env` file and the `~/.openrag/documents` directory, which aren't deleted by the previous commands.
1. Remove OpenRAG's `.env` file and the `~/.openrag/documents` directory, which aren't deleted by the previous commands.
8. Stop `docling-serve`:
1. Stop `docling-serve`:
```bash
uv run python scripts/docling_ctl.py stop