edit install steps while testing
This commit is contained in:
April M
parent
a460fd05fd
commit
37a914f162
11 changed files with 74 additions and 310 deletions
|
|
@ -16,31 +16,37 @@ If OpenRAG detects OAuth credentials during setup, it recommends **Advanced Setu
|
|||
<Tabs groupId="Setup method">
|
||||
<TabItem value="Basic setup" label="Basic setup" default>
|
||||
|
||||
1. In the TUI, click **Basic Setup** or press <kbd>1</kbd>.
|
||||
1. In the TUI, select **Basic Setup**.
|
||||
|
||||
2. Enter administrator passwords for the OpenRAG OpenSearch and Langflow services, or click **Generate Passwords** to generate passwords automatically.
|
||||
2. Enter administrator passwords for the OpenRAG OpenSearch and Langflow services.
|
||||
|
||||
The OpenSearch password is required.
|
||||
The OpenSearch password is required, and a secure password is automatically generated if you don't provide one manually.
|
||||
|
||||
The Langflow password is recommended but optional.
|
||||
If the Langflow password is empty, the Langflow server starts without authentication enabled. For more information, see [Langflow settings](/reference/configuration#langflow-settings).
|
||||
|
||||
3. Optional: Enter your OpenAI API key, or leave this field empty to provide model provider credentials during the application onboarding process.
|
||||
You can click **Generate Password** to create a Langflow password and username automatically.
|
||||
|
||||
There is no material difference between providing the key now or during the [application onboarding process](#application-onboarding).
|
||||
If you provide a key now, it can be populated automatically during the application onboarding process if you select the OpenAI model provider, and then enable **Get API key from environment variable**.
|
||||
3. Optional: Under **API Keys**, enter your model provider credentials, or leave these fields empty if you want to configure model provider credentials during the application onboarding process.
|
||||
|
||||
There is no material difference between providing these values now or during the [application onboarding process](#application-onboarding).
|
||||
If you provide a credential now, it can be populated automatically during the application onboarding process if you enable the **Get API key from environment variable** option.
|
||||
|
||||
OpenRAG's core functionality requires access to language and embedding models.
|
||||
By default, OpenRAG uses OpenAI models.
|
||||
If you aren't sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG's default model configuration.
|
||||
If you want to use a different model provider, you can leave this field empty.
|
||||
|
||||
4. Click **Save Configuration**.
|
||||
4. Optional: Under **Others**, edit the [knowledge base](/knowledge) paths if you don't want to use the default paths:
|
||||
|
||||
Your passwords and API key, if provided, are stored in the [OpenRAG `.env` file](/reference/configuration) at `~/.openrag/tui`.
|
||||
* **Documents Paths**: One or more paths to directories are where OpenRAG looks for documents to ingest.
|
||||
* **OpenSearch Data PAth**: Specify the path where you want OpenRAG to create your OpenSearch index.
|
||||
|
||||
5. Click **Save Configuration**.
|
||||
|
||||
Your passwords and API keys, if provided, are stored in the [OpenRAG `.env` file](/reference/configuration) at `~/.openrag/tui`.
|
||||
If you modified any credentials that were pulled from an existing `.env` file, those values are updated in the `.env` file.
|
||||
|
||||
5. Click **Start All Services** to start the OpenRAG services that run in containers.
|
||||
6. Click **Start OpenRAG** to start the OpenRAG container services.
|
||||
|
||||
This process can take some time while OpenRAG pulls and runs the container images.
|
||||
If all services start successfully, the TUI prints a confirmation message:
|
||||
|
|
@ -50,55 +56,60 @@ If OpenRAG detects OAuth credentials during setup, it recommends **Advanced Setu
|
|||
Command completed successfully
|
||||
```
|
||||
|
||||
6. Under [**Native Services**](/manage-services), click **Start** to start the Docling service.
|
||||
|
||||
7. Launch the OpenRAG application:
|
||||
8. Launch the OpenRAG application:
|
||||
|
||||
* From the TUI main menu, click **Open App**.
|
||||
* In your browser, navigate to `localhost:3000`.
|
||||
|
||||
8. Continue with the [application onboarding process](#application-onboarding).
|
||||
9. Continue with the [application onboarding process](#application-onboarding).
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="Advanced setup" label="Advanced setup">
|
||||
|
||||
1. In the TUI, click **Advanced Setup** or press <kbd>2</kbd>.
|
||||
1. In the TUI, select ** Advanced Setup**.
|
||||
|
||||
2. Enter administrator passwords for the OpenRAG OpenSearch and Langflow services, or click **Generate Passwords** to generate passwords automatically.
|
||||
2. Enter administrator passwords for the OpenRAG OpenSearch and Langflow services.
|
||||
|
||||
The OpenSearch password is required.
|
||||
The OpenSearch password is required, and a secure password is automatically generated if you don't provide one manually.
|
||||
|
||||
The Langflow password is recommended but optional.
|
||||
If the Langflow password is empty, the Langflow server starts without authentication enabled. For more information, see [Langflow settings](/reference/configuration#langflow-settings).
|
||||
|
||||
3. Optional: Enter your OpenAI API key, or leave this field empty to provide model provider credentials during the application onboarding process.
|
||||
You can click **Generate Password** to create a Langflow password and username automatically.
|
||||
|
||||
There is no material difference between providing the key now or during the [application onboarding process](#application-onboarding).
|
||||
If you provide a key now, it can be populated automatically during the application onboarding process if you select the OpenAI model provider, and then enable **Get API key from environment variable**.
|
||||
3. Optional: Under **API Keys**, enter your model provider credentials, or leave the **OpenAI**, **Anthropic**, **Ollama**, and **IBM watsonx.ai** fields empty if you want to configure model provider credentials during the application onboarding process.
|
||||
|
||||
There is no material difference between providing these values now or during the [application onboarding process](#application-onboarding).
|
||||
If you provide a credential now, it can be populated automatically during the application onboarding process if you enable the **Get API key from environment variable** option.
|
||||
|
||||
OpenRAG's core functionality requires access to language and embedding models.
|
||||
By default, OpenRAG uses OpenAI models.
|
||||
If you aren't sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG's default model configuration.
|
||||
If you want to use a different model provider, you can leave this field empty.
|
||||
|
||||
4. To upload documents from external storage, such as Google Drive, add the required OAuth credentials for the connectors that you want to use. These settings can be populated automatically if OpenRAG detects these credentials in an [OpenRAG `.env` file](/reference/configuration) at `~/.openrag/tui`.
|
||||
4. Recommended: To upload documents from external storage, such as Google Drive, add the required OAuth credentials for the connectors that you want to use under **API Keys**. These settings can be populated automatically if OpenRAG detects these credentials in an [OpenRAG `.env` file](/reference/configuration) at `~/.openrag/tui`.
|
||||
|
||||
* **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).
|
||||
* **Google**: Provide your Google OAuth Client ID and Google OAuth Client Secret. You can generate these in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials). For more information, see the [Google OAuth client documentation](https://developers.google.com/identity/protocols/oauth2).
|
||||
* **Microsoft**: For the Microsoft OAuth Client ID and Microsoft OAuth Client Secret, provide [Azure application registration credentials for SharePoint and OneDrive](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/app-registration?view=odsp-graph-online). For more information, see the [Microsoft Graph OAuth client documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/graph-oauth).
|
||||
* **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).
|
||||
|
||||
You can [manage OAuth credentials](/ingestion#oauth-ingestion) later, but it is recommended to configure them during initial set up.
|
||||
|
||||
5. The OpenRAG TUI presents redirect URIs for your OAuth app.
|
||||
These are the URLs your OAuth provider will redirect back to after user sign-in.
|
||||
Register these redirect values with your OAuth provider as they are presented in the TUI.
|
||||
5. Register the redirect URIs shown in the TUI in your OAuth provider.
|
||||
These are the URLs your OAuth provider will use to redirect users back to OpenRAG after they sign in.
|
||||
|
||||
6. Click **Save Configuration**.
|
||||
6. Optional: Under **Others**, you can edit the following settings if needed:
|
||||
|
||||
* **Documents Paths**: Use the default path or provide one or more paths to directories are where OpenRAG looks for documents to ingest in to your [knowledge base](/knowledge).
|
||||
* **OpenSearch Data Path**: Specify the path where you want OpenRAG to create your OpenSearch index.
|
||||
* **Langflow Public URL (`LANGFLOW_PUBLIC_URL`)** : Sets the base address to access the Langflow web interface. This is where users interact with flows in a browser.
|
||||
* **Webhook Base URL (`WEBHOOK_BASE_URL`)**: If applicable, set the base address for your OAuth connector endpoints. If set, the OAuth connector webhook URLs are constructed as `WEBHOOK_BASE_URL/connectors/${provider}/webhook`.
|
||||
|
||||
7. Click **Save Configuration**.
|
||||
|
||||
Your passwords, API key, and OAuth credentials, if provided, are stored in the [OpenRAG `.env` file](/reference/configuration) at `~/.openrag/tui`.
|
||||
If you modified any credentials that were pulled from an existing `.env` file, those values are updated in the `.env` file.
|
||||
|
||||
7. Click **Start All Services** to start the OpenRAG services that run in containers.
|
||||
8. Click **Start OpenRAG** to start the OpenRAG container services.
|
||||
|
||||
This process can take some time while OpenRAG pulls and runs the container images.
|
||||
If all services start successfully, the TUI prints a confirmation message:
|
||||
|
|
@ -108,8 +119,6 @@ Register these redirect values with your OAuth provider as they are presented in
|
|||
Command completed successfully
|
||||
```
|
||||
|
||||
8. Under [**Native Services**](/manage-services), click **Start** to start the Docling service.
|
||||
|
||||
9. Launch the OpenRAG application:
|
||||
|
||||
* From the TUI main menu, click **Open App**.
|
||||
|
|
@ -117,19 +126,7 @@ Register these redirect values with your OAuth provider as they are presented in
|
|||
|
||||
10. If you enabled OAuth connectors, you must sign in to your OAuth provider before being redirected to your OpenRAG instance.
|
||||
|
||||
11. If required, you can edit the following additional environment variables.
|
||||
Only change these variables if your OpenRAG deployment has a non-default network configuration, such as a reverse proxy or custom domain.
|
||||
|
||||
* `LANGFLOW_PUBLIC_URL`: Sets the base address to access the Langflow web interface. This is where users interact with flows in a browser.
|
||||
* `WEBHOOK_BASE_URL`: Sets the base address for the following OpenRAG OAuth connector endpoints:
|
||||
* Amazon S3: Not applicable.
|
||||
* Google Drive: `WEBHOOK_BASE_URL/connectors/google_drive/webhook`
|
||||
* OneDrive: `WEBHOOK_BASE_URL/connectors/onedrive/webhook`
|
||||
* SharePoint: `WEBHOOK_BASE_URL/connectors/sharepoint/webhook`
|
||||
|
||||
12. Continue with the [application onboarding process](#application-onboarding).
|
||||
11. Continue with the [application onboarding process](#application-onboarding).
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<!-- Author's note: Under Advanced Setup, the bullets for `LANGFLOW_PUBLIC_URL` and `WEBHOOK_BASE_URL` must be indented extra spaces in order to render correctly. Not sure why, but please don't outdent them unless you can enforce the rendering. -->
|
||||
</Tabs>
|
||||
|
|
@ -69,20 +69,20 @@ To enable multiple connectors, you must register an app and generate credentials
|
|||
If you use the [Terminal User Interface (TUI)](/tui) to manage your OpenRAG services, enter OAuth credentials in the **Advanced Setup** menu.
|
||||
You can do this during [installation](/install#setup), or you can add the credentials afterwards:
|
||||
|
||||
1. If OpenRAG is running, open the TUI's **Status** menu (<kbd>3</kbd>), and then click **Stop Services**.
|
||||
1. If OpenRAG is running, open the TUI's **Status** menu, and then click **Stop Services**.
|
||||
|
||||
2. Open the **Advanced Setup** menu (<kbd>2</kbd>), and then add the OAuth credentials for the cloud storage providers that you want to use:
|
||||
2. Open the **Advanced Setup** menu, and then add the OAuth credentials for the cloud storage providers that you want to use under **API Keys**:
|
||||
|
||||
* **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).
|
||||
* **Google**: Provide your Google OAuth Client ID and Google OAuth Client Secret. You can generate these in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials). For more information, see the [Google OAuth client documentation](https://developers.google.com/identity/protocols/oauth2).
|
||||
* **Microsoft**: For the Microsoft OAuth Client ID and Microsoft OAuth Client Secret, provide [Azure application registration credentials for SharePoint and OneDrive](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/app-registration?view=odsp-graph-online). For more information, see the [Microsoft Graph OAuth client documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/graph-oauth).
|
||||
* **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).
|
||||
|
||||
3. The TUI presents redirect URIs for your OAuth app that you must register with your OAuth provider.
|
||||
These are the URLs your OAuth provider will redirect back to after users authenticate and grant access to their cloud storage.
|
||||
|
||||
4. Click **Save Configuration** to add the OAuth credentials to your [OpenRAG `.env` file](/reference/configuration).
|
||||
|
||||
5. Click **Start All Services** to restart the OpenRAG containers with OAuth enabled.
|
||||
5. Click **Start Services** to restart the OpenRAG containers with OAuth enabled.
|
||||
|
||||
6. Launch the OpenRAG app.
|
||||
You should be prompted to sign in to your OAuth provider before being redirected to your OpenRAG instance.
|
||||
|
|
@ -100,13 +100,6 @@ You can do this during [initial set up](/docker#setup), or you can add the crede
|
|||
|
||||
2. Edit your OpenRAG `.env` file to add the OAuth credentials for the cloud storage providers that you want to use:
|
||||
|
||||
* **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=
|
||||
```
|
||||
|
||||
* **Google**: Provide your Google OAuth Client ID and Google OAuth Client Secret. You can generate these in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials). For more information, see the [Google OAuth client documentation](https://developers.google.com/identity/protocols/oauth2).
|
||||
|
||||
```env
|
||||
|
|
@ -120,6 +113,12 @@ You can do this during [initial set up](/docker#setup), or you can add the crede
|
|||
MICROSOFT_GRAPH_OAUTH_CLIENT_ID=
|
||||
MICROSOFT_GRAPH_OAUTH_CLIENT_SECRET=
|
||||
```
|
||||
* **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=
|
||||
```
|
||||
|
||||
3. Save the `.env` file.
|
||||
|
||||
|
|
|
|||
|
|
@ -78,9 +78,9 @@ The following variables are required or recommended:
|
|||
|
||||
* **OAuth provider credentials**: To upload documents from external storage, such as Google Drive, set the required OAuth credentials for the connectors that you want to use. You can [manage OAuth credentials](/ingestion#oauth-ingestion) later, but it is recommended to configure them during initial set up so you don't have to rebuild the containers.
|
||||
|
||||
* **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).
|
||||
* **Google**: Provide your Google OAuth Client ID and Google OAuth Client Secret. You can generate these in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials). For more information, see the [Google OAuth client documentation](https://developers.google.com/identity/protocols/oauth2).
|
||||
* **Microsoft**: For the Microsoft OAuth Client ID and Microsoft OAuth Client Secret, provide [Azure application registration credentials for SharePoint and OneDrive](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/app-registration?view=odsp-graph-online). For more information, see the [Microsoft Graph OAuth client documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/graph-oauth).
|
||||
* **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).
|
||||
|
||||
For more information and variables, see [OpenRAG environment variables](/reference/configuration).
|
||||
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ You might be prompted to install certain dependencies if they aren't already pre
|
|||
The entire process can take a few minutes.
|
||||
Once the environment is ready, the OpenRAG TUI starts.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -24,11 +24,11 @@ For [self-managed deployments](/docker), run Docker or Podman commands to manage
|
|||
<Tabs>
|
||||
<TabItem value="TUI" label="TUI-managed services" default>
|
||||
|
||||
* **TUI Status menu**: In the **Status** menu (<kbd>3</kbd>), you can access streaming logs for all OpenRAG services.
|
||||
* **TUI Status menu**: In the **Status** menu, you can access streaming logs for all OpenRAG services.
|
||||
Select the service you want to view, and then press <kbd>l</kbd>.
|
||||
To copy the logs, click **Copy to Clipboard**.
|
||||
|
||||
* **TUI Diagnostics menu**: The TUI's **Diagnostics** menu (<kbd>4</kbd>) provides health monitoring for your container runtimes and monitoring of your OpenSearch instance.
|
||||
* **TUI Diagnostics menu**: The TUI's **Diagnostics** menu provides health monitoring for your container runtimes and monitoring of your OpenSearch instance.
|
||||
|
||||
* **Docling**: See [Stop, start, and inspect native services](#start-native-services).
|
||||
|
||||
|
|
@ -47,10 +47,10 @@ To copy the logs, click **Copy to Clipboard**.
|
|||
<Tabs>
|
||||
<TabItem value="TUI" label="TUI-managed services" default>
|
||||
|
||||
In the TUI's **Status** menu (<kbd>3</kbd>), click **Stop Services** to stop all OpenRAG container-based services.
|
||||
Then, click **Start All Services** to restart the OpenRAG containers.
|
||||
In the TUI's **Status** menu, click **Stop Services** to stop all OpenRAG container-based services.
|
||||
Then, click **Start Services** to restart the OpenRAG containers.
|
||||
|
||||
When you click **Start All Services**, the following processes are triggered:
|
||||
When you click **Start Services**, the following processes are triggered:
|
||||
|
||||
1. OpenRAG automatically detects your container runtime, and then checks if your machine has compatible GPU support by checking for `CUDA`, `NVIDIA_SMI`, and Docker/Podman runtime support. This check determines which Docker Compose file OpenRAG uses because there are separate Docker Compose files for GPU and CPU deployments.
|
||||
|
||||
|
|
@ -75,7 +75,7 @@ A _native service_ in OpenRAG is a service that runs locally on your machine, no
|
|||
<Tabs>
|
||||
<TabItem value="TUI" label="TUI-managed services" default>
|
||||
|
||||
From the TUI's **Status** menu (<kbd>3</kbd>), click **Native Services** to do the following:
|
||||
From the TUI's **Status** menu, click **Native Services** to do the following:
|
||||
|
||||
* View the service's status, port, and process ID (PID).
|
||||
* Stop, start, and restart native services.
|
||||
|
|
@ -135,7 +135,7 @@ To reset your OpenRAG deployment _and_ delete all OpenRAG data, see [Reinstall O
|
|||
|
||||
<PartialExportFlows />
|
||||
|
||||
2. To destroy and recreate your OpenRAG containers, open the TUI's **Status** menu (<kbd>3</kbd>), and then click **Factory Reset**.
|
||||
2. To destroy and recreate your OpenRAG containers, open the TUI's **Status** menu, and then click **Factory Reset**.
|
||||
|
||||
3. Repeat the [setup process](/install#setup) to restart the services and launch the OpenRAG app. Your OpenRAG passwords, OAuth credentials (if previously set), and onboarding configuration are restored from the `.env` file.
|
||||
|
||||
|
|
|
|||
|
|
@ -46,15 +46,15 @@ The script installs OpenRAG dependencies, including Docker or Podman, and then i
|
|||
The entire process can take a few minutes.
|
||||
Once the environment is ready, the OpenRAG [Terminal User Interface (TUI)](/tui) starts.
|
||||
|
||||
|
||||
|
||||
|
||||
3. In the TUI, click **Basic Setup**.
|
||||
|
||||
4. Click **Generate Passwords** to create administrator passwords for your OpenRAG OpenSearch and Langflow services.
|
||||
4. For **Langflow Admin Password**, click **Generate Password** to create a Langflow administrator password and username.
|
||||
|
||||
5. Leave the **OpenAI API key** field empty.
|
||||
5. Use the default values for all other fields.
|
||||
|
||||
6. Click **Save Configuration**, and then click **Start All Services**.
|
||||
6. Click **Save Configuration**, and then click **Start OpenRAG**.
|
||||
|
||||
This process can take some time while OpenRAG pulls and runs the container images.
|
||||
If all services start successfully, the TUI prints a confirmation message:
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ Destroyed containers and deleted data are lost and cannot be recovered after run
|
|||
|
||||
<PartialExportFlows />
|
||||
|
||||
2. In the TUI's **Status** menu (<kbd>3</kbd>), click **Factory Reset** to [reset your OpenRAG containers](/manage-services#reset-containers).
|
||||
2. In the TUI's **Status** menu, click **Factory Reset** to [reset your OpenRAG containers](/manage-services#reset-containers).
|
||||
|
||||
<PartialFactorResetWarning />
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ slug: /tui
|
|||
|
||||
The OpenRAG Terminal User Interface (TUI) provides a simplified and guided experience for configuring, managing, and monitoring your OpenRAG deployment directly from the terminal.
|
||||
|
||||
|
||||
|
||||
|
||||
If you install OpenRAG with the [automatic installer script](/install), [`uv`](/install-uv), or [`uvx`](/install-uvx), you use the TUI to manage your OpenRAG deployment.
|
||||
The TUI guides you through the initial setup, automatically manages your OpenRAG `.env` and `docker-compose` files, and provides convenient access to [service management](/manage-services) controls.
|
||||
|
|
@ -18,9 +18,14 @@ If you installed OpenRAG with `uv`, access the TUI with `uv run openrag`.
|
|||
|
||||
If you installed OpenRAG with the automatic installer script or `uvx`, access the TUI with `uvx openrag`.
|
||||
|
||||
## Navigate the TUI
|
||||
|
||||
You can navigate the TUI with your mouse or keyboard.
|
||||
Keyboard shortcuts for additional menus are printed at the bottom of the TUI screen.
|
||||
|
||||
## Manage services with the TUI
|
||||
|
||||
Use the TUI's **Status** menu (<kbd>3</kbd>) and **Diagnostics** menu (<kbd>4</kbd>) to access controls and information for your OpenRAG services.
|
||||
Use the TUI's **Status** and **Diagnostics** menus to access controls and information for your OpenRAG services.
|
||||
For more information, see [Manage OpenRAG services](/manage-services).
|
||||
|
||||
## Exit the OpenRAG TUI
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ This is a two-part process because upgrading the OpenRAG Python package updates
|
|||
|
||||
<PartialExportFlows />
|
||||
|
||||
2. To check for updates, open the TUI's **Status** menu (<kbd>3</kbd>), and then click **Upgrade**.
|
||||
2. To check for updates, open the TUI's **Status** menu, and then click **Upgrade**.
|
||||
|
||||
3. If there is an update, stop all OpenRAG services.
|
||||
In the **Status** menu, click **Stop Services**.
|
||||
|
|
@ -112,7 +112,7 @@ The commands to upgrade the package depend on how you installed OpenRAG.
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
5. In the OpenRAG TUI, click **Start All Services**, and then wait while the upgraded containers start.
|
||||
5. In the OpenRAG TUI, click **Start Services**, and then wait while the upgraded containers start.
|
||||
|
||||
When you start services after upgrading the Python package, OpenRAG runs `docker compose pull` to get the appropriate container images matching the version specified in your OpenRAG `.env` file. Then, it recreates the containers with the new images using `docker compose up -d --force-recreate`.
|
||||
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 35 KiB |
BIN
docs/static/img/openrag_tui_dec_2025.png
vendored
Normal file
BIN
docs/static/img/openrag_tui_dec_2025.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
Loading…
Add table
Reference in a new issue