370 lines
No EOL
54 KiB
HTML
370 lines
No EOL
54 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 the automatic installer script | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><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 the automatic installer script | OpenRAG"><meta data-rh="true" name="description" content="To quickly install and test OpenRAG's core features, try the quickstart."><meta data-rh="true" property="og:description" content="To quickly install and test OpenRAG's core features, try the quickstart."><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":"Run the installer script","item":"https://docs.openr.ag/install"}]}</script><script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("consent","default",{ad_storage:"denied",ad_user_data:"denied",ad_personalization:"denied",analytics_storage:"denied"})</script>
|
||
<script>!function(){function e(){if(void 0!==window.truste&&window.truste.cma){var e=window.truste.cma.callApi("getConsent",window.location.href)||{},n=1===e[2],t=1===e[3];gtag("consent","update",{ad_storage:n?"granted":"denied",ad_user_data:n?"granted":"denied",ad_personalization:n?"granted":"denied",analytics_storage:t?"granted":"denied"})}}window.addEventListener&&(window.addEventListener("cm_data_subject_consent_changed",e),window.addEventListener("cm_consent_preferences_set",e)),"complete"===document.readyState?e():window.addEventListener("load",e)}()</script>
|
||
<script>window._ibmAnalytics={settings:{name:"DataStax",tealiumProfileName:"ibm-subsidiary"},trustarc:{privacyPolicyLink:"https://ibm.com/privacy"}},window.digitalData={page:{pageInfo:{ibm:{siteId:"IBM_DataStax"}},category:{primaryCategory:"PC230"}}}</script>
|
||
<script src="//1.www.s81c.com/common/stats/ibm-common.js" async="true"></script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||
<script src="/assets/js/runtime~main.c9467c7a.js" defer="defer"></script>
|
||
<script src="/assets/js/main.990fcdce.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-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/install-options"><span title="Installation" class="categoryLinkLabel_W154">Installation</span></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="/install-options"><span title="Select an installation method" class="linkLabel_WmDU">Select an installation method</span></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"><span title="Run the installer script" class="linkLabel_WmDU">Run the installer script</span></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="/install-uv"><span title="Install OpenRAG with uv" class="linkLabel_WmDU">Install OpenRAG with uv</span></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="/install-uvx"><span title="Invoke OpenRAG with uvx" class="linkLabel_WmDU">Invoke OpenRAG with uvx</span></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="/install-windows"><span title="Install OpenRAG on Windows" class="linkLabel_WmDU">Install OpenRAG on Windows</span></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="/docker"><span title="Deploy self-managed services" class="linkLabel_WmDU">Deploy self-managed services</span></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="/upgrade"><span title="Upgrade OpenRAG" class="linkLabel_WmDU">Upgrade OpenRAG</span></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="/reinstall"><span title="Reinstall OpenRAG" class="linkLabel_WmDU">Reinstall OpenRAG</span></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="/uninstall"><span title="Remove OpenRAG" class="linkLabel_WmDU">Remove OpenRAG</span></a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tui"><span title="Use the TUI" class="linkLabel_WmDU">Use the 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="/manage-services"><span title="Manage services" class="linkLabel_WmDU">Manage services</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/contribute"><span title="Contribute to OpenRAG" class="linkLabel_WmDU">Contribute to 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="/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"><span class="breadcrumbs__link">Installation</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Run the installer script</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 the automatic installer script</h1></header><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>To quickly install and test OpenRAG's core features, try the <a class="" href="/quickstart">quickstart</a>.</p></div></div>
|
||
<p>The installer script installs <code>uv</code>, Docker or Podman, Docker Compose, and OpenRAG.
|
||
Then, it installs and runs OpenRAG with <code>uvx</code>.</p>
|
||
<p>When you install OpenRAG with the installer script, you will use the <a class="" href="/tui">Terminal User Interface (TUI)</a> to configure and manage your OpenRAG deployment.</p>
|
||
<p>This installation method is best for testing OpenRAG by running it outside of a Python project.
|
||
For other installation methods, see <a class="" href="/install-options">Select an installation method</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="">For Microsoft Windows, you must use the Windows Subsystem for Linux (WSL).
|
||
See <a class="" href="/install-windows">Install OpenRAG on Windows</a> before proceeding.</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="">Install <a href="https://www.python.org/downloads/release/python-3100/" target="_blank" rel="noopener noreferrer" class="">Python</a> version 3.13 or later.</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="">
|
||
<p>Gather the credentials and connection details for your preferred model providers.
|
||
You must have access to at least one language model and one embedding model.
|
||
If a provider offers both types, you can use the same provider for both models.
|
||
If a provider offers only one type, you must select two providers.</p>
|
||
<ul>
|
||
<li class="">
|
||
<p><strong>OpenAI</strong>: Create an <a href="https://platform.openai.com/api-keys" target="_blank" rel="noopener noreferrer" class="">OpenAI API key</a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>Anthropic</strong>: Create an <a href="https://www.anthropic.com/docs/api/reference" target="_blank" rel="noopener noreferrer" class="">Anthropic API key</a>.
|
||
Anthropic provides language models only; you must select an additional provider for embeddings.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>IBM watsonx.ai</strong>: Get your watsonx.ai API endpoint, IBM project ID, and IBM API key from your watsonx deployment.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>Ollama</strong>: Deploy an <a href="https://docs.ollama.com/" target="_blank" rel="noopener noreferrer" class="">Ollama instance and models</a> locally, in the cloud, or on a remote server. Then, get your Ollama server's base URL and the names of the models that you want to use.</p>
|
||
<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>OpenRAG isn't guaranteed to be compatible with all models that are available through Ollama.
|
||
For example, some models might produce unexpected results, such as JSON-formatted output instead of natural language responses, and some models aren't appropriate for the types of tasks that OpenRAG performs, such as those that generate media.</p>
|
||
<p>The OpenRAG team recommends the following models when using Ollama as your model provider:</p>
|
||
<ul>
|
||
<li class="">
|
||
<p><strong>Language models</strong>: <code>gpt-oss:20b</code> or <code>mistral-nemo:12b</code>.</p>
|
||
<p>If you choose <code>gpt-oss:20b</code>, consider using Ollama Cloud or running Ollama on a remote machine because this model requires at least 16GB of RAM.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>Embedding models</strong>: <a href="https://ollama.com/library/nomic-embed-text" target="_blank" rel="noopener noreferrer" class=""><code>nomic-embed-text:latest</code></a>, <code>mxbai-embed-large:latest</code>, or <code>embeddinggemma:latest</code>.</p>
|
||
</li>
|
||
</ul>
|
||
<p>You can experiment with other models, but if you encounter issues that you are unable to resolve through other RAG best practices (like context filters and prompt engineering), try switching to one of the recommended models.
|
||
You can submit an <a href="https://github.com/langflow-ai/openrag/issues" target="_blank" rel="noopener noreferrer" class="">OpenRAG GitHub issue</a> to request support for specific models.</p></div></div>
|
||
</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">Run the installer script<a href="#install" class="hash-link" aria-label="Direct link to Run the installer script" title="Direct link to Run the installer script" translate="no"></a></h2>
|
||
<ol>
|
||
<li class="">
|
||
<p>Create a directory to store your OpenRAG configuration files and data, and then change to that 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 function" style="color:#d73a49">mkdir</span><span class="token plain"> openrag-workspace</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token builtin class-name">cd</span><span class="token plain"> openrag-workspace</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Get and run the installer script:</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 function" style="color:#d73a49">curl</span><span class="token plain"> </span><span class="token parameter variable" style="color:#36acaa">-fsSL</span><span class="token plain"> https://docs.openr.ag/files/run_openrag_with_prereqs.sh </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">bash</span><br></span></code></pre></div></div>
|
||
<p>The installer script installs OpenRAG with <a href="https://docs.astral.sh/uv/guides/tools/#running-tools" target="_blank" rel="noopener noreferrer" class=""><code>uvx</code></a> in the directory where you run the script.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Wait while the installer script prepares your environment and installs OpenRAG.
|
||
You might be prompted to install certain dependencies if they aren't already present in your environment.</p>
|
||
<p>The entire process can take a few minutes.
|
||
Once the environment is ready, the OpenRAG TUI starts.</p>
|
||
<p><img decoding="async" loading="lazy" alt="OpenRAG TUI Interface" src="/assets/images/openrag_tui_dec_2025-c7022e66cc6675f25aced7b8acd8274d.png" width="653" height="397" class="img_ev3q"></p>
|
||
<p>Because the installer script uses <code>uvx</code>, it creates a cached, ephemeral environment in your local <code>uv</code> cache, and your OpenRAG configuration files and data are stored separately from the <code>uv</code> cache.
|
||
Clearing the cache doesn't delete your entire OpenRAG installation, only the temporary TUI environment.
|
||
After clearing the cache, run <code>uvx openrag</code> to <a class="" href="/tui">access the TUI</a> and continue with your preserved configuration and data.</p>
|
||
</li>
|
||
</ol>
|
||
<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>When you install OpenRAG with the installer script, you manage the OpenRAG services with the TUI.
|
||
The TUI guides you through the initial configuration process before you start the OpenRAG services.</p>
|
||
<p>Your configuration values are stored in an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> that is created automatically at <code>~/.openrag/tui</code>.
|
||
If OpenRAG detects an existing <code>.env</code> file in this directory, then the TUI can populate those values automatically during setup and onboarding.</p>
|
||
<p>Container definitions are stored in the <code>docker-compose</code> files in the same directory as the OpenRAG <code>.env</code> file.</p>
|
||
<p>You can use either <strong>Basic Setup</strong> or <strong>Advanced Setup</strong> to configure OpenRAG.
|
||
This choice determines how OpenRAG authenticates with your deployment's <a class="" href="/knowledge">OpenSearch instance</a>, and it controls user access to documents stored in your OpenSearch knowledge base:</p>
|
||
<ul>
|
||
<li class="">
|
||
<p><strong>No-auth mode</strong>: If you select <strong>Basic Setup</strong> in the <a class="" href="/tui">TUI</a>, or your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> doesn't include OAuth credentials, then the OpenRAG OpenSearch instance runs in no-auth mode.</p>
|
||
<p>This mode uses one anonymous JWT token for OpenSearch authentication.
|
||
There is no differentiation between users; all users that access your OpenRAG instance can access all documents uploaded to your knowledge base.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>OAuth mode</strong>: If you select <strong>Advanced Setup</strong> in the <a class="" href="/tui">TUI</a>, or your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> includes OAuth credentials, then the OpenRAG OpenSearch instance runs in OAuth mode.</p>
|
||
<p>This mode uses a unique JWT token for each OpenRAG user, and each document is tagged with user ownership.
|
||
Documents are filtered by user owner; users see only the documents that they uploaded or have access to through their cloud storage accounts.</p>
|
||
<p>To enable OAuth mode after initial setup, see <a class="" href="/ingestion#oauth-ingestion">Ingest files with OAuth connectors</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<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>You must use <strong>Advanced Setup</strong> if you want to <a class="" href="/ingestion#oauth-ingestion">use OAuth connectors to upload documents from cloud storage</a>.</p></div></div>
|
||
<p>If OpenRAG detects OAuth credentials during setup, it recommends <strong>Advanced Setup</strong> in the TUI.</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>In the TUI, select <strong>Basic Setup</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services.</p>
|
||
<p>The OpenSearch password is required, and a secure password is automatically generated if you don't provide one manually.</p>
|
||
<p>The Langflow password is recommended but optional.
|
||
If the Langflow password is empty, the Langflow server starts without authentication enabled. For more information, see <a class="" href="/reference/configuration#langflow-settings">Langflow settings</a>.</p>
|
||
<p>You can click <strong>Generate Password</strong> to create a Langflow password and username automatically.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Optional: Under <strong>API Keys</strong>, enter your model provider credentials, or leave these fields empty if you want to configure model provider credentials during the application onboarding process.</p>
|
||
<p>There is no material difference between providing these values now or during the <a href="#application-onboarding" class="">application onboarding process</a>.
|
||
If you provide a credential now, it can be populated automatically during the application onboarding process if you enable the <strong>Use environment API key</strong> option.</p>
|
||
<p>OpenRAG's core functionality requires access to language and embedding models.
|
||
By default, OpenRAG uses OpenAI models.
|
||
If you aren't sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG's default model configuration.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Optional: Under <strong>Others</strong>, edit the <a class="" href="/knowledge">knowledge base</a> paths if you don't want to use the default paths:</p>
|
||
<ul>
|
||
<li class=""><strong>Documents Paths</strong>: One or more paths to directories are where OpenRAG looks for documents to ingest.</li>
|
||
<li class=""><strong>OpenSearch Data Path</strong>: Specify the path where you want OpenRAG to create your OpenSearch index.</li>
|
||
</ul>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Save Configuration</strong>.</p>
|
||
<p>Your passwords and API keys, if provided, are stored in the <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> at <code>~/.openrag/tui</code>.
|
||
If you modified any credentials that were pulled from an existing <code>.env</code> file, those values are updated in the <code>.env</code> file.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Start OpenRAG</strong> to start the OpenRAG services.</p>
|
||
<p>This process can take some time while OpenRAG pulls and runs the container images.
|
||
If all services start successfully, the TUI prints a confirmation message:</p>
|
||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text 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>Click <strong>Close</strong>, and then click <strong>Launch OpenRAG</strong> or navigate to <code>localhost:3000</code> in your browser.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p>
|
||
</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
|
||
<li class="">
|
||
<p>In the TUI, select <strong>Advanced Setup</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services.</p>
|
||
<p>The OpenSearch password is required, and a secure password is automatically generated if you don't provide one manually.</p>
|
||
<p>The Langflow password is recommended but optional.
|
||
If the Langflow password is empty, the Langflow server starts without authentication enabled. For more information, see <a class="" href="/reference/configuration#langflow-settings">Langflow settings</a>.</p>
|
||
<p>You can click <strong>Generate Password</strong> to create a Langflow password and username automatically.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Optional: Under <strong>API Keys</strong>, enter your model provider credentials, or leave the <strong>OpenAI</strong>, <strong>Anthropic</strong>, <strong>Ollama</strong>, and <strong>IBM watsonx.ai</strong> fields empty if you want to configure model provider credentials during the application onboarding process.</p>
|
||
<p>There is no material difference between providing these values now or during the <a href="#application-onboarding" class="">application onboarding process</a>.
|
||
If you provide a credential now, it can be populated automatically during the application onboarding process if you enable the <strong>Use environment API key</strong> option.</p>
|
||
<p>OpenRAG's core functionality requires access to language and embedding models.
|
||
By default, OpenRAG uses OpenAI models.
|
||
If you aren't sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG's default model configuration.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Recommended: To upload documents from external storage, such as Google Drive, add the required OAuth credentials for the connectors that you want to use under <strong>API Keys</strong>. These settings can be populated automatically if OpenRAG detects these credentials in an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> at <code>~/.openrag/tui</code>.</p>
|
||
<ul>
|
||
<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>
|
||
<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>
|
||
</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>Register the redirect URIs shown in the TUI in your OAuth provider.
|
||
These are the URLs your OAuth provider will use to redirect users back to OpenRAG after they sign in.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Optional: Under <strong>Others</strong>, you can edit the following settings if needed:</p>
|
||
<ul>
|
||
<li class=""><strong>Documents Paths</strong>: Use the default path or provide one or more paths to directories are where OpenRAG looks for documents to ingest in to your <a class="" href="/knowledge">knowledge base</a>.</li>
|
||
<li class=""><strong>OpenSearch Data Path</strong>: Specify the path where you want OpenRAG to create your OpenSearch index.</li>
|
||
<li class=""><strong>Langflow Public URL (<code>LANGFLOW_PUBLIC_URL</code>)</strong> : Sets the base address to access the Langflow web interface. This is where users interact with flows in a browser.</li>
|
||
<li class=""><strong>Webhook Base URL (<code>WEBHOOK_BASE_URL</code>)</strong>: If applicable, set the base address for your OAuth connector endpoints. If set, the OAuth connector webhook URLs are constructed as <code>WEBHOOK_BASE_URL/connectors/${provider}/webhook</code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Save Configuration</strong>.</p>
|
||
<p>Your passwords, API key, and OAuth credentials, if provided, are stored in the <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> at <code>~/.openrag/tui</code>.
|
||
If you modified any credentials that were pulled from an existing <code>.env</code> file, those values are updated in the <code>.env</code> file.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Start OpenRAG</strong> to start the OpenRAG services.</p>
|
||
<p>This process can take some time while OpenRAG pulls and runs the container images.
|
||
If all services start successfully, the TUI prints a confirmation message:</p>
|
||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text 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>Click <strong>Close</strong>, and then click <strong>Launch OpenRAG</strong> or navigate to <code>localhost:3000</code> in your browser.</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>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p>
|
||
</li>
|
||
</ol></div></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="application-onboarding">Complete the application onboarding process<a href="#application-onboarding" class="hash-link" aria-label="Direct link to Complete the application onboarding process" title="Direct link to Complete the application onboarding process" translate="no"></a></h2>
|
||
<p>The first time you start the OpenRAG application, you must complete the application onboarding process to select language and embedding models that are essential for OpenRAG features like the <a class="" href="/chat"><strong>Chat</strong></a>.</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 the <a class="" href="/reference/configuration">OpenRAG environment variables reference</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 embedding 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">IBM watsonx.ai</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Ollama</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">OpenAI (default)</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 the embedding model.</p></div></div><ol>
|
||
<li class="">
|
||
<p>Enter your Anthropic API key, or enable <strong>Use environment API key</strong> to pull the key from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Complete</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Select a provider for embeddings, provide the required information, and then select the embedding model you want to use.
|
||
For information about another provider's credentials and settings, see the instructions for that provider.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Complete</strong>.</p>
|
||
<p>After you configure the embedding model, OpenRAG uses your credentials and models to ingest some <a class="" href="/knowledge#default-documents">initial documents</a>. This tests the connection, and it allows you to ask OpenRAG about itself in the <a class="" href="/chat"><strong>Chat</strong></a>.
|
||
If there is a problem with the model configuration, an error occurs and you are redirected back to the application onboarding screen.
|
||
Verify that the credential is valid and has access to the selected model, and then click <strong>Complete</strong> to retry ingestion.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Continue through the overview slides for a brief introduction to OpenRAG, or 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>.
|
||
The overview demonstrates some basic functionality that is covered in the <a class="" href="/quickstart#chat-with-documents">quickstart</a> and in other parts of the OpenRAG documentation.</p>
|
||
</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
|
||
<li class="">
|
||
<p>For <strong>watsonx.ai API Endpoint</strong>, select the base URL for your watsonx.ai model deployment.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Enter your watsonx.ai deployment's project ID and API key.</p>
|
||
<p>You can enable <strong>Use environment API key</strong> to pull the key from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Complete</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Select a provider for embeddings, provide the required information, and then select the embedding model you want to use.
|
||
For information about another provider's credentials and settings, see the instructions for that provider.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Complete</strong>.</p>
|
||
<p>After you configure the embedding model, OpenRAG uses your credentials and models to ingest some <a class="" href="/knowledge#default-documents">initial documents</a>. This tests the connection, and it allows you to ask OpenRAG about itself in the <a class="" href="/chat"><strong>Chat</strong></a>.
|
||
If there is a problem with the model configuration, an error occurs and you are redirected back to the application onboarding screen.
|
||
Verify that the credentials are valid and have access to the selected model, and then click <strong>Complete</strong> to retry ingestion.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Continue through the overview slides for a brief introduction to OpenRAG, or 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>.
|
||
The overview demonstrates some basic functionality that is covered in the <a class="" href="/quickstart#chat-with-documents">quickstart</a> and in other parts of the OpenRAG documentation.</p>
|
||
</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Using Ollama as your language and embedding model provider offers greater flexibility and configuration options for hosting models.
|
||
However, it requires additional setup because Ollama isn't included with OpenRAG.
|
||
You must deploy Ollama separately if you want to use Ollama as a model provider.</p><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>OpenRAG isn't guaranteed to be compatible with all models that are available through Ollama.
|
||
For example, some models might produce unexpected results, such as JSON-formatted output instead of natural language responses, and some models aren't appropriate for the types of tasks that OpenRAG performs, such as those that generate media.</p>
|
||
<p>The OpenRAG team recommends the following models when using Ollama as your model provider:</p>
|
||
<ul>
|
||
<li class="">
|
||
<p><strong>Language models</strong>: <code>gpt-oss:20b</code> or <code>mistral-nemo:12b</code>.</p>
|
||
<p>If you choose <code>gpt-oss:20b</code>, consider using Ollama Cloud or running Ollama on a remote machine because this model requires at least 16GB of RAM.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>Embedding models</strong>: <a href="https://ollama.com/library/nomic-embed-text" target="_blank" rel="noopener noreferrer" class=""><code>nomic-embed-text:latest</code></a>, <code>mxbai-embed-large:latest</code>, or <code>embeddinggemma:latest</code>.</p>
|
||
</li>
|
||
</ul>
|
||
<p>You can experiment with other models, but if you encounter issues that you are unable to resolve through other RAG best practices (like context filters and prompt engineering), try switching to one of the recommended models.
|
||
You can submit an <a href="https://github.com/langflow-ai/openrag/issues" target="_blank" rel="noopener noreferrer" class="">OpenRAG GitHub issue</a> to request support for specific models.</p></div></div><ol>
|
||
<li class="">
|
||
<p><a href="https://docs.ollama.com/" target="_blank" rel="noopener noreferrer" class="">Install Ollama locally or on a remote server</a>, or <a href="https://docs.ollama.com/cloud" target="_blank" rel="noopener noreferrer" class="">run models in Ollama Cloud</a>.</p>
|
||
<p>If you are running a remote server, it must be accessible from your OpenRAG deployment.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>In the OpenRAG onboarding dialog, enter your Ollama server's base URL:</p>
|
||
<ul>
|
||
<li class=""><strong>Local Ollama server</strong>: Enter your Ollama server's base URL and port. The default Ollama server address is <code>http://localhost:11434</code>.</li>
|
||
<li class=""><strong>Ollama Cloud</strong>: Because Ollama Cloud models run at the same address as a local Ollama server and automatically offload to Ollama's cloud service, you can use the same base URL and port as you would for a local Ollama server. The default address is <code>http://localhost:11434</code>.</li>
|
||
<li class=""><strong>Remote server</strong>: Enter your remote Ollama server's base URL and port, such as <code>http://your-remote-server:11434</code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li class="">
|
||
<p>Select the language model that your Ollama server is running.</p>
|
||
<p>If your server isn't running any language models, you must either deploy a language model on your Ollama server, or use another provider for the language model.</p>
|
||
<p>Language model and embedding model selections are independent.
|
||
You can use the same or different servers for each model.</p>
|
||
<p>To use different providers for each model, you must configure both providers, and select the relevant model for each provider.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Complete</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Select a provider for embeddings, provide the required information, and then select the embedding model you want to use.
|
||
For information about another provider's credentials and settings, see the instructions for that provider.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Complete</strong>.</p>
|
||
<p>After you configure the embedding model, OpenRAG uses your credentials and models to ingest some <a class="" href="/knowledge#default-documents">initial documents</a>. This tests the connection, and it allows you to ask OpenRAG about itself in the <a class="" href="/chat"><strong>Chat</strong></a>.
|
||
If there is a problem with the model configuration, an error occurs and you are redirected back to the application onboarding screen.
|
||
Verify that the server address is valid, and that the selected model is running on the server.
|
||
Then, click <strong>Complete</strong> to retry ingestion.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Continue through the overview slides for a brief introduction to OpenRAG, or 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>.
|
||
The overview demonstrates some basic functionality that is covered in the <a class="" href="/quickstart#chat-with-documents">quickstart</a> and in other parts of the OpenRAG documentation.</p>
|
||
</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
|
||
<li class="">
|
||
<p>Enter your OpenAI API key, or enable <strong>Use environment API key</strong> to pull the key from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Complete</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Select a provider for embeddings, provide the required information, and then select the embedding model you want to use.
|
||
For information about another provider's credentials and settings, see the instructions for that provider.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Click <strong>Complete</strong>.</p>
|
||
<p>After you configure the embedding model, OpenRAG uses your credentials and models to ingest some <a class="" href="/knowledge#default-documents">initial documents</a>. This tests the connection, and it allows you to ask OpenRAG about itself in the <a class="" href="/chat"><strong>Chat</strong></a>.
|
||
If there is a problem with the model configuration, an error occurs and you are redirected back to the application onboarding screen.
|
||
Verify that the credential is valid and has access to the selected model, and then click <strong>Complete</strong> to retry ingestion.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Continue through the overview slides for a brief introduction to OpenRAG, or 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>.
|
||
The overview demonstrates some basic functionality that is covered in the <a class="" href="/quickstart#chat-with-documents">quickstart</a> and in other parts of the OpenRAG documentation.</p>
|
||
</li>
|
||
</ol></div></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="next-steps">Next steps<a href="#next-steps" class="hash-link" aria-label="Direct link to Next steps" title="Direct link to Next steps" translate="no"></a></h2>
|
||
<ul>
|
||
<li class="">Try some of OpenRAG's core features in the <a class="" href="/quickstart#chat-with-documents">quickstart</a>.</li>
|
||
<li class="">Learn how to <a class="" href="/manage-services">manage OpenRAG services</a>.</li>
|
||
<li class=""><a class="" href="/ingestion">Upload documents</a>, and then use the <a class="" href="/chat"><strong>Chat</strong></a> to explore your data.</li>
|
||
</ul></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="/install-options"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Select an installation method</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/install-uv"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Install OpenRAG with uv</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">Run the installer script</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">Complete the application onboarding process</a></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next steps</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>© 2026 OpenRAG</span>
|
||
<span id="preferenceCenterContainer"> · <a href="#" onclick='return"undefined"!=typeof window&&window.truste&&window.truste.eu&&window.truste.eu.clickListener&&window.truste.eu.clickListener(),!1' style="cursor: pointer;">Manage Privacy Choices</a></span>
|
||
</div></li></ul></div></div></div></footer></div>
|
||
</body>
|
||
</html> |