Merge pull request #374 from langflow-ai/docs-quickstart-plus-install
docs: add script install to quickstart and update key requirements
This commit is contained in:
Sebastián Estévez
GitHub
commit
d97c41bd7f
7 changed files with 67 additions and 24 deletions
|
|
@ -69,7 +69,7 @@ For the full TUI installation guide, see [TUI](https://docs.openr.ag/install).
|
|||
|
||||
## Docker or Podman installation
|
||||
|
||||
For more information, see [Install OpenRAG containers](https://docs.openr.ag/get-started/docker).
|
||||
For more information, see [Install OpenRAG containers](https://docs.openr.ag/docker).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +1,10 @@
|
|||
import Icon from "@site/src/components/icon/icon";
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
## Application onboarding
|
||||
|
||||
The first time you start OpenRAG, whether using the TUI or a `.env` file, it's recommended that you complete application onboarding.
|
||||
|
||||
To skip onboarding, click **Skip onboarding**.
|
||||
The first time you start OpenRAG, whether using the TUI or a `.env` file, you must complete application onboarding.
|
||||
|
||||
:::warning
|
||||
Most values from onboarding can be changed later in the OpenRAG **Settings** page, but there are important restrictions.
|
||||
|
|
@ -27,6 +26,7 @@ Choose one LLM provider and complete only those steps:
|
|||
This is recommended, but not required.
|
||||
4. Click **Complete**.
|
||||
5. To complete the onboarding tasks, click **What is OpenRAG**, and then click **Add a Document**.
|
||||
Alternatively, click <Icon name="ArrowRight" aria-hidden="true"/> **Skip overview**.
|
||||
6. Continue with the [Quickstart](/quickstart).
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -38,6 +38,7 @@ Choose one LLM provider and complete only those steps:
|
|||
This is recommended, but not required.
|
||||
4. Click **Complete**.
|
||||
5. To complete the onboarding tasks, click **What is OpenRAG**, and then click **Add a Document**.
|
||||
Alternatively, click <Icon name="ArrowRight" aria-hidden="true"/> **Skip overview**.
|
||||
6. Continue with the [Quickstart](/quickstart).
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -54,6 +55,7 @@ Choose one LLM provider and complete only those steps:
|
|||
This is recommended, but not required.
|
||||
4. Click **Complete**.
|
||||
5. To complete the onboarding tasks, click **What is OpenRAG**, and then click **Add a Document**.
|
||||
Alternatively, click <Icon name="ArrowRight" aria-hidden="true"/> **Skip overview**.
|
||||
6. Continue with the [Quickstart](/quickstart).
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Install OpenRAG containers
|
||||
slug: /get-started/docker
|
||||
slug: /docker
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
|
@ -19,7 +19,7 @@ OpenRAG has two Docker Compose files. Both files deploy the same applications an
|
|||
- Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
|
||||
- Install [Podman](https://podman.io/docs/installation) (recommended) or [Docker](https://docs.docker.com/get-docker/)
|
||||
- Install [Docker Compose](https://docs.docker.com/compose/install/). If using Podman, use [podman-compose](https://docs.podman.io/en/latest/markdown/podman-compose.1.html) or alias Docker compose commands to Podman commands.
|
||||
- Create an [OpenAI API key](https://platform.openai.com/api-keys). This key is **required** to start OpenRAG, but you can choose a different model provider during [Application Onboarding](#application-onboarding).
|
||||
- Optional: Create an [OpenAI API key](https://platform.openai.com/api-keys). You can provide this key during [Application Onboarding](#application-onboarding) or choose a different model provider.
|
||||
- Optional: Install GPU support with an NVIDIA GPU, [CUDA](https://docs.nvidia.com/cuda/) support, and compatible NVIDIA drivers on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment.
|
||||
|
||||
## Install OpenRAG with Docker Compose
|
||||
|
|
@ -48,19 +48,20 @@ To install OpenRAG with Docker Compose, do the following:
|
|||
touch .env
|
||||
```
|
||||
|
||||
4. The Docker Compose files are populated with the values from your `.env` file. The following values must be set:
|
||||
4. The Docker Compose files are populated with the values from your `.env` file.
|
||||
The `OPENSEARCH_PASSWORD` value must be set.
|
||||
`OPENSEARCH_PASSWORD` can be automatically generated when using the TUI, but for a Docker Compose installation, you can set it manually instead. To generate an OpenSearch admin password, see the [OpenSearch documentation](https://docs.opensearch.org/latest/security/configuration/demo-configuration/#setting-up-a-custom-admin-password).
|
||||
|
||||
The following values are optional:
|
||||
|
||||
```bash
|
||||
OPENSEARCH_PASSWORD=your_secure_password
|
||||
OPENAI_API_KEY=your_openai_api_key
|
||||
LANGFLOW_SECRET_KEY=your_secret_key
|
||||
```
|
||||
|
||||
`OPENSEARCH_PASSWORD` can be automatically generated when using the TUI, but for a Docker Compose installation, you can set it manually instead. To generate an OpenSearch admin password, see the [OpenSearch documentation](https://docs.opensearch.org/latest/security/configuration/demo-configuration/#setting-up-a-custom-admin-password).
|
||||
`OPENAI_API_KEY` is optional. You can provide it during [Application Onboarding](#application-onboarding) or choose a different model provider. If you want to set it in your `.env` file, you can find your OpenAI API key in your [OpenAI account](https://platform.openai.com/api-keys).
|
||||
|
||||
The `OPENAI_API_KEY` is found in your OpenAI account.
|
||||
|
||||
`LANGFLOW_SECRET_KEY` is automatically generated when using the TUI, and Langflow will also auto-generate it if not set. For more information, see the [Langflow documentation](https://docs.langflow.org/api-keys-and-authentication#langflow-secret-key).
|
||||
`LANGFLOW_SECRET_KEY` is optional. Langflow will auto-generate it if not set. For more information, see the [Langflow documentation](https://docs.langflow.org/api-keys-and-authentication#langflow-secret-key).
|
||||
|
||||
The following Langflow configuration values are optional but important to consider:
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ Instead of starting OpenRAG using Docker commands and manually editing values in
|
|||
|
||||
Once OpenRAG is running, use the TUI to monitor your application, control your containers, and retrieve logs.
|
||||
|
||||
If you prefer running Podman or Docker containers and manually editing `.env` files, see [Install OpenRAG Containers](/get-started/docker).
|
||||
If you prefer running Podman or Docker containers and manually editing `.env` files, see [Install OpenRAG Containers](/docker).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
|
@ -25,7 +25,7 @@ If you prefer running Podman or Docker containers and manually editing `.env` fi
|
|||
- Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
|
||||
- Install [Podman](https://podman.io/docs/installation) (recommended) or [Docker](https://docs.docker.com/get-docker/)
|
||||
- Install [Docker Compose](https://docs.docker.com/compose/install/). If using Podman, use [podman-compose](https://docs.podman.io/en/latest/markdown/podman-compose.1.html) or alias Docker compose commands to Podman commands.
|
||||
- Create an [OpenAI API key](https://platform.openai.com/api-keys). This key is **required** to start OpenRAG, but you can choose a different model provider during [Application Onboarding](#application-onboarding).
|
||||
- Optional: Create an [OpenAI API key](https://platform.openai.com/api-keys). During [Application Onboarding](#application-onboarding), you can provide this key or choose a different model provider.
|
||||
- Optional: Install GPU support with an NVIDIA GPU, [CUDA](https://docs.nvidia.com/cuda/) support, and compatible NVIDIA drivers on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment.
|
||||
|
||||
## Install OpenRAG {#install}
|
||||
|
|
@ -163,7 +163,7 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path.
|
|||
<Tabs groupId="Setup method">
|
||||
<TabItem value="Basic setup" label="Basic setup" default>
|
||||
|
||||
**Basic Setup** can generate all of the required values for OpenRAG except the OpenAI API key.
|
||||
**Basic Setup** can generate all of the required values for OpenRAG. The OpenAI API key is optional and can be provided during onboarding.
|
||||
**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).
|
||||
|
|
@ -174,7 +174,7 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path.
|
|||
The OpenSearch password is required. The Langflow admin password is optional.
|
||||
If no Langflow admin password is generated, Langflow runs in [autologin mode](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login) with no password required.
|
||||
|
||||
3. Paste your OpenAI API key in the OpenAI API key field.
|
||||
3. Optional: Paste your OpenAI API key in the OpenAI API key field. You can also provide this during onboarding or choose a different model provider.
|
||||
4. Click **Save Configuration**.
|
||||
Your passwords are saved in the `.env` file used to start OpenRAG.
|
||||
5. To start OpenRAG, click **Start All Services**.
|
||||
|
|
|
|||
|
|
@ -11,7 +11,47 @@ Get started with OpenRAG by loading your knowledge, swapping out your language m
|
|||
|
||||
## Prerequisites
|
||||
|
||||
- Install and start OpenRAG with the [TUI](/install) or [Docker](/get-started/docker)
|
||||
:::tip
|
||||
This quickstart uses a minimal setup to demonstrate OpenRAG's core functionality. After you complete the quickstart, it is recommended that you reinstall OpenRAG with your preferred configuration because some settings are immutable after initial setup. For all installation options, see [Install OpenRAG with TUI](/install) and [Install OpenRAG with containers](/docker).
|
||||
:::
|
||||
|
||||
Install OpenRAG with the automatic installer.
|
||||
The script detects and installs uv, Docker/Podman, and Docker Compose prerequisites, and then starts OpenRAG with `uvx`.
|
||||
|
||||
1. Create a directory to store the OpenRAG configuration files:
|
||||
```bash
|
||||
mkdir openrag-workspace
|
||||
cd openrag-workspace
|
||||
```
|
||||
|
||||
2. Run the installer:
|
||||
```bash
|
||||
curl -fsSL https://docs.openr.ag/files/run_openrag_with_prereqs.sh | bash
|
||||
```
|
||||
|
||||
The TUI creates a `.env` file and docker-compose files in the current working directory, and then starts OpenRAG.
|
||||
|
||||
3. Select **Basic Setup**.
|
||||
4. To generate a password for OpenSearch, click **Generate Passwords**.
|
||||
The other fields aren't required.
|
||||
5. To start OpenRAG, click **Start All Services**.
|
||||
Startup pulls container images and runs them, so it can take some time.
|
||||
When startup is complete, the TUI displays the following:
|
||||
```bash
|
||||
Services started successfully
|
||||
Command completed successfully
|
||||
```
|
||||
6. To open the OpenRAG application, navigate to the TUI main menu, and then click **Open App**.
|
||||
Alternatively, in your browser, navigate to `localhost:3000`.
|
||||
7. For your model provider, select **OpenAI**.
|
||||
8. In the **OpenAI API key** field, paste your OpenAI API key.
|
||||
The default model settings are fine for the quickstart.
|
||||
9. To confirm your provider settings, click **Complete**.
|
||||
10. To complete onboarding, click **What is OpenRAG**, and then click **Add a document**.
|
||||
Alternatively, click <Icon name="ArrowRight" aria-hidden="true"/> **Skip overview**.
|
||||
|
||||
To quit OpenRAG, navigate to the TUI main menu and press <kbd>q</kbd>.
|
||||
To start OpenRAG again, run `uvx openrag`.
|
||||
|
||||
## Load and chat with your own documents
|
||||
|
||||
|
|
@ -43,7 +83,7 @@ To modify the knowledge ingestion or Agent behavior, click <Icon name="Settings2
|
|||
In this example, you'll try a different LLM to demonstrate how the Agent's response changes.
|
||||
|
||||
1. To edit the Agent's behavior, click **Edit in Langflow**.
|
||||
You can more quickly access the **Language Model** and **Agent Instructions** fields in this page, but for illustration purposes, navigate to the Langflow visual builder.
|
||||
You can more quickly access these parameters in the **Language model** and **Agent Instructions** fields in this page, but for illustration purposes, navigate to the Langflow visual builder.
|
||||
To revert the flow to its initial state, click **Restore flow**.
|
||||
2. OpenRAG warns you that you're entering Langflow. Click **Proceed**.
|
||||
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ For more information, see [Application onboarding](/install#application-onboardi
|
|||
| `EMBEDDING_MODEL` | `text-embedding-3-small` | Embedding model for vector search. |
|
||||
| `LLM_MODEL` | `gpt-4o-mini` | Language model for the chat agent. |
|
||||
| `MODEL_PROVIDER` | `openai` | Model provider, such as OpenAI or IBM watsonx.ai. |
|
||||
| `OPENAI_API_KEY` | - | Your OpenAI API key. Required. |
|
||||
| `OPENAI_API_KEY` | - | Your OpenAI API key. Optional. Can be provided during application onboarding when installing OpenRAG. |
|
||||
| `PROVIDER_API_KEY` | - | API key for the model provider. |
|
||||
| `PROVIDER_ENDPOINT` | - | Custom provider endpoint. Only used for IBM or Ollama providers. |
|
||||
| `PROVIDER_PROJECT_ID` | - | Project ID for providers. Only required for the IBM watsonx.ai provider. |
|
||||
|
|
|
|||
|
|
@ -21,6 +21,11 @@ const sidebars = {
|
|||
id: "get-started/what-is-openrag",
|
||||
label: "About OpenRAG"
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
id: "get-started/quickstart",
|
||||
label: "Quickstart"
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
id: "get-started/install",
|
||||
|
|
@ -31,11 +36,6 @@ const sidebars = {
|
|||
id: "get-started/docker",
|
||||
label: "Install OpenRAG containers"
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
id: "get-started/quickstart",
|
||||
label: "Quickstart"
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
id: "core-components/agents",
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue