477 lines
No EOL
69 KiB
HTML
477 lines
No EOL
69 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-get-started/install" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.9.2">
|
||
<title data-rh="true">Install OpenRAG with TUI | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/install"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Install OpenRAG with TUI | OpenRAG"><meta data-rh="true" name="description" content="Install OpenRAG and then run the OpenRAG Terminal User Interface(TUI) to start your OpenRAG deployment with a guided setup process."><meta data-rh="true" property="og:description" content="Install OpenRAG and then run the OpenRAG Terminal User Interface(TUI) to start your OpenRAG deployment with a guided setup process."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Install OpenRAG with TUI","item":"https://docs.openr.ag/install"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||
<script src="/assets/js/runtime~main.a3cb74e9.js" defer="defer"></script>
|
||
<script src="/assets/js/main.86159c47.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg style="display: none;"><defs>
|
||
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/img/logo-openrag-light.svg"><link rel="preload" as="image" href="/img/logo-openrag-dark.svg"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo-openrag-light.svg" alt="OpenRAG Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/logo-openrag-dark.svg" alt="OpenRAG Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/langflow-ai/openrag" target="_blank" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/"><span title="About OpenRAG" class="linkLabel_WmDU">About OpenRAG</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/quickstart"><span title="Quickstart" class="linkLabel_WmDU">Quickstart</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/install"><span title="Install OpenRAG with TUI" class="linkLabel_WmDU">Install OpenRAG with TUI</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docker"><span title="Install OpenRAG containers" class="linkLabel_WmDU">Install OpenRAG containers</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/agents"><span title="Flows" class="linkLabel_WmDU">Flows</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/knowledge"><span title="Knowledge" class="categoryLinkLabel_W154">Knowledge</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/chat"><span title="Chat" class="linkLabel_WmDU">Chat</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/reference/configuration"><span title="Environment variables" class="linkLabel_WmDU">Environment variables</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/support/troubleshoot"><span title="Troubleshoot OpenRAG" class="linkLabel_WmDU">Troubleshoot OpenRAG</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Install OpenRAG with TUI</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Install OpenRAG with TUI</h1></header><p><a href="#install" class="">Install OpenRAG</a> and then run the <a href="#setup" class="">OpenRAG Terminal User Interface(TUI)</a> to start your OpenRAG deployment with a guided setup process.</p>
|
||
<p>The OpenRAG Terminal User Interface (TUI) allows you to set up, configure, and monitor your OpenRAG deployment directly from the terminal.</p>
|
||
<p><img decoding="async" loading="lazy" alt="OpenRAG TUI Interface" src="/assets/images/OpenRAG_TUI_2025-09-10T13_04_11_757637-9441c53ba39162a88ac6c11cbeaed0e0.svg" width="1995" height="1099" class="img_ev3q"></p>
|
||
<p>Instead of starting OpenRAG using Docker commands and manually editing values in the <code>.env</code> file, the TUI walks you through the setup. It prompts for variables where required, creates a <code>.env</code> file for you, and then starts OpenRAG.</p>
|
||
<p>Once OpenRAG is running, use the TUI to monitor your application, control your containers, and retrieve logs.</p>
|
||
<p>If you prefer running Podman or Docker containers and manually editing <code>.env</code> files, see <a class="" href="/docker">Install OpenRAG Containers</a>.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="prerequisites">Prerequisites<a href="#prerequisites" class="hash-link" aria-label="Direct link to Prerequisites" title="Direct link to Prerequisites" translate="no"></a></h2>
|
||
<ul>
|
||
<li class="">
|
||
<p>All OpenRAG installations require <a href="https://www.python.org/downloads/release/python-3100/" target="_blank" rel="noopener noreferrer" class="">Python</a> version 3.13 or later.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>If you aren't using the automatic installer script, install the following:</p>
|
||
<ul>
|
||
<li class=""><a href="https://docs.astral.sh/uv/getting-started/installation/" target="_blank" rel="noopener noreferrer" class="">uv</a>.</li>
|
||
<li class=""><a href="https://podman.io/docs/installation" target="_blank" rel="noopener noreferrer" class="">Podman</a> (recommended) or <a href="https://docs.docker.com/get-docker/" target="_blank" rel="noopener noreferrer" class="">Docker</a>.</li>
|
||
<li class=""><a href="https://docs.podman.io/en/latest/markdown/podman-compose.1.html" target="_blank" rel="noopener noreferrer" class=""><code>podman-compose</code></a> or <a href="https://docs.docker.com/compose/install/" target="_blank" rel="noopener noreferrer" class="">Docker Compose</a>. To use Docker Compose with Podman, you must alias Docker Compose commands to Podman commands.</li>
|
||
</ul>
|
||
</li>
|
||
<li class="">
|
||
<p>Microsoft Windows only: To run OpenRAG on Windows, you must use the Windows Subsystem for Linux (WSL).</p>
|
||
<details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Install WSL for OpenRAG</summary><div><div class="collapsibleContent_i85q"><ol>
|
||
<li class="">
|
||
<p><a href="https://learn.microsoft.com/en-us/windows/wsl/install" target="_blank" rel="noopener noreferrer" class="">Install WSL</a> with the Ubuntu distribution using WSL 2:</p>
|
||
<div class="language-powershell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-powershell codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">wsl --install -d Ubuntu</span><br></span></code></pre></div></div>
|
||
<p>For new installations, the <code>wsl --install</code> command uses WSL 2 and Ubuntu by default.</p>
|
||
<p>For existing WSL installations, you can <a href="https://learn.microsoft.com/en-us/windows/wsl/install#change-the-default-linux-distribution-installed" target="_blank" rel="noopener noreferrer" class="">change the distribution</a> and <a href="https://learn.microsoft.com/en-us/windows/wsl/install#upgrade-version-from-wsl-1-to-wsl-2" target="_blank" rel="noopener noreferrer" class="">check the WSL version</a>.</p>
|
||
<div class="theme-admonition theme-admonition-warning admonition_xJq3 alert alert--warning"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>Known limitation</div><div class="admonitionContent_BuS1"><p>OpenRAG isn't compatible with nested virtualization, which can cause networking issues.
|
||
Don't install OpenRAG on a WSL distribution that is installed inside a Windows VM.
|
||
Instead, install OpenRAG on your base OS or a non-nested Linux VM.</p></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p><a href="https://learn.microsoft.com/en-us/windows/wsl/install#ways-to-run-multiple-linux-distributions-with-wsl" target="_blank" rel="noopener noreferrer" class="">Start your WSL Ubuntu distribution</a> if it doesn't start automatically.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><a href="https://learn.microsoft.com/en-us/windows/wsl/setup/environment#set-up-your-linux-username-and-password" target="_blank" rel="noopener noreferrer" class="">Set up a username and password for your WSL distribution</a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><a href="https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers" target="_blank" rel="noopener noreferrer" class="">Install Docker Desktop for Windows with WSL 2</a>. When you reach the Docker Desktop <strong>WSL integration</strong> settings, make sure your Ubuntu distribution is enabled, and then click <strong>Apply & Restart</strong> to enable Docker support in WSL.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Install and run OpenRAG from within your WSL Ubuntu distribution.</p>
|
||
</li>
|
||
</ol>
|
||
<br>
|
||
<p>If you encounter issues with port forwarding or the Windows Firewall, you might need to adjust the <a href="https://learn.microsoft.com/en-us/windows/security/operating-system-security/network-security/windows-firewall/hyper-v-firewall" target="_blank" rel="noopener noreferrer" class="">Hyper-V firewall settings</a> to allow communication between your WSL distribution and the Windows host. For more troubleshooting advice for networking issues, see <a href="https://learn.microsoft.com/en-us/windows/wsl/troubleshooting#common-issues" target="_blank" rel="noopener noreferrer" class="">Troubleshooting WSL common issues</a>.</p></div></div></details>
|
||
</li>
|
||
<li class="">
|
||
<p>Prepare model providers and credentials.</p>
|
||
<p>During <a href="#application-onboarding" class="">application onboarding</a>, you must select language model and embedding model providers.
|
||
If your chosen provider offers both types, you can use the same provider for both selections.
|
||
If your provider offers only one type, such as Anthropic, you must select two providers.</p>
|
||
<p>Gather the credentials and connection details for your chosen model providers before starting onboarding:</p>
|
||
<ul>
|
||
<li class="">OpenAI: Create an <a href="https://platform.openai.com/api-keys" target="_blank" rel="noopener noreferrer" class="">OpenAI API key</a>.</li>
|
||
<li class="">Anthropic language models: Create an <a href="https://www.anthropic.com/docs/api/reference" target="_blank" rel="noopener noreferrer" class="">Anthropic API key</a>.</li>
|
||
<li class="">IBM watsonx.ai: Get your watsonx.ai API endpoint, IBM project ID, and IBM API key from your watsonx deployment.</li>
|
||
<li class="">Ollama: Use the <a href="https://docs.ollama.com/" target="_blank" rel="noopener noreferrer" class="">Ollama documentation</a> to set up your Ollama instance locally, in the cloud, or on a remote server, and then get your Ollama server's base URL.</li>
|
||
</ul>
|
||
</li>
|
||
<li class="">
|
||
<p>Optional: Install GPU support with an NVIDIA GPU, <a href="https://docs.nvidia.com/cuda/" target="_blank" rel="noopener noreferrer" class="">CUDA</a> support, and compatible NVIDIA drivers on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment.</p>
|
||
</li>
|
||
</ul>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="install">Install OpenRAG<a href="#install" class="hash-link" aria-label="Direct link to Install OpenRAG" title="Direct link to Install OpenRAG" translate="no"></a></h2>
|
||
<p>Choose an installation method based on your needs:</p>
|
||
<ul>
|
||
<li class="">For new users, the automatic installer script detects and installs prerequisites and then runs OpenRAG.</li>
|
||
<li class="">For a quick test, use <code>uvx</code> to run OpenRAG without creating a project or modifying files.</li>
|
||
<li class="">Use <code>uv add</code> to install OpenRAG as a managed dependency in a new or existing Python project.</li>
|
||
<li class="">Use <code>uv pip install</code> to install OpenRAG into an existing virtual environment.</li>
|
||
</ul>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Automatic installer</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Quick test with uvx</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Python project with uv add</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Existing virtual environment with uv pip install</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>The script detects and installs uv, Docker/Podman, and Docker Compose prerequisites, then runs OpenRAG with <code>uvx</code>.</p><ol>
|
||
<li class="">
|
||
<p>Create a directory to store the OpenRAG configuration files:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">mkdir openrag-workspace</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">cd openrag-workspace</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Run the installer:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">curl -fsSL https://docs.openr.ag/files/run_openrag_with_prereqs.sh | bash</span><br></span></code></pre></div></div>
|
||
</li>
|
||
</ol><p>The TUI creates a <code>.env</code> file and docker-compose files in the current working directory.</p></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Use <code>uvx</code> to quickly run OpenRAG without creating a project or modifying any files.</p><ol>
|
||
<li class="">
|
||
<p>Create a directory to store the OpenRAG configuration files:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">mkdir openrag-workspace</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">cd openrag-workspace</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Run OpenRAG:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uvx openrag</span><br></span></code></pre></div></div>
|
||
<p>To run a specific version:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uvx --from openrag==0.1.30 openrag</span><br></span></code></pre></div></div>
|
||
</li>
|
||
</ol><p>The TUI creates a <code>.env</code> file and docker-compose files in the current working directory.</p></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Use <code>uv add</code> to install OpenRAG as a dependency in your Python project. This adds OpenRAG to your <code>pyproject.toml</code> and lockfile, making your installation reproducible and version-controlled.</p><ol>
|
||
<li class="">
|
||
<p>Create a new project with a virtual environment:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv init YOUR_PROJECT_NAME</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">cd YOUR_PROJECT_NAME</span><br></span></code></pre></div></div>
|
||
<p>The <code>(venv)</code> prompt doesn't change, but <code>uv</code> commands will automatically use the project's virtual environment.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Add OpenRAG to your project:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv add openrag</span><br></span></code></pre></div></div>
|
||
<p>To add a specific version:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv add openrag==0.1.30</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Start the OpenRAG TUI:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv run openrag</span><br></span></code></pre></div></div>
|
||
</li>
|
||
</ol><details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Install a local wheel</summary><div><div class="collapsibleContent_i85q"><p>If you downloaded the OpenRAG wheel to your local machine, install it by specifying its path:</p><ol>
|
||
<li class="">
|
||
<p>Add the wheel to your project:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv add PATH/TO/openrag-VERSION-py3-none-any.whl</span><br></span></code></pre></div></div>
|
||
<p>Replace <code>PATH/TO/</code> and <code>VERSION</code> with the path and version of your downloaded OpenRAG <code>.whl</code> file.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Run OpenRAG:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv run openrag</span><br></span></code></pre></div></div>
|
||
</li>
|
||
</ol></div></div></details></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Use <code>uv pip install</code> to install OpenRAG into an existing virtual environment that isn't managed by <code>uv</code>.</p><div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_BuS1"><p>For new projects, <code>uv add</code> is recommended as it manages dependencies in your project's lockfile.</p></div></div><ol>
|
||
<li class="">
|
||
<p>Activate your virtual environment.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Install OpenRAG:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv pip install openrag</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Run OpenRAG:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv run openrag</span><br></span></code></pre></div></div>
|
||
</li>
|
||
</ol></div></div></div>
|
||
<p>Continue with <a href="#setup" class="">Set up OpenRAG with the TUI</a>.</p>
|
||
<p>If you encounter errors during installation, see <a class="" href="/support/troubleshoot">Troubleshoot OpenRAG</a>.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="setup">Set up OpenRAG with the TUI<a href="#setup" class="hash-link" aria-label="Direct link to Set up OpenRAG with the TUI" title="Direct link to Set up OpenRAG with the TUI" translate="no"></a></h2>
|
||
<p>The OpenRAG setup process creates a <code>.env</code> file at the root of your OpenRAG directory, and then starts OpenRAG.
|
||
If it detects a <code>.env</code> file in the OpenRAG root directory, it sources any variables from the <code>.env</code> file.</p>
|
||
<p>The TUI offers two setup methods to populate the required values. <strong>Basic Setup</strong> can generate all minimum required values for OpenRAG. However, <strong>Basic Setup</strong> doesn't enable <a class="" href="/knowledge#auth">OAuth connectors for cloud storage</a>. If you want to use OAuth connectors to upload documents from cloud storage, select <strong>Advanced Setup</strong>.
|
||
If OpenRAG detects OAuth credentials, it recommends <strong>Advanced Setup</strong>.</p>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Basic setup</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Advanced setup</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><ol>
|
||
<li class="">
|
||
<p>To install OpenRAG with <strong>Basic Setup</strong>, click <strong>Basic Setup</strong> or press <kbd>1</kbd>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Generate Passwords</strong> to generate passwords for OpenSearch and Langflow.</p>
|
||
<p>The OpenSearch password is required. The Langflow admin password is optional.
|
||
If no Langflow admin password is generated, Langflow runs in <a href="https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login" target="_blank" rel="noopener noreferrer" class="">autologin mode</a> with no password required.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>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.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Save Configuration</strong>.
|
||
Your passwords are saved in the <code>.env</code> file used to start OpenRAG.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>To start OpenRAG, click <strong>Start All Services</strong>.
|
||
Startup pulls container images and runs them, so it can take some time.
|
||
When startup is complete, the TUI displays the following:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Services started successfully</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">Command completed successfully</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>To start the Docling service, under <strong>Native Services</strong>, click <strong>Start</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>To open the OpenRAG application, navigate to the TUI main menu, and then click <strong>Open App</strong>.
|
||
Alternatively, in your browser, navigate to <code>localhost:3000</code>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Continue with <a href="#application-onboarding" class="">application onboarding</a>.</p>
|
||
</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
|
||
<li class="">
|
||
<p>To install OpenRAG with <strong>Advanced Setup</strong>, click <strong>Advanced Setup</strong> or press <kbd>2</kbd>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Generate Passwords</strong> to generate passwords for OpenSearch and Langflow.</p>
|
||
<p>The OpenSearch password is required. The Langflow admin password is optional.
|
||
If no Langflow admin password is generated, Langflow runs in <a href="https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login" target="_blank" rel="noopener noreferrer" class="">autologin mode</a> with no password required.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Paste your OpenAI API key in the OpenAI API key field.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>If you want 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 a <code>.env</code> file in the OpenRAG installation directory.</p>
|
||
<ul>
|
||
<li class=""><strong>Amazon</strong>: 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 <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-applications.html" target="_blank" rel="noopener noreferrer" class="">Configuring access to AWS applications</a>.</li>
|
||
<li class=""><strong>Google</strong>: Provide your Google OAuth Client ID and Google OAuth Client Secret. You can generate these in the <a href="https://console.cloud.google.com/apis/credentials" target="_blank" rel="noopener noreferrer" class="">Google Cloud Console</a>. For more information, see the <a href="https://developers.google.com/identity/protocols/oauth2" target="_blank" rel="noopener noreferrer" class="">Google OAuth client documentation</a>.</li>
|
||
<li class=""><strong>Microsoft</strong>: For the Microsoft OAuth Client ID and Microsoft OAuth Client Secret, provide <a href="https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/app-registration?view=odsp-graph-online" target="_blank" rel="noopener noreferrer" class="">Azure application registration credentials for SharePoint and OneDrive</a>. For more information, see the <a href="https://learn.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/graph-oauth" target="_blank" rel="noopener noreferrer" class="">Microsoft Graph OAuth client documentation</a>.</li>
|
||
</ul>
|
||
<p>You can <a class="" href="/ingestion#oauth-ingestion">manage OAuth credentials</a> later, but it is recommended to configure them during initial set up.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>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.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Save Configuration</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>To start OpenRAG, click <strong>Start All Services</strong>.
|
||
Startup pulls container images and runs them, so it can take some time.
|
||
When startup is complete, the TUI displays the following:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Services started successfully</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">Command completed successfully</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>To start the Docling service, under <strong>Native Services</strong>, click <strong>Start</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>To open the OpenRAG application, navigate to the TUI main menu, and then click <strong>Open App</strong>.
|
||
Alternatively, in your browser, navigate to <code>localhost:3000</code>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>If you enabled OAuth connectors, you must sign in to your OAuth provider before being redirected to your OpenRAG instance.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Two additional variables are available for <strong>Advanced Setup</strong> at this point.
|
||
Only change these variables if you have a non-default network configuration for your deployment, such as using a reverse proxy or custom domain.</p>
|
||
<ul>
|
||
<li class="">
|
||
<p><code>LANGFLOW_PUBLIC_URL</code>: Sets the base address to access the Langflow web interface. This is where users interact with flows in a browser.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><code>WEBHOOK_BASE_URL</code>: Sets the base address of the OpenRAG OAuth connector endpoint.
|
||
Supported webhook endpoints:</p>
|
||
<ul>
|
||
<li class="">Amazon S3: Not applicable.</li>
|
||
<li class="">Google Drive: <code>/connectors/google_drive/webhook</code></li>
|
||
<li class="">OneDrive: <code>/connectors/onedrive/webhook</code></li>
|
||
<li class="">SharePoint: <code>/connectors/sharepoint/webhook</code></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="">
|
||
<p>Continue with <a href="#application-onboarding" class="">application onboarding</a>.</p>
|
||
</li>
|
||
</ol></div></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="application-onboarding">Application onboarding<a href="#application-onboarding" class="hash-link" aria-label="Direct link to Application onboarding" title="Direct link to Application onboarding" translate="no"></a></h2>
|
||
<p>The first time you start OpenRAG, regardless of how you installed it, you must complete application onboarding.</p>
|
||
<p>Some of these variables, such as the embedding models, can be changed seamlessly after onboarding.
|
||
Others are immutable and require you to destroy and recreate the OpenRAG containers.
|
||
For more information, see <a class="" href="/reference/configuration">Environment variables</a>.</p>
|
||
<p>You can use different providers for your language model and embedding model, such as Anthropic for the language model and OpenAI for the embeddings model.
|
||
Additionally, you can set multiple embedding models.</p>
|
||
<p>You only need to complete onboarding for your preferred providers.</p>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Anthropic</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">OpenAI</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">IBM watsonx.ai</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Ollama</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div class="theme-admonition theme-admonition-info admonition_xJq3 alert alert--info"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>info</div><div class="admonitionContent_BuS1"><p>Anthropic doesn't provide embedding models. If you select Anthropic for your language model, you must select a different provider for embeddings.</p></div></div><ol>
|
||
<li class="">Enable <strong>Use environment Anthropic API key</strong> to automatically use your key from the <code>.env</code> file.
|
||
Alternatively, paste an Anthropic API key into the field.</li>
|
||
<li class="">Under <strong>Advanced settings</strong>, select your <strong>Language Model</strong>.</li>
|
||
<li class="">Click <strong>Complete</strong>.</li>
|
||
<li class="">In the second onboarding panel, select a provider for embeddings and select your <strong>Embedding Model</strong>.</li>
|
||
<li class="">To complete the onboarding tasks, click <strong>What is OpenRAG</strong>, and then click <strong>Add a Document</strong>.
|
||
Alternatively, click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right" aria-hidden="true"><path d="M5 12h14"></path><path d="m12 5 7 7-7 7"></path></svg> <strong>Skip overview</strong>.</li>
|
||
<li class="">Continue with the <a class="" href="/quickstart">Quickstart</a>.</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
|
||
<li class="">Enable <strong>Get API key from environment variable</strong> to automatically enter your key from the TUI-generated <code>.env</code> file.
|
||
Alternatively, paste an OpenAI API key into the field.</li>
|
||
<li class="">Under <strong>Advanced settings</strong>, select your <strong>Language Model</strong>.</li>
|
||
<li class="">Click <strong>Complete</strong>.</li>
|
||
<li class="">In the second onboarding panel, select a provider for embeddings and select your <strong>Embedding Model</strong>.</li>
|
||
<li class="">To complete the onboarding tasks, click <strong>What is OpenRAG</strong>, and then click <strong>Add a Document</strong>.
|
||
Alternatively, click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right" aria-hidden="true"><path d="M5 12h14"></path><path d="m12 5 7 7-7 7"></path></svg> <strong>Skip overview</strong>.</li>
|
||
<li class="">Continue with the <a class="" href="/quickstart">Quickstart</a>.</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
|
||
<li class="">Complete the fields for <strong>watsonx.ai API Endpoint</strong>, <strong>IBM Project ID</strong>, and <strong>IBM API key</strong>.
|
||
These values are found in your IBM watsonx deployment.</li>
|
||
<li class="">Under <strong>Advanced settings</strong>, select your <strong>Language Model</strong>.</li>
|
||
<li class="">Click <strong>Complete</strong>.</li>
|
||
<li class="">In the second onboarding panel, select a provider for embeddings and select your <strong>Embedding Model</strong>.</li>
|
||
<li class="">To complete the onboarding tasks, click <strong>What is OpenRAG</strong>, and then click <strong>Add a Document</strong>.
|
||
Alternatively, click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right" aria-hidden="true"><path d="M5 12h14"></path><path d="m12 5 7 7-7 7"></path></svg> <strong>Skip overview</strong>.</li>
|
||
<li class="">Continue with the <a class="" href="/quickstart">Quickstart</a>.</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div class="theme-admonition theme-admonition-info admonition_xJq3 alert alert--info"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>info</div><div class="admonitionContent_BuS1"><p>Ollama isn't installed with OpenRAG. To install Ollama, see the <a href="https://docs.ollama.com/" target="_blank" rel="noopener noreferrer" class="">Ollama documentation</a>.</p></div></div><ol>
|
||
<li class="">To connect to an Ollama server running on your local machine, enter your Ollama server's base URL address.
|
||
The default Ollama server address is <code>http://localhost:11434</code>.
|
||
OpenRAG connects to the Ollama server and populates the model lists with the server's available models.</li>
|
||
<li class="">Select the <strong>Embedding Model</strong> and <strong>Language Model</strong> your Ollama server is running.<!-- -->
|
||
<details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Ollama model selection and external server configuration</summary><div><div class="collapsibleContent_i85q"><p>Using Ollama for your OpenRAG language model provider offers greater flexibility and configuration, but can also be overwhelming to start.
|
||
These recommendations are a reasonable starting point for users with at least one GPU and experience running LLMs locally.</p>
|
||
<p>For best performance, OpenRAG recommends OpenAI's <code>gpt-oss:20b</code> language model. However, this model uses 16GB of RAM, so consider using Ollama Cloud or running Ollama on a remote machine.</p>
|
||
<p>For generating embeddings, OpenRAG recommends the <a href="https://ollama.com/library/nomic-embed-text" target="_blank" rel="noopener noreferrer" class=""><code>nomic-embed-text</code></a> embedding model, which provides high-quality embeddings optimized for retrieval tasks.</p>
|
||
<p>To run models in <a href="https://docs.ollama.com/cloud" target="_blank" rel="noopener noreferrer" class=""><strong>Ollama Cloud</strong></a>, follow these steps:</p>
|
||
<ol>
|
||
<li class="">Sign in to Ollama Cloud.
|
||
In a terminal, enter <code>ollama signin</code> to connect your local environment with Ollama Cloud.</li>
|
||
<li class="">To run the model, in Ollama, select the <code>gpt-oss:20b-cloud</code> model, or run <code>ollama run gpt-oss:20b-cloud</code> in a terminal.
|
||
Ollama Cloud models are run at the same URL as your local Ollama server at <code>http://localhost:11434</code>, and automatically offloaded to Ollama's cloud service.</li>
|
||
<li class="">Connect OpenRAG to the same local Ollama server as you would for local models in onboarding, using the default address of <code>http://localhost:11434</code>.</li>
|
||
<li class="">In the <strong>Language model</strong> field, select the <code>gpt-oss:20b-cloud</code> model.</li>
|
||
</ol>
|
||
<br>
|
||
<p>To run models on a <strong>remote Ollama server</strong>, follow these steps:</p>
|
||
<ol>
|
||
<li class="">Ensure your remote Ollama server is accessible from your OpenRAG instance.</li>
|
||
<li class="">In the <strong>Ollama Base URL</strong> field, enter your remote Ollama server's base URL, such as <code>http://your-remote-server:11434</code>.
|
||
OpenRAG connects to the remote Ollama server and populates the lists with the server's available models.</li>
|
||
<li class="">Select your <strong>Embedding model</strong> and <strong>Language model</strong> from the available options.</li>
|
||
</ol></div></div></details>
|
||
</li>
|
||
<li class="">Click <strong>Complete</strong>.</li>
|
||
<li class="">To complete the onboarding tasks, click <strong>What is OpenRAG</strong>, and then click <strong>Add a Document</strong>.</li>
|
||
<li class="">Continue with the <a class="" href="/quickstart">Quickstart</a>.</li>
|
||
</ol></div></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="exit-the-openrag-tui">Exit the OpenRAG TUI<a href="#exit-the-openrag-tui" class="hash-link" aria-label="Direct link to Exit the OpenRAG TUI" title="Direct link to Exit the OpenRAG TUI" translate="no"></a></h2>
|
||
<p>To exit the OpenRAG TUI, navigate to the main menu, and then press <kbd>q</kbd>.
|
||
The OpenRAG containers continue to run until they are stopped.
|
||
For more information, see <a href="#tui-container-management" class="">Manage OpenRAG containers with the TUI </a>.</p>
|
||
<p>To relaunch the TUI, run <code>uv run openrag</code>.
|
||
If you installed OpenRAG with <code>uvx</code>, run <code>uvx openrag</code>.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="tui-container-management">Manage OpenRAG containers with the TUI<a href="#tui-container-management" class="hash-link" aria-label="Direct link to Manage OpenRAG containers with the TUI" title="Direct link to Manage OpenRAG containers with the TUI" translate="no"></a></h2>
|
||
<p>After installation, the TUI can deploy, manage, and upgrade your OpenRAG containers.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="diagnostics">Diagnostics<a href="#diagnostics" class="hash-link" aria-label="Direct link to Diagnostics" title="Direct link to Diagnostics" translate="no"></a></h3>
|
||
<p>The <strong>Diagnostics</strong> menu provides health monitoring for your container runtimes and monitoring of your OpenSearch security.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="status">Status<a href="#status" class="hash-link" aria-label="Direct link to Status" title="Direct link to Status" translate="no"></a></h3>
|
||
<p>The <strong>Status</strong> menu displays information on your container deployment.
|
||
Here you can check container health, find your service ports, view logs, and upgrade your containers.</p>
|
||
<ul>
|
||
<li class="">
|
||
<p><strong>Logs</strong>: To view streaming logs, select the container you want to view, and press <kbd>l</kbd>.
|
||
To copy the logs, click <strong>Copy to Clipboard</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>Upgrade</strong>: Check for updates. For more information, see <a href="#upgrade" class="">upgrade OpenRAG</a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>Factory Reset</strong>: This is a destructive action that <a href="#reset-containers" class="">resets your containers</a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>Native services</strong>: <a href="#start-all-services" class="">View and manage OpenRAG services</a> that run directly on your local machine instead of a container.</p>
|
||
</li>
|
||
</ul>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="reset-containers">Reset containers<a href="#reset-containers" class="hash-link" aria-label="Direct link to Reset containers" title="Direct link to Reset containers" translate="no"></a></h3>
|
||
<p>Reset your OpenRAG deployment by recreating the containers and removing some related data.</p>
|
||
<div class="theme-admonition theme-admonition-warning admonition_xJq3 alert alert--warning"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>warning</div><div class="admonitionContent_BuS1"><p>This is a destructive action that destroys the following:</p><ul>
|
||
<li class="">All OpenRAG containers, volumes, and local images</li>
|
||
<li class="">Any additional Docker objects</li>
|
||
<li class="">The contents of OpenRAG's <code>config</code> and <code>./opensearch-data</code> directories</li>
|
||
<li class="">The <code>conversations.json</code> file</li>
|
||
</ul><p>This operation <em>doesn't</em> remove the <code>.env</code> file or the contents of the <code>./openrag-documents</code> directory.</p></div></div>
|
||
<ol>
|
||
<li class="">
|
||
<p>To destroy and recreate your OpenRAG containers, go to the TUI <a href="#status" class=""><strong>Status</strong> menu</a>, and then click <strong>Factory Reset</strong>.</p>
|
||
<p>This function runs the following commands <em>and</em> deletes the contents of OpenRAG's <code>config</code> and <code>./opensearch-data</code> directories.</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">docker compose down --volumes --remove-orphans --rmi local</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">docker system prune -f</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>If you reset your containers as part of reinstalling OpenRAG, continue the <a href="#reinstall" class="">reinstallation process</a> after resetting the containers.
|
||
Otherwise, in the TUI <strong>Setup</strong> menu, repeat the <a href="#setup" class="">setup process</a> to start the services and launch the OpenRAG app. Your OpenRAG passwords, OAuth credentials (if previously set), and onboarding configuration are restored from the <code>.env</code> file.</p>
|
||
</li>
|
||
</ol>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="start-all-services">Start all services<a href="#start-all-services" class="hash-link" aria-label="Direct link to Start all services" title="Direct link to Start all services" translate="no"></a></h3>
|
||
<p>Through the TUI, you can view and manage OpenRAG services that run in containers and directly on your local machine.</p>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="start-containers">Start containers<a href="#start-containers" class="hash-link" aria-label="Direct link to Start containers" title="Direct link to Start containers" translate="no"></a></h4>
|
||
<p>On the TUI main page or the <strong>Setup</strong> menu, click <strong>Start All Services</strong> to start the OpenRAG containers and launch OpenRAG itself.</p>
|
||
<p>When you start all services, the following processes happen:</p>
|
||
<ol>
|
||
<li class="">
|
||
<p>OpenRAG automatically detects your container runtime, and then checks if your machine has compatible GPU support by checking for <code>CUDA</code>, <code>NVIDIA_SMI</code>, and Docker/Podman runtime support. This check determines which Docker Compose file OpenRAG uses.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>OpenRAG pulls the OpenRAG container images with <code>docker compose pull</code> if any images are missing.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>OpenRAG deploys the containers with <code>docker compose up -d</code>.</p>
|
||
</li>
|
||
</ol>
|
||
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="start-native-services-docling">Start native services (Docling)<a href="#start-native-services-docling" class="hash-link" aria-label="Direct link to Start native services (Docling)" title="Direct link to Start native services (Docling)" translate="no"></a></h4>
|
||
<p>A <em>native service</em> in OpenRAG is a service that runs locally on your machine, not within a container. For example, the <code>docling serve</code> process is an OpenRAG native service because this document processing service runs on your local machine, separate from the OpenRAG containers.</p>
|
||
<p>From the <strong>Status</strong> menu, you can view the status, port, and process ID (PID) of the OpenRAG native services.
|
||
You can also click <strong>Stop</strong> or <strong>Restart</strong> to stop and start OpenRAG native services.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="upgrade">Upgrade OpenRAG<a href="#upgrade" class="hash-link" aria-label="Direct link to Upgrade OpenRAG" title="Direct link to Upgrade OpenRAG" translate="no"></a></h2>
|
||
<p>To upgrade OpenRAG, upgrade the OpenRAG Python package, and then upgrade the OpenRAG containers.</p>
|
||
<p>This is a two part process because upgrading the OpenRAG Python package updates the TUI and Python code, but the container versions are controlled by environment variables in your <code>.env</code> file.</p>
|
||
<ol>
|
||
<li class="">
|
||
<p>Stop your OpenRAG containers: In the OpenRAG TUI, go to the <strong>Status</strong> menu, and then click <strong>Stop Services</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Upgrade the OpenRAG Python package to the latest version from <a href="https://pypi.org/project/openrag/" target="_blank" rel="noopener noreferrer" class="">PyPI</a>.</p>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Automatic installer or uvx</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Python project (uv add)</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Virtual environment (uv pip install)</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>Use these steps to upgrade the Python package if you installed OpenRAG using the automatic installer or <code>uvx</code>:</p><ol>
|
||
<li class="">
|
||
<p>Navigate to your OpenRAG workspace directory:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">cd openrag-workspace</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Upgrade the OpenRAG package:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uvx --from openrag openrag</span><br></span></code></pre></div></div>
|
||
<p>To upgrade to a specific version:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uvx --from openrag==0.1.33 openrag</span><br></span></code></pre></div></div>
|
||
</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Use these steps to upgrade the Python package if you installed OpenRAG in a Python project with <code>uv add</code>:</p><ol>
|
||
<li class="">
|
||
<p>Navigate to your project directory:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">cd YOUR_PROJECT_NAME</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Update OpenRAG to the latest version:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv add --upgrade openrag</span><br></span></code></pre></div></div>
|
||
<p>To upgrade to a specific version:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv add --upgrade openrag==0.1.33</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Start the OpenRAG TUI:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv run openrag</span><br></span></code></pre></div></div>
|
||
</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Use these steps to upgrade the Python package if you installed OpenRAG in a venv with <code>uv pip install</code>:</p><ol>
|
||
<li class="">
|
||
<p>Activate your virtual environment.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Upgrade OpenRAG:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv pip install --upgrade openrag</span><br></span></code></pre></div></div>
|
||
<p>To upgrade to a specific version:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv pip install --upgrade openrag==0.1.33</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Start the OpenRAG TUI:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv run openrag</span><br></span></code></pre></div></div>
|
||
</li>
|
||
</ol></div></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Start the upgraded OpenRAG containers: In the OpenRAG TUI, click <strong>Start All Services</strong>, and then wait while the containers start.</p>
|
||
<p>After upgrading the Python package, OpenRAG runs <code>docker compose pull</code> to get the appropriate container images matching the version specified in your OpenRAG <code>.env</code> file. Then, it recreates the containers with the new images using <code>docker compose up -d --force-recreate</code>.</p>
|
||
<p>In the <code>.env</code> file, the <code>OPENRAG_VERSION</code> <a class="" href="/reference/configuration#system-settings">environment variable</a> is set to <code>latest</code> by default, which it pulls the <code>latest</code> available container images.
|
||
To pin a specific container image version, you can set <code>OPENRAG_VERSION</code> to the desired container image version, such as <code>OPENRAG_VERSION=0.1.33</code>.</p>
|
||
<p>However, when you upgrade the Python package, OpenRAG automatically attempts to keep the <code>OPENRAG_VERSION</code> synchronized with the Python package version.
|
||
You might need to edit the <code>.env</code> file after upgrading the Python package to enforce a different container version.
|
||
The TUI warns you if it detects a version mismatch.</p>
|
||
<p>If you get an error that <code>langflow container already exists</code> error during upgrade, see <a class="" href="/support/troubleshoot#langflow-container-already-exists-during-upgrade">Langflow container already exists during upgrade</a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>When the upgrade process is complete, you can close the <strong>Status</strong> window and continue using OpenRAG.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="reinstall">Reinstall OpenRAG<a href="#reinstall" class="hash-link" aria-label="Direct link to Reinstall OpenRAG" title="Direct link to Reinstall OpenRAG" translate="no"></a></h2>
|
||
<p>Reset your OpenRAG deployment by recreating the containers and, optionally, removing related data:</p>
|
||
<ol>
|
||
<li class="">
|
||
<p>In the TUI, <a href="#reset-containers" class="">reset your containers</a> to destroy the following:</p>
|
||
<ul>
|
||
<li class="">All existing OpenRAG containers, volumes, and local images</li>
|
||
<li class="">Any additional Docker objects</li>
|
||
<li class="">The contents of OpenRAG's <code>config</code> and <code>./opensearch-data</code> directories</li>
|
||
<li class="">The <code>conversations.json</code> file</li>
|
||
</ul>
|
||
</li>
|
||
<li class="">
|
||
<p>Optional: Remove data that wasn't deleted by the <strong>Factory Reset</strong> operation. For a completely fresh installation, delete all of this data.</p>
|
||
<ul>
|
||
<li class=""><strong>OpenRAG's <code>.env</code> file</strong>: Contains your OpenRAG configuration, including OpenRAG passwords, API keys, OAuth settings, and other <a class="" href="/reference/configuration">environment variables</a>. If you delete this file, you must either repeat the <a href="#setup" class="">setup process</a> to create a new <code>.env</code> file, or add a populated <code>.env</code> file to your OpenRAG installation directory before restarting OpenRAG.</li>
|
||
<li class=""><strong>The contents of the <code>./openrag-documents</code> directory</strong>: Contains documents that you uploaded to OpenRAG. Delete these files to prevent documents from being reingested to your knowledge base after restarting OpenRAG. However, you might want to preserve OpenRAG's <a href="https://github.com/langflow-ai/openrag/tree/main/openrag-documents" target="_blank" rel="noopener noreferrer" class="">default documents</a>.</li>
|
||
</ul>
|
||
</li>
|
||
<li class="">
|
||
<p>In the TUI <strong>Setup</strong> menu, repeat the <a href="#setup" class="">setup process</a> to configure OpenRAG, restart the services, and launch the OpenRAG app, and repeat <a href="#application-onboarding" class="">application onboarding</a>.
|
||
If OpenRAG detects a <code>.env</code> file, it automatically populates any OpenRAG passwords, OAuth credentials, and onboarding configuration set in that file.</p>
|
||
</li>
|
||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/get-started/install.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/quickstart"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Quickstart</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docker"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Install OpenRAG containers</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#install" class="table-of-contents__link toc-highlight">Install OpenRAG</a></li><li><a href="#setup" class="table-of-contents__link toc-highlight">Set up OpenRAG with the TUI</a></li><li><a href="#application-onboarding" class="table-of-contents__link toc-highlight">Application onboarding</a></li><li><a href="#exit-the-openrag-tui" class="table-of-contents__link toc-highlight">Exit the OpenRAG TUI</a></li><li><a href="#tui-container-management" class="table-of-contents__link toc-highlight">Manage OpenRAG containers with the TUI</a><ul><li><a href="#diagnostics" class="table-of-contents__link toc-highlight">Diagnostics</a></li><li><a href="#status" class="table-of-contents__link toc-highlight">Status</a></li><li><a href="#reset-containers" class="table-of-contents__link toc-highlight">Reset containers</a></li><li><a href="#start-all-services" class="table-of-contents__link toc-highlight">Start all services</a></li></ul></li><li><a href="#upgrade" class="table-of-contents__link toc-highlight">Upgrade OpenRAG</a></li><li><a href="#reinstall" class="table-of-contents__link toc-highlight">Reinstall OpenRAG</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
|
||
<span>© 2025 OpenRAG</span>
|
||
</div></li></ul></div></div></div></footer></div>
|
||
</body>
|
||
</html> |