150 lines
No EOL
28 KiB
HTML
150 lines
No EOL
28 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.8.1">
|
||
<title data-rh="true">Install OpenRAG | 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 | OpenRAG"><meta data-rh="true" name="description" content="Install the OpenRAG Python wheel, 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 the OpenRAG Python wheel, 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","item":"https://docs.openr.ag/install"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||
<script src="/assets/js/runtime~main.c8893f6b.js" defer="defer"></script>
|
||
<script src="/assets/js/main.62f384a6.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg xmlns="http://www.w3.org/2000/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="light";var e=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",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),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-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/">Get Started</a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/">About OpenRAG</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/install">Install OpenRAG</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/get-started/docker">Deploy with Docker</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/quickstart">Quickstart</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/get-started/tui">Terminal User Interface (TUI)</a></li></ul></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="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/agents">Core components</a></div></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="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/reference/configuration">Reference</a></div></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="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/support/troubleshoot">Support</a></div></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"><span class="breadcrumbs__link">Get Started</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Install OpenRAG</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</h1></header><p><a href="#install-python-wheel">Install the OpenRAG Python wheel</a>, and then run the <a href="#setup">OpenRAG Terminal User Interface(TUI)</a> to start your OpenRAG deployment with a guided setup process.</p>
|
||
<p>If you prefer running Docker commands and manually editing <code>.env</code> files, see <a href="/get-started/docker">Deploy with Docker</a>.</p>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="prerequisites">Prerequisites<a href="#prerequisites" class="hash-link" aria-label="Direct link to Prerequisites" title="Direct link to Prerequisites"></a></h2>
|
||
<ul>
|
||
<li><a href="https://www.python.org/downloads/release/python-3100/" target="_blank" rel="noopener noreferrer">Python Version 3.10 to 3.13</a></li>
|
||
<li><a href="https://docs.astral.sh/uv/getting-started/installation/" target="_blank" rel="noopener noreferrer">uv</a></li>
|
||
<li><a href="https://podman.io/docs/installation" target="_blank" rel="noopener noreferrer">Podman</a> (recommended) or <a href="https://docs.docker.com/get-docker/" target="_blank" rel="noopener noreferrer">Docker</a> installed</li>
|
||
<li><a href="https://docs.docker.com/compose/install/" target="_blank" rel="noopener noreferrer">Docker Compose</a> installed. If using Podman, use <a href="https://docs.podman.io/en/latest/markdown/podman-compose.1.html" target="_blank" rel="noopener noreferrer">podman-compose</a> or alias Docker compose commands to Podman commands.</li>
|
||
<li>Create an <a href="https://platform.openai.com/api-keys" target="_blank" rel="noopener noreferrer">OpenAI API key</a>. This key is <strong>required</strong> to start OpenRAG, but you can choose a different model provider during <a href="#application-onboarding">Application Onboarding</a>.</li>
|
||
<li>Optional: GPU support requires an NVIDIA GPU with <a href="https://docs.nvidia.com/cuda/" target="_blank" rel="noopener noreferrer">CUDA</a> support and compatible NVIDIA drivers installed on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment.</li>
|
||
</ul>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="install-python-wheel">Install the OpenRAG Python wheel<a href="#install-python-wheel" class="hash-link" aria-label="Direct link to Install the OpenRAG Python wheel" title="Direct link to Install the OpenRAG Python wheel"></a></h2>
|
||
<div class="theme-admonition theme-admonition-important 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>important</div><div class="admonitionContent_BuS1"><p>The <code>.whl</code> file is currently available as an internal download during public preview, and will be published to PyPI in a future release.</p></div></div>
|
||
<p>The OpenRAG wheel installs the Terminal User Interface (TUI) for configuring and running OpenRAG.</p>
|
||
<ol>
|
||
<li>
|
||
<p>Create a new project with a virtual environment using <code>uv init</code>.</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.
|
||
For more information on virtual environments, see the <a href="https://docs.astral.sh/uv/pip/environments" target="_blank" rel="noopener noreferrer">uv documentation</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p>Add the local OpenRAG wheel to your project's 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 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>
|
||
<p>For example, if your <code>.whl</code> file is in the <code>~/Downloads</code> directory, the command is <code>uv add ~/Downloads/openrag-0.1.8-py3-none-any.whl</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p>Ensure all dependencies are installed and updated in your 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 sync</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li>
|
||
<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>
|
||
<li>
|
||
<p>Continue with <a href="#setup">Setup OpenRAG with the TUI</a>.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" 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"></a></h2>
|
||
<p>The TUI creates a <code>.env</code> file in your OpenRAG directory root and starts OpenRAG.
|
||
If the TUI detects a <code>.env</code> file in the OpenRAG root directory, it sources any variables from the <code>.env</code> file.
|
||
If the TUI detects OAuth credentials, it enforces the <strong>Advanced Setup</strong> path.</p>
|
||
<p><strong>Basic Setup</strong> generates all of the required values for OpenRAG except the OpenAI API key.
|
||
<strong>Basic Setup</strong> does not set up OAuth connections for ingestion from cloud providers.
|
||
For OAuth setup, use <strong>Advanced Setup</strong>.</p>
|
||
<p><strong>Basic Setup</strong> and <strong>Advanced Setup</strong> enforce the same authentication settings for the Langflow server, but manage document access differently. For more information, see <a href="/knowledge#auth">Authentication and document access</a>.</p>
|
||
<div class="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>To install OpenRAG with <strong>Basic Setup</strong>, click <strong>Basic Setup</strong> or press <kbd>1</kbd>.</li>
|
||
<li>Click <strong>Generate Passwords</strong> to generate passwords for OpenSearch and Langflow.</li>
|
||
<li>Paste your OpenAI API key in the OpenAI API key field.</li>
|
||
<li>Click <strong>Save Configuration</strong>.</li>
|
||
<li>To start OpenRAG, click <strong>Start Container Services</strong>.
|
||
Startup pulls container images and runs them, so it can take some time.
|
||
When startup is complete, the TUI displays the following:<!-- -->
|
||
<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>To open the OpenRAG application, click <strong>Open App</strong>.</li>
|
||
<li>Continue with <a href="#application-onboarding">Application Onboarding</a>.</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
|
||
<li>
|
||
<p>To install OpenRAG with <strong>Advanced Setup</strong>, click <strong>Advanced Setup</strong> or press <kbd>2</kbd>.</p>
|
||
</li>
|
||
<li>
|
||
<p>Click <strong>Generate Passwords</strong> to generate passwords for OpenSearch and Langflow.</p>
|
||
</li>
|
||
<li>
|
||
<p>Paste your OpenAI API key in the OpenAI API key field.</p>
|
||
</li>
|
||
<li>
|
||
<p>Add your client and secret values for Google, Azure, or AWS OAuth.
|
||
These values can be found in your OAuth provider.</p>
|
||
</li>
|
||
<li>
|
||
<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>
|
||
<p>Click <strong>Save Configuration</strong>.</p>
|
||
</li>
|
||
<li>
|
||
<p>To start OpenRAG, click <strong>Start Container 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>
|
||
<p>To open the OpenRAG application, click <strong>Open App</strong>, press <kbd>6</kbd>, or navigate to <code>http://localhost:3000</code>.
|
||
You will be presented with your provider's OAuth sign-in screen, and be redirected to the redirect URI after sign-in.
|
||
Continue with Application Onboarding.</p>
|
||
<p>Two additional variables are available for Advanced Setup:</p>
|
||
<p>The <code>LANGFLOW_PUBLIC_URL</code> controls where the Langflow web interface can be accessed. This is where users interact with their flows in a browser.</p>
|
||
<p>The <code>WEBHOOK_BASE_URL</code> controls where the endpoint for <code>/connectors/CONNECTOR_TYPE/webhook</code> will be available.
|
||
This connection enables real-time document synchronization with external services.
|
||
For example, for Google Drive file synchronization the webhook URL is <code>/connectors/google_drive/webhook</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p>Continue with <a href="#application-onboarding">Application Onboarding</a>.</p>
|
||
</li>
|
||
</ol></div></div></div>
|
||
<h2 class="anchor anchorWithStickyNavbar_LWe7" 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"></a></h2>
|
||
<p>The first time you start OpenRAG, whether using the TUI or a <code>.env</code> file, you must complete application onboarding.</p>
|
||
<p>Most values from onboarding can be changed later in the OpenRAG <strong>Settings</strong> page, but there are important restrictions.</p>
|
||
<p>The <strong>language model provider</strong> and <strong>embeddings model provider</strong> can only be selected at onboarding, and you must use the same provider for your language model and embedding model.
|
||
To change your provider selection later, you must completely reinstall OpenRAG.</p>
|
||
<p>The <strong>language model</strong> can be changed later in <strong>Settings</strong>, but the <strong>embeddings model</strong> cannot be changed later.</p>
|
||
<div class="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">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"><ol>
|
||
<li>Enable <strong>Get API key from environment variable</strong> to automatically enter your key from the TUI-generated <code>.env</code> file.</li>
|
||
<li>Under <strong>Advanced settings</strong>, select your <strong>Embedding Model</strong> and <strong>Language Model</strong>.</li>
|
||
<li>To load 2 sample PDFs, enable <strong>Sample dataset</strong>.
|
||
This is recommended, but not required.</li>
|
||
<li>Click <strong>Complete</strong>.</li>
|
||
<li>Continue with the <a href="/quickstart">Quickstart</a>.</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
|
||
<li>Complete the fields for <strong>watsonx.ai API Endpoint</strong>, <strong>IBM API key</strong>, and <strong>IBM Project ID</strong>.
|
||
These values are found in your IBM watsonx deployment.</li>
|
||
<li>Under <strong>Advanced settings</strong>, select your <strong>Embedding Model</strong> and <strong>Language Model</strong>.</li>
|
||
<li>To load 2 sample PDFs, enable <strong>Sample dataset</strong>.
|
||
This is recommended, but not required.</li>
|
||
<li>Click <strong>Complete</strong>.</li>
|
||
<li>Continue with the <a href="/quickstart">Quickstart</a>.</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><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>Ollama is not included with OpenRAG. To install Ollama, see the <a href="https://docs.ollama.com/" target="_blank" rel="noopener noreferrer">Ollama documentation</a>.</p></div></div><ol>
|
||
<li>Enter your Ollama server's base URL address.
|
||
The default Ollama server address is <code>http://localhost:11434</code>.
|
||
OpenRAG automatically transforms <code>localhost</code> to access services outside of the container, and sends a test connection to your Ollama server to confirm connectivity.</li>
|
||
<li>Select the <strong>Embedding Model</strong> and <strong>Language Model</strong> your Ollama server is running.
|
||
OpenRAG retrieves the available models from your Ollama server.</li>
|
||
<li>To load 2 sample PDFs, enable <strong>Sample dataset</strong>.
|
||
This is recommended, but not required.</li>
|
||
<li>Click <strong>Complete</strong>.</li>
|
||
<li>Continue with the <a href="/quickstart">Quickstart</a>.</li>
|
||
</ol></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><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="/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">About OpenRAG</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/get-started/docker"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Deploy with Docker</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-python-wheel" class="table-of-contents__link toc-highlight">Install the OpenRAG Python wheel</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></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> |