diff --git a/docs/docs/_partial-onboarding.mdx b/docs/docs/_partial-onboarding.mdx index 3f2de8fb..b8723d4c 100644 --- a/docs/docs/_partial-onboarding.mdx +++ b/docs/docs/_partial-onboarding.mdx @@ -7,7 +7,14 @@ The first time you start OpenRAG, whether using the TUI or a `.env` file, it's r To skip onboarding, click **Skip onboarding**. -Values from onboarding can be changed later in the OpenRAG **Settings** page. +:::warning +Most values from onboarding can be changed later in the OpenRAG **Settings** page, but there are important restrictions. + +The **language model provider** and **embeddings model provider** can only be selected at onboarding. +To change your provider selection later, you must [reinstall OpenRAG](/install#reinstall). + +You must use the same provider for your language model and embedding model, unless you're using Ollama. +::: Choose one LLM provider and complete only those steps: diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index 94b7d22f..cbaa5095 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -98,7 +98,7 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path. - **Basic Setup** generates all of the required values for OpenRAG except the OpenAI API key. + **Basic Setup** can generate all of the required values for OpenRAG except the OpenAI API key. **Basic Setup** does not set up OAuth connections for ingestion from cloud providers. For OAuth setup, use **Advanced Setup**. For information about the difference between basic (no auth) and OAuth in OpenRAG, see [Authentication and document access](/knowledge#auth). @@ -119,8 +119,9 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path. Services started successfully Command completed successfully ``` - 6. To open the OpenRAG application, click **Open App**. - 7. Continue with [Application Onboarding](#application-onboarding). + 6. To start the Docling service, under **Native Services**, click **Start**. + 7. To open the OpenRAG application, click **Open App**. + 8. Continue with [Application Onboarding](#application-onboarding). @@ -145,7 +146,8 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path. Services started successfully Command completed successfully ``` - 8. To open the OpenRAG application, click **Open App**. + 8. To start the Docling service, under **Native Services**, click **Start**. + 9. To open the OpenRAG application, click **Open App**. You are presented with your provider's OAuth sign-in screen. After sign-in, you are redirected to the redirect URI. @@ -160,7 +162,7 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path. - OneDrive: `/connectors/onedrive/webhook` - SharePoint: `/connectors/sharepoint/webhook` - 9. Continue with [Application Onboarding](#application-onboarding). + 10. Continue with [Application Onboarding](#application-onboarding). @@ -228,4 +230,21 @@ To view the status, port, or PID of a native service, in the TUI main menu, clic ## Diagnostics -The **Diagnostics** menu provides health monitoring for your container runtimes and monitoring of your OpenSearch security. \ No newline at end of file +The **Diagnostics** menu provides health monitoring for your container runtimes and monitoring of your OpenSearch security. + +## Reinstall OpenRAG {#reinstall} + +To reinstall OpenRAG with a completely fresh setup: + +1. Reset your containers using the **Reset** button in the [TUI status](#status) menu. + This removes all containers, volumes, and data. + +2. Optional: Delete your project's `.env` file. + The Reset operation does not remove your project's `.env` file, so your passwords, API keys, and OAuth settings can be preserved. + If you delete the `.env` file, run the [Set up OpenRAG with the TUI](#setup) process again to create a new configuration. + +3. In the TUI Setup menu, follow these steps from [Basic Setup](#setup): + 1. Click **Start All Services** to pull container images and start them. + 2. Under **Native Services**, click **Start** to start the Docling service. + 3. Click **Open App** to open the OpenRAG application. + 4. Continue with [Application Onboarding](#application-onboarding). \ No newline at end of file