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

eng-review

Browse source
This commit is contained in:
Mendon Kissling 2025-10-02 13:24:00 -04:00
parent 7b9b09da46
commit 98cd715cf4
3 changed files with 8 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/docs/_partial-onboarding.mdx
View file

@ -36,10 +36,9 @@ To change your provider selection, you must completely reinstall OpenRAG.
::: :::
1. Enter your Ollama server's base URL address. 1. Enter your Ollama server's base URL address.
The default Ollama server address is `http://localhost:11434`. The default Ollama server address is `http://localhost:11434`.
Since OpenRAG is running in a container, you may need to change `localhost` to access services outside of the container. For example, change `http://localhost:11434` to `http://host.docker.internal:11434` to connect to Ollama. OpenRAG automatically transforms `localhost` to access services outside of the container, and sends a test connection to your Ollama server to confirm connectivity.
OpenRAG automatically sends a test connection to your Ollama server to confirm connectivity.
2. Select the **Embedding Model** and **Language Model** your Ollama server is running. 2. Select the **Embedding Model** and **Language Model** your Ollama server is running.
OpenRAG automatically lists the available models from your Ollama server. OpenRAG retrieves the available models from your Ollama server.
3. To load 2 sample PDFs, enable **Sample dataset**. 3. To load 2 sample PDFs, enable **Sample dataset**.
This is recommended, but not required. This is recommended, but not required.
4. Click **Complete**. 4. Click **Complete**.

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

@ -10,7 +10,7 @@ import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx';
<PartialExternalPreview /> <PartialExternalPreview />
[Install the OpenRAG Python wheel](#install-python-wheel) and then use the [OpenRAG Terminal User Interface(TUI)](#setup) to run and configure your OpenRAG deployment with a guided setup process. [Install the OpenRAG Python wheel](#install-python-wheel), and then run the [OpenRAG Terminal User Interface(TUI)](#setup) to start your OpenRAG deployment with a guided setup process.
If you prefer running Docker commands and manually editing `.env` files, see [Deploy with Docker](/get-started/docker). If you prefer running Docker commands and manually editing `.env` files, see [Deploy with Docker](/get-started/docker).
@ -31,15 +31,14 @@ The `.whl` file is currently available as an internal download during public pre
The OpenRAG wheel installs the Terminal User Interface (TUI) for running and managing OpenRAG. The OpenRAG wheel installs the Terminal User Interface (TUI) for running and managing OpenRAG.
1. Create a new project with a virtual environment using `uv`. 1. Create a new project with a virtual environment using `uv init`.
This creates and activates a virtual environment for your project.
```bash ```bash
uv init YOUR_PROJECT_NAME uv init YOUR_PROJECT_NAME
cd YOUR_PROJECT_NAME cd YOUR_PROJECT_NAME
``` ```
The terminal prompt won't change like it would when using `venv`, but the `uv` commands will use the project's virtual environment. The `(venv)` prompt doesn't change, but `uv` commands will automatically use the project's virtual environment.
For more information on virtual environments, see the [uv documentation](https://docs.astral.sh/uv/pip/environments). For more information on virtual environments, see the [uv documentation](https://docs.astral.sh/uv/pip/environments).
2. Add the local OpenRAG wheel to your project's virtual environment. 2. Add the local OpenRAG wheel to your project's virtual environment.

4
docs/docs/support/troubleshoot.mdx
View file

@ -13,12 +13,12 @@ This page provides troubleshooting advice for issues you might encounter when us
## OpenSearch fails to start ## OpenSearch fails to start
Check that `OPENSEARCH_PASSWORD` set in [Environment variables](/configure/configuration) meets requirements. Check that `OPENSEARCH_PASSWORD` set in [Environment variables](/reference/configuration) meets requirements.
The password must contain at least 8 characters, and must contain at least one uppercase letter, one lowercase letter, one digit, and one special character that is strong. The password must contain at least 8 characters, and must contain at least one uppercase letter, one lowercase letter, one digit, and one special character that is strong.
## Langflow connection issues ## Langflow connection issues
Verify the `LANGFLOW_SUPERUSER` credentials set in [Environment variables](/configure/configuration) are correct. Verify the `LANGFLOW_SUPERUSER` credentials set in [Environment variables](/reference/configuration) are correct.
## Memory errors ## Memory errors