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

peer review

Browse source
This commit is contained in:
April M 2025-11-21 12:25:17 -08:00
parent ba6d25679a
commit f2a7910cc8
2 changed files with 100 additions and 98 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -235,13 +235,14 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path.
<PartialOnboarding />
## Close the OpenRAG TUI
## Exit the OpenRAG TUI
To close the OpenRAG TUI, press <kbd>q</kbd>.
The OpenRAG containers will continue to be served until the containers are stopped.
To exit the OpenRAG TUI, press <kbd>q</kbd>.
The OpenRAG containers continue to run until they are stopped.
For more information, see [Manage OpenRAG containers with the TUI ](#tui-container-management).
To start the TUI again, run `uv run openrag`.
To relaunch the TUI, run `uv run openrag`.
If you installed OpenRAG with `uvx`, run `uvx openrag`.
## Manage OpenRAG containers with the TUI {#tui-container-management}

23
docs/docs/get-started/quickstart.mdx
View file

@ -37,26 +37,27 @@ For this quickstart, install OpenRAG with the automatic installer script and bas
3. Select **Basic Setup**.
4. Click **Generate Passwords** to automatically generate OpenRAG passwords.
4. Create passwords for your OpenRAG installation's OpenSearch and Langflow services. You can click **Generate Passwords** to automatically generate passwords.
5. Click **Start All Services**, and then wait while the startup process pulls and runs the necessary container images.
This can take a few minutes.
Proceed when you see the following messages in the TUI:
The OpenSearch password is required. The Langflow admin password is optional.
If you don't generate a Langflow admin password, Langflow runs in [autologin mode](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login) with no password required.
Your passwords are saved in the `.env` file that is used to start OpenRAG.
You can find this file in your OpenRAG installation directory.
5. Click **Save Configuration**, and then click **Start All Services**.
Wait a few minutes while the startup process pulls and runs the necessary container images.
Proceed when you see the following messages in the terminal user interface (TUI):
```bash
Services started successfully
Command completed successfully
```
6. To open the OpenRAG application, navigate to the TUI main menu, and then click **Open App**.
6. To open the OpenRAG application, go to the TUI main menu, and then click **Open App**.
Alternatively, in your browser, navigate to `localhost:3000`.
:::tip
To quit OpenRAG, go to the TUI main menu, and then press <kbd>q</kbd>.
To restart OpenRAG, run `uvx openrag`.
:::
7. Select the **OpenAI** model provider, enter your OpenAI API key, and then click **Complete**.
For this quickstart, you can use the default options for the model settings.