This commit is contained in:
aimurphy 2025-12-19 16:26:54 +00:00
parent 75aee6a357
commit a7c17beb06
50 changed files with 306 additions and 797 deletions

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">OpenRAG</title><meta data-rh="true" property="og:title" content="OpenRAG"><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/404.html"><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"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/404.html"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/404.html" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">OpenRAG</title><meta data-rh="true" property="og:title" content="OpenRAG"><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/404.html"><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"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/404.html"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/404.html" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Use Langflow in 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/agents"><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="Use Langflow in OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG includes a built-in Langflow instance for creating and managing functional application workflows called flows."><meta data-rh="true" property="og:description" content="OpenRAG includes a built-in Langflow instance for creating and managing functional application workflows called flows."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/agents"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/agents" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/agents" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Flows","item":"https://docs.openr.ag/agents"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Use Langflow in 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/agents"><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="Use Langflow in OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG includes a built-in Langflow instance for creating and managing functional application workflows called flows."><meta data-rh="true" property="og:description" content="OpenRAG includes a built-in Langflow instance for creating and managing functional application workflows called flows."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/agents"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/agents" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/agents" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Flows","item":"https://docs.openr.ag/agents"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -1 +0,0 @@
"use strict";(globalThis.webpackChunkopenrag_docs=globalThis.webpackChunkopenrag_docs||[]).push([[961],{5689:(e,n,t)=>{t.d(n,{A:()=>s});const s=t.p+"assets/images/OpenRAG_TUI_2025-09-10T13_04_11_757637-9441c53ba39162a88ac6c11cbeaed0e0.svg"},6239:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>a,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"get-started/tui","title":"Use the TUI","description":"The OpenRAG Terminal User Interface (TUI) provides a simplified and guided experience for configuring, managing, and monitoring your OpenRAG deployment directly from the terminal.","source":"@site/docs/get-started/tui.mdx","sourceDirName":"get-started","slug":"/tui","permalink":"/tui","draft":false,"unlisted":false,"editUrl":"https://github.com/openrag/openrag/tree/main/docs/docs/get-started/tui.mdx","tags":[],"version":"current","frontMatter":{"title":"Use the TUI","slug":"/tui"},"sidebar":"tutorialSidebar","previous":{"title":"Remove OpenRAG","permalink":"/uninstall"},"next":{"title":"Manage services","permalink":"/manage-services"}}');var i=t(4848),r=t(8453);const a={title:"Use the TUI",slug:"/tui"},c=void 0,o={},d=[{value:"Access the TUI",id:"access-the-tui",level:2},{value:"Manage services with the TUI",id:"manage-services-with-the-tui",level:2},{value:"Exit the OpenRAG TUI",id:"exit-the-openrag-tui",level:2}];function l(e){const n={a:"a",code:"code",h2:"h2",img:"img",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.p,{children:"The OpenRAG Terminal User Interface (TUI) provides a simplified and guided experience for configuring, managing, and monitoring your OpenRAG deployment directly from the terminal."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"OpenRAG TUI Interface",src:t(5689).A+"",width:"1995",height:"1099"})}),"\n",(0,i.jsxs)(n.p,{children:["If you install OpenRAG with the ",(0,i.jsx)(n.a,{href:"/install",children:"automatic installer script"}),", ",(0,i.jsx)(n.a,{href:"/install-uv",children:(0,i.jsx)(n.code,{children:"uv"})}),", or ",(0,i.jsx)(n.a,{href:"/install-uvx",children:(0,i.jsx)(n.code,{children:"uvx"})}),", you use the TUI to manage your OpenRAG deployment.\nThe TUI guides you through the initial setup, automatically manages your OpenRAG ",(0,i.jsx)(n.code,{children:".env"})," and ",(0,i.jsx)(n.code,{children:"docker-compose"})," files, and provides convenient access to ",(0,i.jsx)(n.a,{href:"/manage-services",children:"service management"})," controls."]}),"\n",(0,i.jsxs)(n.p,{children:["In contrast, when you ",(0,i.jsx)(n.a,{href:"/docker",children:"deploy OpenRAG with self-managed services"}),", you must manually configure OpenRAG by preparing a ",(0,i.jsx)(n.code,{children:".env"})," file, and then use Docker or Podman commands to deploy and manage your OpenRAG services."]}),"\n",(0,i.jsx)(n.h2,{id:"access-the-tui",children:"Access the TUI"}),"\n",(0,i.jsxs)(n.p,{children:["If you installed OpenRAG with ",(0,i.jsx)(n.code,{children:"uv"}),", access the TUI with ",(0,i.jsx)(n.code,{children:"uv run openrag"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["If you installed OpenRAG with the automatic installer script or ",(0,i.jsx)(n.code,{children:"uvx"}),", access the TUI with ",(0,i.jsx)(n.code,{children:"uvx openrag"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"manage-services-with-the-tui",children:"Manage services with the TUI"}),"\n",(0,i.jsxs)(n.p,{children:["Use the TUI's ",(0,i.jsx)(n.strong,{children:"Status"})," menu (",(0,i.jsx)("kbd",{children:"3"}),") and ",(0,i.jsx)(n.strong,{children:"Diagnostics"})," menu (",(0,i.jsx)("kbd",{children:"4"}),") to access controls and information for your OpenRAG services.\nFor more information, see ",(0,i.jsx)(n.a,{href:"/manage-services",children:"Manage OpenRAG services"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"exit-the-openrag-tui",children:"Exit the OpenRAG TUI"}),"\n",(0,i.jsxs)(n.p,{children:["To exit the OpenRAG TUI, go to the TUI main menu, and then press ",(0,i.jsx)("kbd",{children:"q"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"Your OpenRAG containers continue to run until they are stopped."}),"\n",(0,i.jsxs)(n.p,{children:["To restart the TUI, see ",(0,i.jsx)(n.a,{href:"#access-the-tui",children:"Access the TUI"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>c});var s=t(6540);const i={},r=s.createContext(i);function a(e){const n=s.useContext(r);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]);

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Chat in 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/chat"><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="Chat in OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="After you upload documents to your knowledge base, you can use the OpenRAG Chat feature to interact with your knowledge through natural language queries."><meta data-rh="true" property="og:description" content="After you upload documents to your knowledge base, you can use the OpenRAG Chat feature to interact with your knowledge through natural language queries."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/chat"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/chat" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/chat" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Chat","item":"https://docs.openr.ag/chat"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Chat in 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/chat"><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="Chat in OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="After you upload documents to your knowledge base, you can use the OpenRAG Chat feature to interact with your knowledge through natural language queries."><meta data-rh="true" property="og:description" content="After you upload documents to your knowledge base, you can use the OpenRAG Chat feature to interact with your knowledge through natural language queries."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/chat"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/chat" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/chat" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Chat","item":"https://docs.openr.ag/chat"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Deploy OpenRAG with self-managed services | 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/docker"><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="Deploy OpenRAG with self-managed services | OpenRAG"><meta data-rh="true" name="description" content="To manage your own OpenRAG services, deploy OpenRAG with Docker or Podman."><meta data-rh="true" property="og:description" content="To manage your own OpenRAG services, deploy OpenRAG with Docker or Podman."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/docker"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/docker" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/docker" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Deploy self-managed services","item":"https://docs.openr.ag/docker"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Deploy OpenRAG with self-managed services | 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/docker"><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="Deploy OpenRAG with self-managed services | OpenRAG"><meta data-rh="true" name="description" content="To manage your own OpenRAG services, deploy OpenRAG with Docker or Podman."><meta data-rh="true" property="og:description" content="To manage your own OpenRAG services, deploy OpenRAG with Docker or Podman."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/docker"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/docker" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/docker" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Deploy self-managed services","item":"https://docs.openr.ag/docker"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">
@ -124,9 +124,9 @@ The following variables are required or recommended:</p>
<li class=""> <li class="">
<p><strong>OAuth provider credentials</strong>: To upload documents from external storage, such as Google Drive, set the required OAuth credentials for the connectors that you want to use. You can <a class="" href="/ingestion#oauth-ingestion">manage OAuth credentials</a> later, but it is recommended to configure them during initial set up so you don&#x27;t have to rebuild the containers.</p> <p><strong>OAuth provider credentials</strong>: To upload documents from external storage, such as Google Drive, set the required OAuth credentials for the connectors that you want to use. You can <a class="" href="/ingestion#oauth-ingestion">manage OAuth credentials</a> later, but it is recommended to configure them during initial set up so you don&#x27;t have to rebuild the containers.</p>
<ul> <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>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>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> </ul>
</li> </li>
</ul> </ul>
@ -187,8 +187,7 @@ Additionally, you can set multiple embedding models.</p>
<p>You only need to complete onboarding for your preferred providers.</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&#x27;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> <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&#x27;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=""> <li class="">
<p>Enter your Anthropic API key, or enable <strong>Get API key from environment variable</strong> to pull the key from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p> <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>
<p>If you set <code>ANTHROPIC_API_KEY</code> in your OpenRAG <code>.env</code> file, this value can be populated automatically.</p>
</li> </li>
<li class=""> <li class="">
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p> <p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>
@ -212,8 +211,11 @@ The overview demonstrates some basic functionality that is covered in the <a cla
</li> </li>
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol> </ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
<li class=""> <li class="">
<p>Use the values from your IBM watsonx deployment for the <strong>watsonx.ai API Endpoint</strong>, <strong>IBM Project ID</strong>, and <strong>IBM API key</strong> fields.</p> <p>For <strong>watsonx.ai API Endpoint</strong>, select the base URL for your watsonx.ai model deployment.</p>
<p>If you set <code>WATSONX_API_KEY</code>, <code>WATSONX_API_URL</code>, or <code>WATSONX_PROJECT_ID</code> in your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>, these values can be populated automatically.</p> </li>
<li class="">
<p>Enter your watsonx.ai deployment&#x27;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>
<li class=""> <li class="">
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p> <p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>
@ -256,23 +258,30 @@ You can submit an <a href="https://github.com/langflow-ai/openrag/issues" target
<p>If you are running a remote server, it must be accessible from your OpenRAG deployment.</p> <p>If you are running a remote server, it must be accessible from your OpenRAG deployment.</p>
</li> </li>
<li class=""> <li class="">
<p>In OpenRAG onboarding, connect to your Ollama server:</p> <p>In the OpenRAG onboarding dialog, enter your Ollama server&#x27;s base URL:</p>
<ul> <ul>
<li class=""><strong>Local Ollama server</strong>: Enter your Ollama server&#x27;s base URL and port. The default Ollama server address is <code>http://localhost:11434</code>.</li> <li class=""><strong>Local Ollama server</strong>: Enter your Ollama server&#x27;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&#x27;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>Ollama Cloud</strong>: Because Ollama Cloud models run at the same address as a local Ollama server and automatically offload to Ollama&#x27;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&#x27;s base URL and port, such as <code>http://your-remote-server:11434</code>.</li> <li class=""><strong>Remote server</strong>: Enter your remote Ollama server&#x27;s base URL and port, such as <code>http://your-remote-server:11434</code>.</li>
</ul> </ul>
<p>If the connection succeeds, OpenRAG populates the model lists with the server&#x27;s available models.</p>
</li> </li>
<li class=""> <li class="">
<p>Select the model that your Ollama server is running.</p> <p>Select the language model that your Ollama server is running.</p>
<p>If your server isn&#x27;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. <p>Language model and embedding model selections are independent.
You can use the same or different servers for each model.</p> 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> <p>To use different providers for each model, you must configure both providers, and select the relevant model for each provider.</p>
</li> </li>
<li class=""> <li class="">
<p>Click <strong>Complete</strong>.</p> <p>Click <strong>Complete</strong>.</p>
<p>After you configure the embedding model, OpenRAG uses the address 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>. </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&#x27;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. 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. 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> Then, click <strong>Complete</strong> to retry ingestion.</p>
@ -283,8 +292,7 @@ The overview demonstrates some basic functionality that is covered in the <a cla
</li> </li>
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol> </ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
<li class=""> <li class="">
<p>Enter your OpenAI API key, or enable <strong>Get API key from environment variable</strong> to pull the key from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p> <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>
<p>If you set <code>OPENAI_API_KEY</code> in your OpenRAG <code>.env</code> file, this value can be populated automatically.</p>
</li> </li>
<li class=""> <li class="">
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p> <p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">What is 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/"><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="What is OpenRAG? | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG is an open-source package for building agentic RAG systems that integrates with a wide range of orchestration tools, databases, and LLM providers."><meta data-rh="true" property="og:description" content="OpenRAG is an open-source package for building agentic RAG systems that integrates with a wide range of orchestration tools, databases, and LLM providers."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/" hreflang="x-default"><script data-rh="true">function insertBanner(){var n=document.createElement("div");n.id="__docusaurus-base-url-issue-banner-container";n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/</span> (default value)</p>\n <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n',document.body.prepend(n);var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,o="/"===s.substr(-1)?s:s+"/";e.innerHTML=o}document.addEventListener("DOMContentLoaded",function(){void 0===window.docusaurus&&insertBanner()})</script><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"About OpenRAG","item":"https://docs.openr.ag/"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">What is 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/"><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="What is OpenRAG? | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG is an open-source package for building agentic RAG systems that integrates with a wide range of orchestration tools, databases, and LLM providers."><meta data-rh="true" property="og:description" content="OpenRAG is an open-source package for building agentic RAG systems that integrates with a wide range of orchestration tools, databases, and LLM providers."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/" hreflang="x-default"><script data-rh="true">function insertBanner(){var n=document.createElement("div");n.id="__docusaurus-base-url-issue-banner-container";n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/</span> (default value)</p>\n <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n',document.body.prepend(n);var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,o="/"===s.substr(-1)?s:s+"/";e.innerHTML=o}document.addEventListener("DOMContentLoaded",function(){void 0===window.docusaurus&&insertBanner()})</script><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"About OpenRAG","item":"https://docs.openr.ag/"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Ingest knowledge | 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/ingestion"><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="Ingest knowledge | OpenRAG"><meta data-rh="true" name="description" content="Upload documents to your OpenRAG OpenSearch instance to populate your knowledge base with unique content, such as your own company documents, research papers, or websites."><meta data-rh="true" property="og:description" content="Upload documents to your OpenRAG OpenSearch instance to populate your knowledge base with unique content, such as your own company documents, research papers, or websites."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/ingestion"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/ingestion" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/ingestion" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Ingest knowledge","item":"https://docs.openr.ag/ingestion"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Ingest knowledge | 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/ingestion"><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="Ingest knowledge | OpenRAG"><meta data-rh="true" name="description" content="Upload documents to your OpenRAG OpenSearch instance to populate your knowledge base with unique content, such as your own company documents, research papers, or websites."><meta data-rh="true" property="og:description" content="Upload documents to your OpenRAG OpenSearch instance to populate your knowledge base with unique content, such as your own company documents, research papers, or websites."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/ingestion"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/ingestion" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/ingestion" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Ingest knowledge","item":"https://docs.openr.ag/ingestion"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">
@ -81,28 +81,28 @@ These files aren&#x27;t stored in the knowledge base permanently.</p>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="enable-oauth-connectors">Enable OAuth connectors<a href="#enable-oauth-connectors" class="hash-link" aria-label="Direct link to Enable OAuth connectors" title="Direct link to Enable OAuth connectors" translate="no"></a></h3> <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="enable-oauth-connectors">Enable OAuth connectors<a href="#enable-oauth-connectors" class="hash-link" aria-label="Direct link to Enable OAuth connectors" title="Direct link to Enable OAuth connectors" translate="no"></a></h3>
<p>Before users can connect their own cloud storage accounts, you must configure the provider&#x27;s OAuth credentials in OpenRAG. Typically, this requires that you register OpenRAG as an OAuth application in your cloud provider, and then obtain the app&#x27;s OAuth credentials, such as a client ID and secret key. <p>Before users can connect their own cloud storage accounts, you must configure the provider&#x27;s OAuth credentials in OpenRAG. Typically, this requires that you register OpenRAG as an OAuth application in your cloud provider, and then obtain the app&#x27;s OAuth credentials, such as a client ID and secret key.
To enable multiple connectors, you must register an app and generate credentials for each provider.</p> To enable multiple connectors, you must register an app and generate credentials for each provider.</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">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>If you use the <a class="" href="/tui">Terminal User Interface (TUI)</a> to manage your OpenRAG services, enter OAuth credentials in the <strong>Advanced Setup</strong> menu. <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">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>If you use the <a class="" href="/tui">Terminal User Interface (TUI)</a> to manage your OpenRAG services, enter OAuth credentials on the <strong>Advanced Setup</strong> page.
You can do this during <a class="" href="/install#setup">installation</a>, or you can add the credentials afterwards:</p><ol> You can do this during <a class="" href="/install#setup">installation</a>, or you can add the credentials afterwards:</p><ol>
<li class=""> <li class="">
<p>If OpenRAG is running, open the TUI&#x27;s <strong>Status</strong> menu (<kbd>3</kbd>), and then click <strong>Stop Services</strong>.</p> <p>If OpenRAG is running, click <strong>Stop All Services</strong> in the TUI.</p>
</li> </li>
<li class=""> <li class="">
<p>Open the <strong>Advanced Setup</strong> menu (<kbd>2</kbd>), and then add the OAuth credentials for the cloud storage providers that you want to use:</p> <p>Open the <strong>Advanced Setup</strong> page, and then add the OAuth credentials for the cloud storage providers that you want to use under <strong>API Keys</strong>:</p>
<ul> <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>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>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> </ul>
</li> </li>
<li class=""> <li class="">
<p>The TUI presents redirect URIs for your OAuth app that you must register with your OAuth provider. <p>Register the redirect URIs shown in the TUI in your OAuth provider.
These are the URLs your OAuth provider will redirect back to after users authenticate and grant access to their cloud storage.</p> These are the URLs your OAuth provider will use to redirect users back to OpenRAG after they sign in.</p>
</li> </li>
<li class=""> <li class="">
<p>Click <strong>Save Configuration</strong> to add the OAuth credentials to your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p> <p>Click <strong>Save Configuration</strong> to add the OAuth credentials to your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p>
</li> </li>
<li class=""> <li class="">
<p>Click <strong>Start All Services</strong> to restart the OpenRAG containers with OAuth enabled.</p> <p>Click <strong>Start Services</strong> to restart the OpenRAG containers with OAuth enabled.</p>
</li> </li>
<li class=""> <li class="">
<p>Launch the OpenRAG app. <p>Launch the OpenRAG app.
@ -118,10 +118,6 @@ You should be prompted to sign in to your OAuth provider before being redirected
<p>Edit your OpenRAG <code>.env</code> file to add the OAuth credentials for the cloud storage providers that you want to use:</p> <p>Edit your OpenRAG <code>.env</code> file to add the OAuth credentials for the cloud storage providers that you want to use:</p>
<ul> <ul>
<li class=""> <li class="">
<p><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>.</p>
<div class="language-env codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-env 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">AWS_ACCESS_KEY_ID=</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">AWS_SECRET_ACCESS_KEY=</span><br></span></code></pre></div></div>
</li>
<li class="">
<p><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>.</p> <p><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>.</p>
<div class="language-env codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-env 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">GOOGLE_OAUTH_CLIENT_ID=</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">GOOGLE_OAUTH_CLIENT_SECRET=</span><br></span></code></pre></div></div> <div class="language-env codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-env 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">GOOGLE_OAUTH_CLIENT_ID=</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">GOOGLE_OAUTH_CLIENT_SECRET=</span><br></span></code></pre></div></div>
</li> </li>
@ -129,6 +125,10 @@ You should be prompted to sign in to your OAuth provider before being redirected
<p><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>.</p> <p><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>.</p>
<div class="language-env codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-env 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">MICROSOFT_GRAPH_OAUTH_CLIENT_ID=</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">MICROSOFT_GRAPH_OAUTH_CLIENT_SECRET=</span><br></span></code></pre></div></div> <div class="language-env codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-env 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">MICROSOFT_GRAPH_OAUTH_CLIENT_ID=</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">MICROSOFT_GRAPH_OAUTH_CLIENT_SECRET=</span><br></span></code></pre></div></div>
</li> </li>
<li class="">
<p><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>.</p>
<div class="language-env codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-env 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">AWS_ACCESS_KEY_ID=</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">AWS_SECRET_ACCESS_KEY=</span><br></span></code></pre></div></div>
</li>
</ul> </ul>
</li> </li>
<li class=""> <li class="">
@ -139,6 +139,10 @@ You should be prompted to sign in to your OAuth provider before being redirected
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Docker</div><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">docker</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">-d</span><br></span></code></pre></div></div> <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Docker</div><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">docker</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">-d</span><br></span></code></pre></div></div>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><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">podman</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">-d</span><br></span></code></pre></div></div> <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><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">podman</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">-d</span><br></span></code></pre></div></div>
</li> </li>
<li class="">
<p>Access the OpenRAG frontend at <code>http://localhost:3000</code>.
You should be prompted to sign in to your OAuth provider before being redirected to your OpenRAG instance.</p>
</li>
</ol></div></div></div> </ol></div></div></div>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="authenticate-and-ingest-files-from-cloud-storage">Authenticate and ingest files from cloud storage<a href="#authenticate-and-ingest-files-from-cloud-storage" class="hash-link" aria-label="Direct link to Authenticate and ingest files from cloud storage" title="Direct link to Authenticate and ingest files from cloud storage" translate="no"></a></h3> <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="authenticate-and-ingest-files-from-cloud-storage">Authenticate and ingest files from cloud storage<a href="#authenticate-and-ingest-files-from-cloud-storage" class="hash-link" aria-label="Direct link to Authenticate and ingest files from cloud storage" title="Direct link to Authenticate and ingest files from cloud storage" translate="no"></a></h3>
<p>After you start OpenRAG with OAuth connectors enabled, each user is prompted to authenticate with the OAuth provider upon accessing your OpenRAG instance. <p>After you start OpenRAG with OAuth connectors enabled, each user is prompted to authenticate with the OAuth provider upon accessing your OpenRAG instance.

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Select an installation method | 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-options"><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="Select an installation method | OpenRAG"><meta data-rh="true" name="description" content="The OpenRAG architecture is lightweight and container-based with a central OpenRAG backend that orchestrates the various services and external connectors."><meta data-rh="true" property="og:description" content="The OpenRAG architecture is lightweight and container-based with a central OpenRAG backend that orchestrates the various services and external connectors."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install-options"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-options" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-options" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Select an installation method","item":"https://docs.openr.ag/install-options"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Select an installation method | 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-options"><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="Select an installation method | OpenRAG"><meta data-rh="true" name="description" content="The OpenRAG architecture is lightweight and container-based with a central OpenRAG backend that orchestrates the various services and external connectors."><meta data-rh="true" property="og:description" content="The OpenRAG architecture is lightweight and container-based with a central OpenRAG backend that orchestrates the various services and external connectors."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install-options"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-options" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-options" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Select an installation method","item":"https://docs.openr.ag/install-options"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Install OpenRAG in a Python project with uv | 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-uv"><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 in a Python project with uv | OpenRAG"><meta data-rh="true" name="description" content="Use uv to install OpenRAG as a managed or unmanaged dependency in a new or existing Python project."><meta data-rh="true" property="og:description" content="Use uv to install OpenRAG as a managed or unmanaged dependency in a new or existing Python project."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install-uv"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-uv" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-uv" 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 uv","item":"https://docs.openr.ag/install-uv"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Install OpenRAG in a Python project with uv | 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-uv"><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 in a Python project with uv | OpenRAG"><meta data-rh="true" name="description" content="Use uv to install OpenRAG as a managed or unmanaged dependency in a new or existing Python project."><meta data-rh="true" property="og:description" content="Use uv to install OpenRAG as a managed or unmanaged dependency in a new or existing Python project."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install-uv"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-uv" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-uv" 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 uv","item":"https://docs.openr.ag/install-uv"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">
@ -166,79 +166,87 @@ Documents are filtered by user owner; users see only the documents that they upl
<p>If OpenRAG detects OAuth credentials during setup, it recommends <strong>Advanced Setup</strong> in the TUI.</p> <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> <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=""> <li class="">
<p>In the TUI, click <strong>Basic Setup</strong> or press <kbd>1</kbd>.</p> <p>In the TUI, select <strong>Basic Setup</strong>.</p>
</li> </li>
<li class=""> <li class="">
<p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services, or click <strong>Generate Passwords</strong> to generate passwords automatically.</p> <p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services.</p>
<p>The OpenSearch password is required.</p> <p>The OpenSearch password is required, and a secure password is automatically generated if you don&#x27;t provide one manually.</p>
<p>The Langflow password is recommended but optional. <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> 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>
<li class=""> <li class="">
<p>Optional: Enter your OpenAI API key, or leave this field empty to provide model provider credentials during the application onboarding process.</p> <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 the key now or during the <a href="#application-onboarding" class="">application onboarding process</a>. <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 key now, it can be populated automatically during the application onboarding process if you select the OpenAI model provider, and then enable <strong>Get API key from environment variable</strong>.</p> 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&#x27;s core functionality requires access to language and embedding models. <p>OpenRAG&#x27;s core functionality requires access to language and embedding models.
By default, OpenRAG uses OpenAI models. By default, OpenRAG uses OpenAI models.
If you aren&#x27;t sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG&#x27;s default model configuration. If you aren&#x27;t sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG&#x27;s default model configuration.</p>
If you want to use a different model provider, you can leave this field empty.</p> </li>
<li class="">
<p>Optional: Under <strong>Others</strong>, edit the <a class="" href="/knowledge">knowledge base</a> paths if you don&#x27;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>
<li class=""> <li class="">
<p>Click <strong>Save Configuration</strong>.</p> <p>Click <strong>Save Configuration</strong>.</p>
<p>Your passwords and API key, if provided, are stored in the <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> at <code>~/.openrag/tui</code>. <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> 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>
<li class=""> <li class="">
<p>Click <strong>Start All Services</strong> to start the OpenRAG services that run in containers.</p> <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. <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> 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> <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>
<li class=""> <li class="">
<p>Under <a class="" href="/manage-services"><strong>Native Services</strong></a>, click <strong>Start</strong> to start the Docling service.</p> <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>Launch the OpenRAG application:</p>
<ul>
<li class="">From the TUI main menu, click <strong>Open App</strong>.</li>
<li class="">In your browser, navigate to <code>localhost:3000</code>.</li>
</ul>
</li> </li>
<li class=""> <li class="">
<p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p> <p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p>
</li> </li>
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol> </ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
<li class=""> <li class="">
<p>In the TUI, click <strong>Advanced Setup</strong> or press <kbd>2</kbd>.</p> <p>In the TUI, select <strong>Advanced Setup</strong>.</p>
</li> </li>
<li class=""> <li class="">
<p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services, or click <strong>Generate Passwords</strong> to generate passwords automatically.</p> <p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services.</p>
<p>The OpenSearch password is required.</p> <p>The OpenSearch password is required, and a secure password is automatically generated if you don&#x27;t provide one manually.</p>
<p>The Langflow password is recommended but optional. <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> 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>
<li class=""> <li class="">
<p>Optional: Enter your OpenAI API key, or leave this field empty to provide model provider credentials during the application onboarding process.</p> <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 the key now or during the <a href="#application-onboarding" class="">application onboarding process</a>. <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 key now, it can be populated automatically during the application onboarding process if you select the OpenAI model provider, and then enable <strong>Get API key from environment variable</strong>.</p> 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&#x27;s core functionality requires access to language and embedding models. <p>OpenRAG&#x27;s core functionality requires access to language and embedding models.
By default, OpenRAG uses OpenAI models. By default, OpenRAG uses OpenAI models.
If you aren&#x27;t sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG&#x27;s default model configuration. If you aren&#x27;t sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG&#x27;s default model configuration.</p>
If you want to use a different model provider, you can leave this field empty.</p>
</li> </li>
<li class=""> <li class="">
<p>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 an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> at <code>~/.openrag/tui</code>.</p> <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> <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>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>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> </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> <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>
<li class=""> <li class="">
<p>The OpenRAG TUI presents redirect URIs for your OAuth app. <p>Register the redirect URIs shown in the TUI in your OAuth provider.
These are the URLs your OAuth provider will redirect back to after user sign-in. These are the URLs your OAuth provider will use to redirect users back to OpenRAG after they sign in.</p>
Register these redirect values with your OAuth provider as they are presented in the TUI.</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>
<li class=""> <li class="">
<p>Click <strong>Save Configuration</strong>.</p> <p>Click <strong>Save Configuration</strong>.</p>
@ -246,40 +254,18 @@ Register these redirect values with your OAuth provider as they are presented in
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> 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>
<li class=""> <li class="">
<p>Click <strong>Start All Services</strong> to start the OpenRAG services that run in containers.</p> <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. <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> 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> <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>
<li class=""> <li class="">
<p>Under <a class="" href="/manage-services"><strong>Native Services</strong></a>, click <strong>Start</strong> to start the Docling service.</p> <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>Launch the OpenRAG application:</p>
<ul>
<li class="">From the TUI main menu, click <strong>Open App</strong>.</li>
<li class="">In your browser, navigate to <code>localhost:3000</code>.</li>
</ul>
</li> </li>
<li class=""> <li class="">
<p>If you enabled OAuth connectors, you must sign in to your OAuth provider before being redirected to your OpenRAG instance.</p> <p>If you enabled OAuth connectors, you must sign in to your OAuth provider before being redirected to your OpenRAG instance.</p>
</li> </li>
<li class=""> <li class="">
<p>If required, you can edit the following additional environment variables.
Only change these variables if your OpenRAG deployment has a non-default network configuration, such as a reverse proxy or custom domain.</p>
<ul>
<li class=""><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.</li>
<li class=""><code>WEBHOOK_BASE_URL</code>: Sets the base address for the following OpenRAG OAuth connector endpoints:<!-- -->
<ul>
<li class="">Amazon S3: Not applicable.</li>
<li class="">Google Drive: <code>WEBHOOK_BASE_URL/connectors/google_drive/webhook</code></li>
<li class="">OneDrive: <code>WEBHOOK_BASE_URL/connectors/onedrive/webhook</code></li>
<li class="">SharePoint: <code>WEBHOOK_BASE_URL/connectors/sharepoint/webhook</code></li>
</ul>
</li>
</ul>
</li>
<li class="">
<p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p> <p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p>
</li> </li>
</ol></div></div></div> </ol></div></div></div>
@ -293,8 +279,7 @@ Additionally, you can set multiple embedding models.</p>
<p>You only need to complete onboarding for your preferred providers.</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&#x27;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> <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&#x27;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=""> <li class="">
<p>Enter your Anthropic API key, or enable <strong>Get API key from environment variable</strong> to pull the key from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p> <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>
<p>If you set <code>ANTHROPIC_API_KEY</code> in your OpenRAG <code>.env</code> file, this value can be populated automatically.</p>
</li> </li>
<li class=""> <li class="">
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p> <p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>
@ -318,8 +303,11 @@ The overview demonstrates some basic functionality that is covered in the <a cla
</li> </li>
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol> </ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
<li class=""> <li class="">
<p>Use the values from your IBM watsonx deployment for the <strong>watsonx.ai API Endpoint</strong>, <strong>IBM Project ID</strong>, and <strong>IBM API key</strong> fields.</p> <p>For <strong>watsonx.ai API Endpoint</strong>, select the base URL for your watsonx.ai model deployment.</p>
<p>If you set <code>WATSONX_API_KEY</code>, <code>WATSONX_API_URL</code>, or <code>WATSONX_PROJECT_ID</code> in your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>, these values can be populated automatically.</p> </li>
<li class="">
<p>Enter your watsonx.ai deployment&#x27;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>
<li class=""> <li class="">
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p> <p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>
@ -362,23 +350,30 @@ You can submit an <a href="https://github.com/langflow-ai/openrag/issues" target
<p>If you are running a remote server, it must be accessible from your OpenRAG deployment.</p> <p>If you are running a remote server, it must be accessible from your OpenRAG deployment.</p>
</li> </li>
<li class=""> <li class="">
<p>In OpenRAG onboarding, connect to your Ollama server:</p> <p>In the OpenRAG onboarding dialog, enter your Ollama server&#x27;s base URL:</p>
<ul> <ul>
<li class=""><strong>Local Ollama server</strong>: Enter your Ollama server&#x27;s base URL and port. The default Ollama server address is <code>http://localhost:11434</code>.</li> <li class=""><strong>Local Ollama server</strong>: Enter your Ollama server&#x27;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&#x27;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>Ollama Cloud</strong>: Because Ollama Cloud models run at the same address as a local Ollama server and automatically offload to Ollama&#x27;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&#x27;s base URL and port, such as <code>http://your-remote-server:11434</code>.</li> <li class=""><strong>Remote server</strong>: Enter your remote Ollama server&#x27;s base URL and port, such as <code>http://your-remote-server:11434</code>.</li>
</ul> </ul>
<p>If the connection succeeds, OpenRAG populates the model lists with the server&#x27;s available models.</p>
</li> </li>
<li class=""> <li class="">
<p>Select the model that your Ollama server is running.</p> <p>Select the language model that your Ollama server is running.</p>
<p>If your server isn&#x27;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. <p>Language model and embedding model selections are independent.
You can use the same or different servers for each model.</p> 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> <p>To use different providers for each model, you must configure both providers, and select the relevant model for each provider.</p>
</li> </li>
<li class=""> <li class="">
<p>Click <strong>Complete</strong>.</p> <p>Click <strong>Complete</strong>.</p>
<p>After you configure the embedding model, OpenRAG uses the address 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>. </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&#x27;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. 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. 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> Then, click <strong>Complete</strong> to retry ingestion.</p>
@ -389,8 +384,7 @@ The overview demonstrates some basic functionality that is covered in the <a cla
</li> </li>
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol> </ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
<li class=""> <li class="">
<p>Enter your OpenAI API key, or enable <strong>Get API key from environment variable</strong> to pull the key from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p> <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>
<p>If you set <code>OPENAI_API_KEY</code> in your OpenRAG <code>.env</code> file, this value can be populated automatically.</p>
</li> </li>
<li class=""> <li class="">
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p> <p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Invoke OpenRAG with uvx | 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-uvx"><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="Invoke OpenRAG with uvx | OpenRAG"><meta data-rh="true" name="description" content="Use uvx to invoke OpenRAG outside of a Python project or without modifying your project&#x27;s dependencies."><meta data-rh="true" property="og:description" content="Use uvx to invoke OpenRAG outside of a Python project or without modifying your project&#x27;s dependencies."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install-uvx"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-uvx" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-uvx" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Invoke OpenRAG with uvx","item":"https://docs.openr.ag/install-uvx"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Invoke OpenRAG with uvx | 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-uvx"><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="Invoke OpenRAG with uvx | OpenRAG"><meta data-rh="true" name="description" content="Use uvx to invoke OpenRAG outside of a Python project or without modifying your project&#x27;s dependencies."><meta data-rh="true" property="og:description" content="Use uvx to invoke OpenRAG outside of a Python project or without modifying your project&#x27;s dependencies."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install-uvx"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-uvx" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-uvx" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Invoke OpenRAG with uvx","item":"https://docs.openr.ag/install-uvx"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">
@ -122,79 +122,87 @@ Documents are filtered by user owner; users see only the documents that they upl
<p>If OpenRAG detects OAuth credentials during setup, it recommends <strong>Advanced Setup</strong> in the TUI.</p> <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> <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=""> <li class="">
<p>In the TUI, click <strong>Basic Setup</strong> or press <kbd>1</kbd>.</p> <p>In the TUI, select <strong>Basic Setup</strong>.</p>
</li> </li>
<li class=""> <li class="">
<p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services, or click <strong>Generate Passwords</strong> to generate passwords automatically.</p> <p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services.</p>
<p>The OpenSearch password is required.</p> <p>The OpenSearch password is required, and a secure password is automatically generated if you don&#x27;t provide one manually.</p>
<p>The Langflow password is recommended but optional. <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> 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>
<li class=""> <li class="">
<p>Optional: Enter your OpenAI API key, or leave this field empty to provide model provider credentials during the application onboarding process.</p> <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 the key now or during the <a href="#application-onboarding" class="">application onboarding process</a>. <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 key now, it can be populated automatically during the application onboarding process if you select the OpenAI model provider, and then enable <strong>Get API key from environment variable</strong>.</p> 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&#x27;s core functionality requires access to language and embedding models. <p>OpenRAG&#x27;s core functionality requires access to language and embedding models.
By default, OpenRAG uses OpenAI models. By default, OpenRAG uses OpenAI models.
If you aren&#x27;t sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG&#x27;s default model configuration. If you aren&#x27;t sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG&#x27;s default model configuration.</p>
If you want to use a different model provider, you can leave this field empty.</p> </li>
<li class="">
<p>Optional: Under <strong>Others</strong>, edit the <a class="" href="/knowledge">knowledge base</a> paths if you don&#x27;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>
<li class=""> <li class="">
<p>Click <strong>Save Configuration</strong>.</p> <p>Click <strong>Save Configuration</strong>.</p>
<p>Your passwords and API key, if provided, are stored in the <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> at <code>~/.openrag/tui</code>. <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> 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>
<li class=""> <li class="">
<p>Click <strong>Start All Services</strong> to start the OpenRAG services that run in containers.</p> <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. <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> 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> <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>
<li class=""> <li class="">
<p>Under <a class="" href="/manage-services"><strong>Native Services</strong></a>, click <strong>Start</strong> to start the Docling service.</p> <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>Launch the OpenRAG application:</p>
<ul>
<li class="">From the TUI main menu, click <strong>Open App</strong>.</li>
<li class="">In your browser, navigate to <code>localhost:3000</code>.</li>
</ul>
</li> </li>
<li class=""> <li class="">
<p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p> <p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p>
</li> </li>
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol> </ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
<li class=""> <li class="">
<p>In the TUI, click <strong>Advanced Setup</strong> or press <kbd>2</kbd>.</p> <p>In the TUI, select <strong>Advanced Setup</strong>.</p>
</li> </li>
<li class=""> <li class="">
<p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services, or click <strong>Generate Passwords</strong> to generate passwords automatically.</p> <p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services.</p>
<p>The OpenSearch password is required.</p> <p>The OpenSearch password is required, and a secure password is automatically generated if you don&#x27;t provide one manually.</p>
<p>The Langflow password is recommended but optional. <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> 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>
<li class=""> <li class="">
<p>Optional: Enter your OpenAI API key, or leave this field empty to provide model provider credentials during the application onboarding process.</p> <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 the key now or during the <a href="#application-onboarding" class="">application onboarding process</a>. <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 key now, it can be populated automatically during the application onboarding process if you select the OpenAI model provider, and then enable <strong>Get API key from environment variable</strong>.</p> 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&#x27;s core functionality requires access to language and embedding models. <p>OpenRAG&#x27;s core functionality requires access to language and embedding models.
By default, OpenRAG uses OpenAI models. By default, OpenRAG uses OpenAI models.
If you aren&#x27;t sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG&#x27;s default model configuration. If you aren&#x27;t sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG&#x27;s default model configuration.</p>
If you want to use a different model provider, you can leave this field empty.</p>
</li> </li>
<li class=""> <li class="">
<p>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 an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> at <code>~/.openrag/tui</code>.</p> <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> <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>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>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> </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> <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>
<li class=""> <li class="">
<p>The OpenRAG TUI presents redirect URIs for your OAuth app. <p>Register the redirect URIs shown in the TUI in your OAuth provider.
These are the URLs your OAuth provider will redirect back to after user sign-in. These are the URLs your OAuth provider will use to redirect users back to OpenRAG after they sign in.</p>
Register these redirect values with your OAuth provider as they are presented in the TUI.</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>
<li class=""> <li class="">
<p>Click <strong>Save Configuration</strong>.</p> <p>Click <strong>Save Configuration</strong>.</p>
@ -202,40 +210,18 @@ Register these redirect values with your OAuth provider as they are presented in
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> 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>
<li class=""> <li class="">
<p>Click <strong>Start All Services</strong> to start the OpenRAG services that run in containers.</p> <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. <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> 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> <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>
<li class=""> <li class="">
<p>Under <a class="" href="/manage-services"><strong>Native Services</strong></a>, click <strong>Start</strong> to start the Docling service.</p> <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>Launch the OpenRAG application:</p>
<ul>
<li class="">From the TUI main menu, click <strong>Open App</strong>.</li>
<li class="">In your browser, navigate to <code>localhost:3000</code>.</li>
</ul>
</li> </li>
<li class=""> <li class="">
<p>If you enabled OAuth connectors, you must sign in to your OAuth provider before being redirected to your OpenRAG instance.</p> <p>If you enabled OAuth connectors, you must sign in to your OAuth provider before being redirected to your OpenRAG instance.</p>
</li> </li>
<li class=""> <li class="">
<p>If required, you can edit the following additional environment variables.
Only change these variables if your OpenRAG deployment has a non-default network configuration, such as a reverse proxy or custom domain.</p>
<ul>
<li class=""><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.</li>
<li class=""><code>WEBHOOK_BASE_URL</code>: Sets the base address for the following OpenRAG OAuth connector endpoints:<!-- -->
<ul>
<li class="">Amazon S3: Not applicable.</li>
<li class="">Google Drive: <code>WEBHOOK_BASE_URL/connectors/google_drive/webhook</code></li>
<li class="">OneDrive: <code>WEBHOOK_BASE_URL/connectors/onedrive/webhook</code></li>
<li class="">SharePoint: <code>WEBHOOK_BASE_URL/connectors/sharepoint/webhook</code></li>
</ul>
</li>
</ul>
</li>
<li class="">
<p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p> <p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p>
</li> </li>
</ol></div></div></div> </ol></div></div></div>
@ -249,8 +235,7 @@ Additionally, you can set multiple embedding models.</p>
<p>You only need to complete onboarding for your preferred providers.</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&#x27;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> <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&#x27;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=""> <li class="">
<p>Enter your Anthropic API key, or enable <strong>Get API key from environment variable</strong> to pull the key from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p> <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>
<p>If you set <code>ANTHROPIC_API_KEY</code> in your OpenRAG <code>.env</code> file, this value can be populated automatically.</p>
</li> </li>
<li class=""> <li class="">
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p> <p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>
@ -274,8 +259,11 @@ The overview demonstrates some basic functionality that is covered in the <a cla
</li> </li>
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol> </ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
<li class=""> <li class="">
<p>Use the values from your IBM watsonx deployment for the <strong>watsonx.ai API Endpoint</strong>, <strong>IBM Project ID</strong>, and <strong>IBM API key</strong> fields.</p> <p>For <strong>watsonx.ai API Endpoint</strong>, select the base URL for your watsonx.ai model deployment.</p>
<p>If you set <code>WATSONX_API_KEY</code>, <code>WATSONX_API_URL</code>, or <code>WATSONX_PROJECT_ID</code> in your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>, these values can be populated automatically.</p> </li>
<li class="">
<p>Enter your watsonx.ai deployment&#x27;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>
<li class=""> <li class="">
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p> <p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>
@ -318,23 +306,30 @@ You can submit an <a href="https://github.com/langflow-ai/openrag/issues" target
<p>If you are running a remote server, it must be accessible from your OpenRAG deployment.</p> <p>If you are running a remote server, it must be accessible from your OpenRAG deployment.</p>
</li> </li>
<li class=""> <li class="">
<p>In OpenRAG onboarding, connect to your Ollama server:</p> <p>In the OpenRAG onboarding dialog, enter your Ollama server&#x27;s base URL:</p>
<ul> <ul>
<li class=""><strong>Local Ollama server</strong>: Enter your Ollama server&#x27;s base URL and port. The default Ollama server address is <code>http://localhost:11434</code>.</li> <li class=""><strong>Local Ollama server</strong>: Enter your Ollama server&#x27;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&#x27;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>Ollama Cloud</strong>: Because Ollama Cloud models run at the same address as a local Ollama server and automatically offload to Ollama&#x27;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&#x27;s base URL and port, such as <code>http://your-remote-server:11434</code>.</li> <li class=""><strong>Remote server</strong>: Enter your remote Ollama server&#x27;s base URL and port, such as <code>http://your-remote-server:11434</code>.</li>
</ul> </ul>
<p>If the connection succeeds, OpenRAG populates the model lists with the server&#x27;s available models.</p>
</li> </li>
<li class=""> <li class="">
<p>Select the model that your Ollama server is running.</p> <p>Select the language model that your Ollama server is running.</p>
<p>If your server isn&#x27;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. <p>Language model and embedding model selections are independent.
You can use the same or different servers for each model.</p> 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> <p>To use different providers for each model, you must configure both providers, and select the relevant model for each provider.</p>
</li> </li>
<li class=""> <li class="">
<p>Click <strong>Complete</strong>.</p> <p>Click <strong>Complete</strong>.</p>
<p>After you configure the embedding model, OpenRAG uses the address 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>. </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&#x27;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. 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. 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> Then, click <strong>Complete</strong> to retry ingestion.</p>
@ -345,8 +340,7 @@ The overview demonstrates some basic functionality that is covered in the <a cla
</li> </li>
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol> </ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
<li class=""> <li class="">
<p>Enter your OpenAI API key, or enable <strong>Get API key from environment variable</strong> to pull the key from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p> <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>
<p>If you set <code>OPENAI_API_KEY</code> in your OpenRAG <code>.env</code> file, this value can be populated automatically.</p>
</li> </li>
<li class=""> <li class="">
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p> <p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Install OpenRAG on Microsoft Windows | 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-windows"><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 on Microsoft Windows | OpenRAG"><meta data-rh="true" name="description" content="If you&#x27;re using Windows, you must install OpenRAG within the Windows Subsystem for Linux (WSL)."><meta data-rh="true" property="og:description" content="If you&#x27;re using Windows, you must install OpenRAG within the Windows Subsystem for Linux (WSL)."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install-windows"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-windows" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-windows" 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 on Windows","item":"https://docs.openr.ag/install-windows"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Install OpenRAG on Microsoft Windows | 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-windows"><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 on Microsoft Windows | OpenRAG"><meta data-rh="true" name="description" content="If you&#x27;re using Windows, you must install OpenRAG within the Windows Subsystem for Linux (WSL)."><meta data-rh="true" property="og:description" content="If you&#x27;re using Windows, you must install OpenRAG within the Windows Subsystem for Linux (WSL)."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install-windows"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-windows" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-windows" 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 on Windows","item":"https://docs.openr.ag/install-windows"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <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="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 the automatic installer script | OpenRAG"><meta data-rh="true" name="description" content="To quickly install and test OpenRAG&#x27;s core features, try the quickstart."><meta data-rh="true" property="og:description" content="To quickly install and test OpenRAG&#x27;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><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <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="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 the automatic installer script | OpenRAG"><meta data-rh="true" name="description" content="To quickly install and test OpenRAG&#x27;s core features, try the quickstart."><meta data-rh="true" property="og:description" content="To quickly install and test OpenRAG&#x27;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><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">
@ -79,14 +79,14 @@ You can submit an <a href="https://github.com/langflow-ai/openrag/issues" target
<li class=""> <li class="">
<p>Wait while the installer script prepares your environment and installs OpenRAG. <p>Wait while the installer script prepares your environment and installs OpenRAG.
You might be prompted to install certain dependencies if they aren&#x27;t already present in your environment.</p> You might be prompted to install certain dependencies if they aren&#x27;t already present in your environment.</p>
</li>
</ol>
<p>The entire process can take a few minutes. <p>The entire process can take a few minutes.
Once the environment is ready, the OpenRAG TUI starts.</p> 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_2025-09-10T13_04_11_757637-9441c53ba39162a88ac6c11cbeaed0e0.svg" width="1995" height="1099" class="img_ev3q"></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. <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&#x27;t delete your entire OpenRAG installation, only the temporary TUI environment. Clearing the cache doesn&#x27;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> 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> <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> <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. <p>When you install OpenRAG with the installer script, you manage the OpenRAG services with the TUI.
@ -113,79 +113,87 @@ Documents are filtered by user owner; users see only the documents that they upl
<p>If OpenRAG detects OAuth credentials during setup, it recommends <strong>Advanced Setup</strong> in the TUI.</p> <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> <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=""> <li class="">
<p>In the TUI, click <strong>Basic Setup</strong> or press <kbd>1</kbd>.</p> <p>In the TUI, select <strong>Basic Setup</strong>.</p>
</li> </li>
<li class=""> <li class="">
<p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services, or click <strong>Generate Passwords</strong> to generate passwords automatically.</p> <p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services.</p>
<p>The OpenSearch password is required.</p> <p>The OpenSearch password is required, and a secure password is automatically generated if you don&#x27;t provide one manually.</p>
<p>The Langflow password is recommended but optional. <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> 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>
<li class=""> <li class="">
<p>Optional: Enter your OpenAI API key, or leave this field empty to provide model provider credentials during the application onboarding process.</p> <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 the key now or during the <a href="#application-onboarding" class="">application onboarding process</a>. <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 key now, it can be populated automatically during the application onboarding process if you select the OpenAI model provider, and then enable <strong>Get API key from environment variable</strong>.</p> 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&#x27;s core functionality requires access to language and embedding models. <p>OpenRAG&#x27;s core functionality requires access to language and embedding models.
By default, OpenRAG uses OpenAI models. By default, OpenRAG uses OpenAI models.
If you aren&#x27;t sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG&#x27;s default model configuration. If you aren&#x27;t sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG&#x27;s default model configuration.</p>
If you want to use a different model provider, you can leave this field empty.</p> </li>
<li class="">
<p>Optional: Under <strong>Others</strong>, edit the <a class="" href="/knowledge">knowledge base</a> paths if you don&#x27;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>
<li class=""> <li class="">
<p>Click <strong>Save Configuration</strong>.</p> <p>Click <strong>Save Configuration</strong>.</p>
<p>Your passwords and API key, if provided, are stored in the <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> at <code>~/.openrag/tui</code>. <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> 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>
<li class=""> <li class="">
<p>Click <strong>Start All Services</strong> to start the OpenRAG services that run in containers.</p> <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. <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> 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> <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>
<li class=""> <li class="">
<p>Under <a class="" href="/manage-services"><strong>Native Services</strong></a>, click <strong>Start</strong> to start the Docling service.</p> <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>Launch the OpenRAG application:</p>
<ul>
<li class="">From the TUI main menu, click <strong>Open App</strong>.</li>
<li class="">In your browser, navigate to <code>localhost:3000</code>.</li>
</ul>
</li> </li>
<li class=""> <li class="">
<p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p> <p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p>
</li> </li>
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol> </ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
<li class=""> <li class="">
<p>In the TUI, click <strong>Advanced Setup</strong> or press <kbd>2</kbd>.</p> <p>In the TUI, select <strong>Advanced Setup</strong>.</p>
</li> </li>
<li class=""> <li class="">
<p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services, or click <strong>Generate Passwords</strong> to generate passwords automatically.</p> <p>Enter administrator passwords for the OpenRAG OpenSearch and Langflow services.</p>
<p>The OpenSearch password is required.</p> <p>The OpenSearch password is required, and a secure password is automatically generated if you don&#x27;t provide one manually.</p>
<p>The Langflow password is recommended but optional. <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> 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>
<li class=""> <li class="">
<p>Optional: Enter your OpenAI API key, or leave this field empty to provide model provider credentials during the application onboarding process.</p> <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 the key now or during the <a href="#application-onboarding" class="">application onboarding process</a>. <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 key now, it can be populated automatically during the application onboarding process if you select the OpenAI model provider, and then enable <strong>Get API key from environment variable</strong>.</p> 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&#x27;s core functionality requires access to language and embedding models. <p>OpenRAG&#x27;s core functionality requires access to language and embedding models.
By default, OpenRAG uses OpenAI models. By default, OpenRAG uses OpenAI models.
If you aren&#x27;t sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG&#x27;s default model configuration. If you aren&#x27;t sure which models or providers to use, you must provide an OpenAI API key to use OpenRAG&#x27;s default model configuration.</p>
If you want to use a different model provider, you can leave this field empty.</p>
</li> </li>
<li class=""> <li class="">
<p>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 an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> at <code>~/.openrag/tui</code>.</p> <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> <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>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>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> </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> <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>
<li class=""> <li class="">
<p>The OpenRAG TUI presents redirect URIs for your OAuth app. <p>Register the redirect URIs shown in the TUI in your OAuth provider.
These are the URLs your OAuth provider will redirect back to after user sign-in. These are the URLs your OAuth provider will use to redirect users back to OpenRAG after they sign in.</p>
Register these redirect values with your OAuth provider as they are presented in the TUI.</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>
<li class=""> <li class="">
<p>Click <strong>Save Configuration</strong>.</p> <p>Click <strong>Save Configuration</strong>.</p>
@ -193,40 +201,18 @@ Register these redirect values with your OAuth provider as they are presented in
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> 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>
<li class=""> <li class="">
<p>Click <strong>Start All Services</strong> to start the OpenRAG services that run in containers.</p> <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. <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> 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> <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>
<li class=""> <li class="">
<p>Under <a class="" href="/manage-services"><strong>Native Services</strong></a>, click <strong>Start</strong> to start the Docling service.</p> <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>Launch the OpenRAG application:</p>
<ul>
<li class="">From the TUI main menu, click <strong>Open App</strong>.</li>
<li class="">In your browser, navigate to <code>localhost:3000</code>.</li>
</ul>
</li> </li>
<li class=""> <li class="">
<p>If you enabled OAuth connectors, you must sign in to your OAuth provider before being redirected to your OpenRAG instance.</p> <p>If you enabled OAuth connectors, you must sign in to your OAuth provider before being redirected to your OpenRAG instance.</p>
</li> </li>
<li class=""> <li class="">
<p>If required, you can edit the following additional environment variables.
Only change these variables if your OpenRAG deployment has a non-default network configuration, such as a reverse proxy or custom domain.</p>
<ul>
<li class=""><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.</li>
<li class=""><code>WEBHOOK_BASE_URL</code>: Sets the base address for the following OpenRAG OAuth connector endpoints:<!-- -->
<ul>
<li class="">Amazon S3: Not applicable.</li>
<li class="">Google Drive: <code>WEBHOOK_BASE_URL/connectors/google_drive/webhook</code></li>
<li class="">OneDrive: <code>WEBHOOK_BASE_URL/connectors/onedrive/webhook</code></li>
<li class="">SharePoint: <code>WEBHOOK_BASE_URL/connectors/sharepoint/webhook</code></li>
</ul>
</li>
</ul>
</li>
<li class="">
<p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p> <p>Continue with the <a href="#application-onboarding" class="">application onboarding process</a>.</p>
</li> </li>
</ol></div></div></div> </ol></div></div></div>
@ -240,8 +226,7 @@ Additionally, you can set multiple embedding models.</p>
<p>You only need to complete onboarding for your preferred providers.</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&#x27;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> <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&#x27;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=""> <li class="">
<p>Enter your Anthropic API key, or enable <strong>Get API key from environment variable</strong> to pull the key from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p> <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>
<p>If you set <code>ANTHROPIC_API_KEY</code> in your OpenRAG <code>.env</code> file, this value can be populated automatically.</p>
</li> </li>
<li class=""> <li class="">
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p> <p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>
@ -265,8 +250,11 @@ The overview demonstrates some basic functionality that is covered in the <a cla
</li> </li>
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol> </ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
<li class=""> <li class="">
<p>Use the values from your IBM watsonx deployment for the <strong>watsonx.ai API Endpoint</strong>, <strong>IBM Project ID</strong>, and <strong>IBM API key</strong> fields.</p> <p>For <strong>watsonx.ai API Endpoint</strong>, select the base URL for your watsonx.ai model deployment.</p>
<p>If you set <code>WATSONX_API_KEY</code>, <code>WATSONX_API_URL</code>, or <code>WATSONX_PROJECT_ID</code> in your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>, these values can be populated automatically.</p> </li>
<li class="">
<p>Enter your watsonx.ai deployment&#x27;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>
<li class=""> <li class="">
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p> <p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>
@ -309,23 +297,30 @@ You can submit an <a href="https://github.com/langflow-ai/openrag/issues" target
<p>If you are running a remote server, it must be accessible from your OpenRAG deployment.</p> <p>If you are running a remote server, it must be accessible from your OpenRAG deployment.</p>
</li> </li>
<li class=""> <li class="">
<p>In OpenRAG onboarding, connect to your Ollama server:</p> <p>In the OpenRAG onboarding dialog, enter your Ollama server&#x27;s base URL:</p>
<ul> <ul>
<li class=""><strong>Local Ollama server</strong>: Enter your Ollama server&#x27;s base URL and port. The default Ollama server address is <code>http://localhost:11434</code>.</li> <li class=""><strong>Local Ollama server</strong>: Enter your Ollama server&#x27;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&#x27;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>Ollama Cloud</strong>: Because Ollama Cloud models run at the same address as a local Ollama server and automatically offload to Ollama&#x27;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&#x27;s base URL and port, such as <code>http://your-remote-server:11434</code>.</li> <li class=""><strong>Remote server</strong>: Enter your remote Ollama server&#x27;s base URL and port, such as <code>http://your-remote-server:11434</code>.</li>
</ul> </ul>
<p>If the connection succeeds, OpenRAG populates the model lists with the server&#x27;s available models.</p>
</li> </li>
<li class=""> <li class="">
<p>Select the model that your Ollama server is running.</p> <p>Select the language model that your Ollama server is running.</p>
<p>If your server isn&#x27;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. <p>Language model and embedding model selections are independent.
You can use the same or different servers for each model.</p> 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> <p>To use different providers for each model, you must configure both providers, and select the relevant model for each provider.</p>
</li> </li>
<li class=""> <li class="">
<p>Click <strong>Complete</strong>.</p> <p>Click <strong>Complete</strong>.</p>
<p>After you configure the embedding model, OpenRAG uses the address 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>. </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&#x27;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. 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. 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> Then, click <strong>Complete</strong> to retry ingestion.</p>
@ -336,8 +331,7 @@ The overview demonstrates some basic functionality that is covered in the <a cla
</li> </li>
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol> </ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
<li class=""> <li class="">
<p>Enter your OpenAI API key, or enable <strong>Get API key from environment variable</strong> to pull the key from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p> <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>
<p>If you set <code>OPENAI_API_KEY</code> in your OpenRAG <code>.env</code> file, this value can be populated automatically.</p>
</li> </li>
<li class=""> <li class="">
<p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p> <p>Under <strong>Advanced settings</strong>, select the language model that you want to use.</p>

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Filter knowledge | 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/knowledge-filters"><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="Filter knowledge | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG&#x27;s knowledge filters help you organize and manage your knowledge base by creating pre-defined views of your documents."><meta data-rh="true" property="og:description" content="OpenRAG&#x27;s knowledge filters help you organize and manage your knowledge base by creating pre-defined views of your documents."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/knowledge-filters"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge-filters" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge-filters" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Filter knowledge","item":"https://docs.openr.ag/knowledge-filters"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Filter knowledge | 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/knowledge-filters"><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="Filter knowledge | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG&#x27;s knowledge filters help you organize and manage your knowledge base by creating pre-defined views of your documents."><meta data-rh="true" property="og:description" content="OpenRAG&#x27;s knowledge filters help you organize and manage your knowledge base by creating pre-defined views of your documents."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/knowledge-filters"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge-filters" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge-filters" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Filter knowledge","item":"https://docs.openr.ag/knowledge-filters"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Configure knowledge | 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/knowledge"><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="Configure knowledge | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG includes a built-in OpenSearch instance that serves as the underlying datastore for your knowledge (documents)."><meta data-rh="true" property="og:description" content="OpenRAG includes a built-in OpenSearch instance that serves as the underlying datastore for your knowledge (documents)."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/knowledge"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Configure knowledge","item":"https://docs.openr.ag/knowledge"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Configure knowledge | 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/knowledge"><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="Configure knowledge | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG includes a built-in OpenSearch instance that serves as the underlying datastore for your knowledge (documents)."><meta data-rh="true" property="og:description" content="OpenRAG includes a built-in OpenSearch instance that serves as the underlying datastore for your knowledge (documents)."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/knowledge"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Configure knowledge","item":"https://docs.openr.ag/knowledge"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Manage OpenRAG containers and services | 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/manage-services"><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="Manage OpenRAG containers and services | OpenRAG"><meta data-rh="true" name="description" content="Service management is an essential part of maintaining your OpenRAG deployment."><meta data-rh="true" property="og:description" content="Service management is an essential part of maintaining your OpenRAG deployment."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/manage-services"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/manage-services" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/manage-services" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Manage services","item":"https://docs.openr.ag/manage-services"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Manage OpenRAG containers and services | 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/manage-services"><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="Manage OpenRAG containers and services | OpenRAG"><meta data-rh="true" name="description" content="Service management is an essential part of maintaining your OpenRAG deployment."><meta data-rh="true" property="og:description" content="Service management is an essential part of maintaining your OpenRAG deployment."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/manage-services"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/manage-services" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/manage-services" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Manage services","item":"https://docs.openr.ag/manage-services"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">
@ -16,30 +16,10 @@
However, some services, like Docling, run directly on the local machine.</p> However, some services, like Docling, run directly on the local machine.</p>
<p>If you <a class="" href="/install-options">installed OpenRAG</a> with the automated installer script, <code>uv</code>, or <code>uvx</code>, you can use the <a class="" href="/tui">Terminal User Interface (TUI)</a> to manage your OpenRAG configuration and services.</p> <p>If you <a class="" href="/install-options">installed OpenRAG</a> with the automated installer script, <code>uv</code>, or <code>uvx</code>, you can use the <a class="" href="/tui">Terminal User Interface (TUI)</a> to manage your OpenRAG configuration and services.</p>
<p>For <a class="" href="/docker">self-managed deployments</a>, run Docker or Podman commands to manage your OpenRAG services.</p> <p>For <a class="" href="/docker">self-managed deployments</a>, run Docker or Podman commands to manage your OpenRAG services.</p>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="monitor-services">Monitor services<a href="#monitor-services" class="hash-link" aria-label="Direct link to Monitor services" title="Direct link to Monitor services" translate="no"></a></h2> <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="monitor-services-and-view-logs">Monitor services and view logs<a href="#monitor-services-and-view-logs" class="hash-link" aria-label="Direct link to Monitor services and view logs" title="Direct link to Monitor services and view logs" translate="no"></a></h2>
<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">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><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">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>In the TUI, click <strong>Status</strong> to access diagnostics and controls for all OpenRAG services, including container health, ports, and image versions.</p><p>To view streaming logs, click the name of a service, and then press <kbd>l</kbd>.</p><p>For the Docling native service, see <a href="#start-native-services" class="">Stop, start, and inspect native services</a>.</p></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>For self-managed container services, you can get container logs with <a href="https://docs.docker.com/reference/cli/docker/compose/logs/" target="_blank" rel="noopener noreferrer" class=""><code>docker compose logs</code></a> or <a href="https://docs.podman.io/en/latest/markdown/podman-logs.1.html" target="_blank" rel="noopener noreferrer" class=""><code>podman logs</code></a>.</p><p>For the Docling native service, see <a href="#start-native-services" class="">Stop, start, and inspect native services</a>.</p></div></div></div>
<li class="">
<p><strong>TUI Status menu</strong>: In the <strong>Status</strong> menu (<kbd>3</kbd>), you can access streaming logs for all OpenRAG services.
Select the service you want to view, and then press <kbd>l</kbd>.
To copy the logs, click <strong>Copy to Clipboard</strong>.</p>
</li>
<li class="">
<p><strong>TUI Diagnostics menu</strong>: The TUI&#x27;s <strong>Diagnostics</strong> menu (<kbd>4</kbd>) provides health monitoring for your container runtimes and monitoring of your OpenSearch instance.</p>
</li>
<li class="">
<p><strong>Docling</strong>: See <a href="#start-native-services" class="">Stop, start, and inspect native services</a>.</p>
</li>
</ul></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ul>
<li class="">
<p><strong>Containers</strong>: Get container logs with <a href="https://docs.docker.com/reference/cli/docker/compose/logs/" target="_blank" rel="noopener noreferrer" class=""><code>docker compose logs</code></a> or <a href="https://docs.podman.io/en/latest/markdown/podman-logs.1.html" target="_blank" rel="noopener noreferrer" class=""><code>podman logs</code></a>.</p>
</li>
<li class="">
<p><strong>Docling</strong>: See <a href="#start-native-services" class="">Stop, start, and inspect native services</a>.</p>
</li>
</ul></div></div></div>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="stop-and-start-containers">Stop and start containers<a href="#stop-and-start-containers" class="hash-link" aria-label="Direct link to Stop and start containers" title="Direct link to Stop and start containers" translate="no"></a></h2> <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="stop-and-start-containers">Stop and start containers<a href="#stop-and-start-containers" class="hash-link" aria-label="Direct link to Stop and start containers" title="Direct link to Stop and start containers" translate="no"></a></h2>
<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">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>In the TUI&#x27;s <strong>Status</strong> menu (<kbd>3</kbd>), click <strong>Stop Services</strong> to stop all OpenRAG container-based services. <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">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>On the TUI&#x27;s <strong>Status</strong> page, you can stop, start, and restart OpenRAG&#x27;s container-based services.</p><p>When you click <strong>Restart</strong> or <strong>Start Services</strong>, the following processes are triggered:</p><ol>
Then, click <strong>Start All Services</strong> to restart the OpenRAG containers.</p><p>When you click <strong>Start All Services</strong>, the following processes are triggered:</p><ol>
<li class=""> <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 because there are separate Docker Compose files for GPU and CPU deployments.</p> <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 because there are separate Docker Compose files for GPU and CPU deployments.</p>
</li> </li>
@ -52,10 +32,7 @@ Then, click <strong>Start All Services</strong> to restart the OpenRAG container
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Use <a href="https://docs.docker.com/reference/cli/docker/compose/down/" target="_blank" rel="noopener noreferrer" class=""><code>docker compose down</code></a> and <a href="https://docs.docker.com/reference/cli/docker/compose/up/" target="_blank" rel="noopener noreferrer" class=""><code>docker compose up -d</code></a>.</p><p>To stop or start individual containers, use targeted commands like <code>docker stop CONTAINER_ID</code> and <code>docker start CONTAINER_ID</code>.</p></div></div></div> </ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Use <a href="https://docs.docker.com/reference/cli/docker/compose/down/" target="_blank" rel="noopener noreferrer" class=""><code>docker compose down</code></a> and <a href="https://docs.docker.com/reference/cli/docker/compose/up/" target="_blank" rel="noopener noreferrer" class=""><code>docker compose up -d</code></a>.</p><p>To stop or start individual containers, use targeted commands like <code>docker stop CONTAINER_ID</code> and <code>docker start CONTAINER_ID</code>.</p></div></div></div>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="start-native-services">Stop, start, and inspect native services (Docling)<a href="#start-native-services" class="hash-link" aria-label="Direct link to Stop, start, and inspect native services (Docling)" title="Direct link to Stop, start, and inspect native services (Docling)" translate="no"></a></h2> <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="start-native-services">Stop, start, and inspect native services (Docling)<a href="#start-native-services" class="hash-link" aria-label="Direct link to Stop, start, and inspect native services (Docling)" title="Direct link to Stop, start, and inspect native services (Docling)" translate="no"></a></h2>
<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>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>
<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">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>From the TUI&#x27;s <strong>Status</strong> menu (<kbd>3</kbd>), click <strong>Native Services</strong> to do the following:</p><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">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>On the TUI&#x27;s <strong>Status</strong> page, you can stop, start, restart, and inspect OpenRAG&#x27;s native services.</p><p>The <strong>Native Services</strong> section lists the status, port, and process ID (PID) for each native service.</p><p>To manage a native service, click the service&#x27;s name, and then click <strong>Stop</strong>, <strong>Start</strong> or <strong>Restart</strong>.</p><p>To view the logs for a native service, click the service&#x27;s name, and then press <kbd>l</kbd>.</p></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Because the Docling service doesn&#x27;t run in a container, you must start and stop it manually on the host machine:</p><ul>
<li class="">View the service&#x27;s status, port, and process ID (PID).</li>
<li class="">Stop, start, and restart native services.</li>
</ul></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Because the Docling service doesn&#x27;t run in a container, you must start and stop it manually on the host machine:</p><ul>
<li class=""> <li class="">
<p>Stop <code>docling serve</code>:</p> <p>Stop <code>docling serve</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 run python scripts/docling_ctl.py stop</span><br></span></code></pre></div></div> <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 python scripts/docling_ctl.py stop</span><br></span></code></pre></div></div>
@ -87,7 +64,7 @@ Your documents are reingested into a fresh OpenSearch index after the reset.</p>
<li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, and you want to preserve those changes, then you must <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Afterwards, you can import your flows or reference the exported flow JSON as needed.</li> <li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, and you want to preserve those changes, then you must <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Afterwards, you can import your flows or reference the exported flow JSON as needed.</li>
</ol><ol start="2"> </ol><ol start="2">
<li class=""> <li class="">
<p>To destroy and recreate your OpenRAG containers, open the TUI&#x27;s <strong>Status</strong> menu (<kbd>3</kbd>), and then click <strong>Factory Reset</strong>.</p> <p>To destroy and recreate your OpenRAG containers, click <strong>Status</strong> in the TUI, and then click <strong>Factory Reset</strong>.</p>
</li> </li>
<li class=""> <li class="">
<p>Repeat the <a class="" href="/install#setup">setup process</a> to restart 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> <p>Repeat the <a class="" href="/install#setup">setup process</a> to restart 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>
@ -110,7 +87,7 @@ Your documents are reingested into a fresh OpenSearch index after the reset.</p>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="see-also">See also<a href="#see-also" class="hash-link" aria-label="Direct link to See also" title="Direct link to See also" translate="no"></a></h2> <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="see-also">See also<a href="#see-also" class="hash-link" aria-label="Direct link to See also" title="Direct link to See also" translate="no"></a></h2>
<ul> <ul>
<li class=""><a class="" href="/uninstall">Uninstall OpenRAG</a></li> <li class=""><a class="" href="/uninstall">Uninstall OpenRAG</a></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/manage-services.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="/tui"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Use the TUI</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/agents"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Flows</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="#monitor-services" class="table-of-contents__link toc-highlight">Monitor services</a></li><li><a href="#stop-and-start-containers" class="table-of-contents__link toc-highlight">Stop and start containers</a></li><li><a href="#start-native-services" class="table-of-contents__link toc-highlight">Stop, start, and inspect native services (Docling)</a></li><li><a href="#upgrade-services" class="table-of-contents__link toc-highlight">Upgrade services</a></li><li><a href="#reset-containers" class="table-of-contents__link toc-highlight">Reset containers (destructive)</a></li><li><a href="#see-also" class="table-of-contents__link toc-highlight">See also</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"> </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/manage-services.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="/tui"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Use the TUI</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/agents"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Flows</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="#monitor-services-and-view-logs" class="table-of-contents__link toc-highlight">Monitor services and view logs</a></li><li><a href="#stop-and-start-containers" class="table-of-contents__link toc-highlight">Stop and start containers</a></li><li><a href="#start-native-services" class="table-of-contents__link toc-highlight">Stop, start, and inspect native services (Docling)</a></li><li><a href="#upgrade-services" class="table-of-contents__link toc-highlight">Upgrade services</a></li><li><a href="#reset-containers" class="table-of-contents__link toc-highlight">Reset containers (destructive)</a></li><li><a href="#see-also" class="table-of-contents__link toc-highlight">See also</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> <span>© 2025 OpenRAG</span>
</div></li></ul></div></div></div></footer></div> </div></li></ul></div></div></div></footer></div>
</body> </body>

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Quickstart | 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/quickstart"><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="Quickstart | OpenRAG"><meta data-rh="true" name="description" content="Use this quickstart to install OpenRAG, and then try some of OpenRAG&#x27;s core features."><meta data-rh="true" property="og:description" content="Use this quickstart to install OpenRAG, and then try some of OpenRAG&#x27;s core features."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/quickstart"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/quickstart" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/quickstart" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Quickstart","item":"https://docs.openr.ag/quickstart"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Quickstart | 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/quickstart"><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="Quickstart | OpenRAG"><meta data-rh="true" name="description" content="Use this quickstart to install OpenRAG, and then try some of OpenRAG&#x27;s core features."><meta data-rh="true" property="og:description" content="Use this quickstart to install OpenRAG, and then try some of OpenRAG&#x27;s core features."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/quickstart"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/quickstart" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/quickstart" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Quickstart","item":"https://docs.openr.ag/quickstart"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">
@ -40,30 +40,30 @@ The script installs OpenRAG dependencies, including Docker or Podman, and then i
You might be prompted to install certain dependencies if they aren&#x27;t already present in your environment.</p> You might be prompted to install certain dependencies if they aren&#x27;t already present in your environment.</p>
<p>The entire process can take a few minutes. <p>The entire process can take a few minutes.
Once the environment is ready, the OpenRAG <a class="" href="/tui">Terminal User Interface (TUI)</a> starts.</p> Once the environment is ready, the OpenRAG <a class="" href="/tui">Terminal User Interface (TUI)</a> starts.</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><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>
</li> </li>
<li class=""> <li class="">
<p>In the TUI, click <strong>Basic Setup</strong>.</p> <p>In the TUI, click <strong>Basic Setup</strong>.</p>
</li> </li>
<li class=""> <li class="">
<p>Click <strong>Generate Passwords</strong> to create administrator passwords for your OpenRAG OpenSearch and Langflow services.</p> <p>For <strong>Langflow Admin Password</strong>, click <strong>Generate Password</strong> to create a Langflow administrator password and username.</p>
</li> </li>
<li class=""> <li class="">
<p>Leave the <strong>OpenAI API key</strong> field empty.</p> <p>Use the default values for all other fields.</p>
</li> </li>
<li class=""> <li class="">
<p>Click <strong>Save Configuration</strong>, and then click <strong>Start All Services</strong>.</p> <p>Click <strong>Save Configuration</strong>.</p>
<p>Your OpenRAG configuration and passwords are stored in an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> file that is created automatically at <code>~/.openrag/tui</code>.
OpenRAG container definitions are stored in the <code>docker-compose</code> files in the same directory.</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. <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> 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> <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>
<p>Your OpenRAG configuration and passwords are stored in an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> file that is created automatically at <code>~/.openrag/tui</code>.
Container definitions are stored in the <code>docker-compose</code> files in the same directory.</p>
</li> </li>
<li class=""> <li class="">
<p>Under <a class="" href="/manage-services"><strong>Native Services</strong></a>, click <strong>Start</strong> to start the Docling service.</p> <p>Click <strong>Close</strong>, and then click <strong>Launch OpenRAG</strong> to access the OpenRAG application and start the application onboarding process.</p>
</li>
<li class="">
<p>From the TUI main menu, click <strong>Open App</strong> to launch the OpenRAG application and start the application onboarding process.</p>
</li> </li>
<li class=""> <li class="">
<p>For this quickstart, select the <strong>OpenAI</strong> model provider, enter your OpenAI API key, and then click <strong>Complete</strong>. Use the default settings for all other model options.</p> <p>For this quickstart, select the <strong>OpenAI</strong> model provider, enter your OpenAI API key, and then click <strong>Complete</strong>. Use the default settings for all other model options.</p>

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Environment variables | 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/reference/configuration"><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="Environment variables | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG&#x27;s .env file is the primary configuration file for OpenRAG."><meta data-rh="true" property="og:description" content="OpenRAG&#x27;s .env file is the primary configuration file for OpenRAG."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/reference/configuration"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reference/configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reference/configuration" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Environment variables","item":"https://docs.openr.ag/reference/configuration"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Environment variables | 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/reference/configuration"><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="Environment variables | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG&#x27;s .env file is the primary configuration file for OpenRAG."><meta data-rh="true" property="og:description" content="OpenRAG&#x27;s .env file is the primary configuration file for OpenRAG."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/reference/configuration"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reference/configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reference/configuration" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Environment variables","item":"https://docs.openr.ag/reference/configuration"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">
@ -20,7 +20,7 @@ Environment variables in <code>.env</code> always take precedence over other sou
<p>If a variable isn&#x27;t set, OpenRAG uses default or fallback values where available. <p>If a variable isn&#x27;t set, OpenRAG uses default or fallback values where available.
Not all variables have default values, and errors can occur if required variables aren&#x27;t set. Not all variables have default values, and errors can occur if required variables aren&#x27;t set.
Default values can be found in the reference tables on this page and in <a href="https://github.com/langflow-ai/openrag/blob/main/src/config/config_manager.py" target="_blank" rel="noopener noreferrer" class=""><code>config_manager.py</code></a>, <a href="https://github.com/langflow-ai/openrag/blob/main/src/config/settings.py" target="_blank" rel="noopener noreferrer" class=""><code>settings.py</code></a>, and <a href="https://github.com/langflow-ai/openrag/blob/main/src/utils/logging_config.py" target="_blank" rel="noopener noreferrer" class=""><code>logging_config.py</code></a>.</p> Default values can be found in the reference tables on this page and in <a href="https://github.com/langflow-ai/openrag/blob/main/src/config/config_manager.py" target="_blank" rel="noopener noreferrer" class=""><code>config_manager.py</code></a>, <a href="https://github.com/langflow-ai/openrag/blob/main/src/config/settings.py" target="_blank" rel="noopener noreferrer" class=""><code>settings.py</code></a>, and <a href="https://github.com/langflow-ai/openrag/blob/main/src/utils/logging_config.py" target="_blank" rel="noopener noreferrer" class=""><code>logging_config.py</code></a>.</p>
<p>You can <a href="#modify-a-flow-at-runtime" class="">temporarily set Langflow variables at runtime</a>. <p>You can <a class="" href="/agents#modify-a-flow-at-runtime">temporarily set Langflow variables at runtime</a>.
However, these temporary overrides don&#x27;t overlap with most OpenRAG environment variables. However, these temporary overrides don&#x27;t overlap with most OpenRAG environment variables.
The only exceptions are flow-level Langflow settings, such as the language model used in a flow.</p> The only exceptions are flow-level Langflow settings, such as the language model used in a flow.</p>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="set-environment-variables">Edit the <code>.env</code> file<a href="#set-environment-variables" class="hash-link" aria-label="Direct link to set-environment-variables" title="Direct link to set-environment-variables" translate="no"></a></h2> <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="set-environment-variables">Edit the <code>.env</code> file<a href="#set-environment-variables" class="hash-link" aria-label="Direct link to set-environment-variables" title="Direct link to set-environment-variables" translate="no"></a></h2>

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Reinstall 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/reinstall"><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="Reinstall OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="You can reset your OpenRAG deployment to its initial state by recreating the containers and deleting accessory data, such as the .env file and ingested documents."><meta data-rh="true" property="og:description" content="You can reset your OpenRAG deployment to its initial state by recreating the containers and deleting accessory data, such as the .env file and ingested documents."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/reinstall"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reinstall" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reinstall" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Reinstall OpenRAG","item":"https://docs.openr.ag/reinstall"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Reinstall 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/reinstall"><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="Reinstall OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="You can reset your OpenRAG deployment to its initial state by recreating the containers and deleting accessory data, such as the .env file and ingested documents."><meta data-rh="true" property="og:description" content="You can reset your OpenRAG deployment to its initial state by recreating the containers and deleting accessory data, such as the .env file and ingested documents."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/reinstall"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reinstall" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reinstall" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Reinstall OpenRAG","item":"https://docs.openr.ag/reinstall"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">
@ -20,7 +20,7 @@ Destroyed containers and deleted data are lost and cannot be recovered after run
</ol> </ol>
<ol start="2"> <ol start="2">
<li class=""> <li class="">
<p>In the TUI&#x27;s <strong>Status</strong> menu (<kbd>3</kbd>), click <strong>Factory Reset</strong> to <a class="" href="/manage-services#reset-containers">reset your OpenRAG containers</a>.</p> <p>In the TUI, click <strong>Status</strong>, and then click <strong>Factory Reset</strong> to <a class="" href="/manage-services#reset-containers">reset your OpenRAG containers</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>warning</div><div class="admonitionContent_BuS1"><p>This is a destructive operation that does the following:</p><ul> <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 operation that does the following:</p><ul>
<li class="">Destroys all OpenRAG containers, volumes, and local images.</li> <li class="">Destroys all OpenRAG containers, volumes, and local images.</li>
<li class="">Prunes any additional container objects.</li> <li class="">Prunes any additional container objects.</li>
@ -28,7 +28,7 @@ Destroyed containers and deleted data are lost and cannot be recovered after run
</ul><p></p><p></p>Destroyed containers and deleted data are lost and cannot be recovered after running this operation.<p></p></div></div> </ul><p></p><p></p>Destroyed containers and deleted data are lost and cannot be recovered after running this operation.<p></p></div></div>
</li> </li>
<li class=""> <li class="">
<p>Exit the TUI with <kbd>q</kbd>.</p> <p>Press <kbd>Esc</kbd> to close the <strong>Status</strong> page, and then press <kbd>q</kbd> to exit the TUI.</p>
</li> </li>
<li class=""> <li class="">
<p>Optional: Delete or edit <a class="" href="/reference/configuration">OpenRAG&#x27;s <code>.env</code> file</a>, which is stored at <code>~/.openrag/tui</code>.</p> <p>Optional: Delete or edit <a class="" href="/reference/configuration">OpenRAG&#x27;s <code>.env</code> file</a>, which is stored at <code>~/.openrag/tui</code>.</p>
@ -90,8 +90,9 @@ It is recommended that you preserve OpenRAG&#x27;s <a href="https://github.com/l
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Docker</div><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">docker</span><span class="token plain"> stop </span><span class="token variable" style="color:#36acaa">$(</span><span class="token variable function" style="color:#d73a49">docker</span><span class="token variable" style="color:#36acaa"> </span><span class="token variable function" style="color:#d73a49">ps</span><span class="token variable" style="color:#36acaa"> </span><span class="token variable parameter variable" style="color:#36acaa">-q</span><span class="token variable" style="color:#36acaa">)</span><br></span></code></pre></div></div> <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Docker</div><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">docker</span><span class="token plain"> stop </span><span class="token variable" style="color:#36acaa">$(</span><span class="token variable function" style="color:#d73a49">docker</span><span class="token variable" style="color:#36acaa"> </span><span class="token variable function" style="color:#d73a49">ps</span><span class="token variable" style="color:#36acaa"> </span><span class="token variable parameter variable" style="color:#36acaa">-q</span><span class="token variable" style="color:#36acaa">)</span><br></span></code></pre></div></div>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><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">podman</span><span class="token plain"> stop </span><span class="token parameter variable" style="color:#36acaa">--all</span><br></span></code></pre></div></div> <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><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">podman</span><span class="token plain"> stop </span><span class="token parameter variable" style="color:#36acaa">--all</span><br></span></code></pre></div></div>
</li> </li>
</ol> <li class="">
<ol start="2"> <p>Remove and clean up containers:</p>
<ol>
<li class=""> <li class="">
<p>Remove all containers, including stopped containers:</p> <p>Remove all containers, including stopped containers:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Docker</div><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">docker</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">rm</span><span class="token plain"> </span><span class="token parameter variable" style="color:#36acaa">--force</span><span class="token plain"> </span><span class="token variable" style="color:#36acaa">$(</span><span class="token variable function" style="color:#d73a49">docker</span><span class="token variable" style="color:#36acaa"> </span><span class="token variable function" style="color:#d73a49">ps</span><span class="token variable" style="color:#36acaa"> </span><span class="token variable parameter variable" style="color:#36acaa">-aq</span><span class="token variable" style="color:#36acaa">)</span><br></span></code></pre></div></div> <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Docker</div><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">docker</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">rm</span><span class="token plain"> </span><span class="token parameter variable" style="color:#36acaa">--force</span><span class="token plain"> </span><span class="token variable" style="color:#36acaa">$(</span><span class="token variable function" style="color:#d73a49">docker</span><span class="token variable" style="color:#36acaa"> </span><span class="token variable function" style="color:#d73a49">ps</span><span class="token variable" style="color:#36acaa"> </span><span class="token variable parameter variable" style="color:#36acaa">-aq</span><span class="token variable" style="color:#36acaa">)</span><br></span></code></pre></div></div>
@ -118,7 +119,7 @@ It is recommended that you preserve OpenRAG&#x27;s <a href="https://github.com/l
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><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">podman</span><span class="token plain"> system prune </span><span class="token parameter variable" style="color:#36acaa">--all</span><span class="token plain"> </span><span class="token parameter variable" style="color:#36acaa">--force</span><span class="token plain"> </span><span class="token parameter variable" style="color:#36acaa">--volumes</span><br></span></code></pre></div></div> <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><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">podman</span><span class="token plain"> system prune </span><span class="token parameter variable" style="color:#36acaa">--all</span><span class="token plain"> </span><span class="token parameter variable" style="color:#36acaa">--force</span><span class="token plain"> </span><span class="token parameter variable" style="color:#36acaa">--volumes</span><br></span></code></pre></div></div>
</li> </li>
</ol> </ol>
<ol start="8"> </li>
<li class=""> <li class="">
<p>Optional: Edit OpenRAG&#x27;s <code>.env</code> file if needed.</p> <p>Optional: Edit OpenRAG&#x27;s <code>.env</code> file if needed.</p>
</li> </li>

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Troubleshoot 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/support/troubleshoot"><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="Troubleshoot OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG."><meta data-rh="true" property="og:description" content="This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/support/troubleshoot"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/support/troubleshoot" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/support/troubleshoot" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Troubleshoot OpenRAG","item":"https://docs.openr.ag/support/troubleshoot"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Troubleshoot 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/support/troubleshoot"><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="Troubleshoot OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG."><meta data-rh="true" property="og:description" content="This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/support/troubleshoot"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/support/troubleshoot" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/support/troubleshoot" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Troubleshoot OpenRAG","item":"https://docs.openr.ag/support/troubleshoot"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">
@ -51,7 +51,7 @@ For example, on macOS, this is typically a user cache directory, such as <code>~
<p>This cache can become stale, producing errors like missing dependencies.</p> <p>This cache can become stale, producing errors like missing dependencies.</p>
<ol> <ol>
<li class=""> <li class="">
<p><a class="" href="/tui">Exit the TUI</a>.</p> <p>If the TUI is open, press <kbd>q</kbd> to exit the TUI.</p>
</li> </li>
<li class=""> <li class="">
<p>Clear the <code>uv</code> cache:</p> <p>Clear the <code>uv</code> cache:</p>
@ -64,7 +64,7 @@ For example, on macOS, this is typically a user cache directory, such as <code>~
<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> <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>
</li> </li>
<li class=""> <li class="">
<p>Click <strong>Open App</strong>, and then retry document ingestion.</p> <p>Click <strong>Launch OpenRAG</strong>, and then retry document ingestion.</p>
</li> </li>
</ol> </ol>
<p>If you install OpenRAG with <code>uv</code>, dependencies are synced directly from your <code>pyproject.toml</code> file. <p>If you install OpenRAG with <code>uv</code>, dependencies are synced directly from your <code>pyproject.toml</code> file.

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -4,7 +4,7 @@
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2"> <meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Upgrade 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/upgrade"><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="Upgrade OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="Use these steps to upgrade your OpenRAG deployment to the latest version or a specific version."><meta data-rh="true" property="og:description" content="Use these steps to upgrade your OpenRAG deployment to the latest version or a specific version."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/upgrade"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/upgrade" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/upgrade" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Upgrade OpenRAG","item":"https://docs.openr.ag/upgrade"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css"> <title data-rh="true">Upgrade 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/upgrade"><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="Upgrade OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="Use these steps to upgrade your OpenRAG deployment to the latest version or a specific version."><meta data-rh="true" property="og:description" content="Use these steps to upgrade your OpenRAG deployment to the latest version or a specific version."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/upgrade"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/upgrade" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/upgrade" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Upgrade OpenRAG","item":"https://docs.openr.ag/upgrade"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.0ec053c5.js" defer="defer"></script> <script src="/assets/js/runtime~main.a299070f.js" defer="defer"></script>
<script src="/assets/js/main.b10c6137.js" defer="defer"></script> <script src="/assets/js/main.b10c6137.js" defer="defer"></script>
</head> </head>
<body class="navigation-with-keyboard"> <body class="navigation-with-keyboard">
@ -15,7 +15,7 @@
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="export-customized-flows-before-upgrading">Export customized flows before upgrading<a href="#export-customized-flows-before-upgrading" class="hash-link" aria-label="Direct link to Export customized flows before upgrading" title="Direct link to Export customized flows before upgrading" translate="no"></a></h2> <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="export-customized-flows-before-upgrading">Export customized flows before upgrading<a href="#export-customized-flows-before-upgrading" class="hash-link" aria-label="Direct link to Export customized flows before upgrading" title="Direct link to Export customized flows before upgrading" translate="no"></a></h2>
<p>If you modified the built-in flows or created custom flows in your OpenRAG Langflow instance, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before upgrading. <p>If you modified the built-in flows or created custom flows in your OpenRAG Langflow instance, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before upgrading.
This ensure that you won&#x27;t lose your flows after upgrading, and you can reference the exported flows if there are any breaking changes in the new version.</p> This ensure that you won&#x27;t lose your flows after upgrading, and you can reference the exported flows if there are any breaking changes in the new version.</p>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="upgrade-tui-managed-installations">Upgrade TUI-managed installations<a href="#upgrade-tui-managed-installations" class="hash-link" aria-label="Direct link to Upgrade TUI-managed installations" title="Direct link to Upgrade TUI-managed installations" translate="no"></a></h2> <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="upgrade-tui-managed-deployments">Upgrade TUI-managed deployments<a href="#upgrade-tui-managed-deployments" class="hash-link" aria-label="Direct link to Upgrade TUI-managed deployments" title="Direct link to Upgrade TUI-managed deployments" translate="no"></a></h2>
<p>To upgrade OpenRAG, you need to upgrade the OpenRAG Python package, and then upgrade the OpenRAG containers.</p> <p>To upgrade OpenRAG, you need to upgrade the OpenRAG Python package, and then upgrade the OpenRAG containers.</p>
<p>Upgrading the Python package also upgrades Docling by bumping the dependency in <code>pyproject.toml</code>.</p> <p>Upgrading the Python package also upgrades Docling by bumping the dependency in <code>pyproject.toml</code>.</p>
<p>This is a two-part process because upgrading the OpenRAG Python package updates the Terminal User Interface (TUI) and Python code, but the container versions are controlled by environment variables in your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p> <p>This is a two-part process because upgrading the OpenRAG Python package updates the Terminal User Interface (TUI) and Python code, but the container versions are controlled by environment variables in your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p>
@ -24,11 +24,13 @@ This ensure that you won&#x27;t lose your flows after upgrading, and you can ref
</ol> </ol>
<ol start="2"> <ol start="2">
<li class=""> <li class="">
<p>To check for updates, open the TUI&#x27;s <strong>Status</strong> menu (<kbd>3</kbd>), and then click <strong>Upgrade</strong>.</p> <p>To check for updates, click <strong>Status</strong> in the TUI, and then click <strong>Upgrade</strong>.</p>
</li> </li>
<li class=""> <li class="">
<p>If there is an update, stop all OpenRAG services. <p>If there is an update available, press <kbd>Esc</kbd> to close the <strong>Status</strong> page, then then click <strong>Stop All Services</strong>.</p>
In the <strong>Status</strong> menu, click <strong>Stop Services</strong>.</p> </li>
<li class="">
<p>Press <kbd>q</kbd> to exit the TUI.</p>
</li> </li>
<li class=""> <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>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>.
@ -76,7 +78,7 @@ The commands to upgrade the package depend on how you installed OpenRAG.</p>
</ol></div></div></div> </ol></div></div></div>
</li> </li>
<li class=""> <li class="">
<p>In the OpenRAG TUI, click <strong>Start All Services</strong>, and then wait while the upgraded containers start.</p> <p>In the OpenRAG TUI, click <strong>Start Services</strong>, and then wait while the services start.</p>
<p>When you start services 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>When you start services 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>
<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>Pin container versions</div><div class="admonitionContent_BuS1"><p>In the OpenRAG <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 pulls the <code>latest</code> available container images. <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>Pin container versions</div><div class="admonitionContent_BuS1"><p>In the OpenRAG <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 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. 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.
@ -85,13 +87,10 @@ The TUI warns you if it detects a version mismatch.</p></div></div>
<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> <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>
<li class=""> <li class="">
<p>Under <a class="" href="/manage-services"><strong>Native Services</strong></a>, click <strong>Start</strong> to start the Docling service.</p> <p>After the containers start, click <strong>Close</strong>, and then click <strong>Launch OpenRAG</strong>.</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> </li>
</ol> </ol>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="upgrade-self-managed-containers">Upgrade self-managed containers<a href="#upgrade-self-managed-containers" class="hash-link" aria-label="Direct link to Upgrade self-managed containers" title="Direct link to Upgrade self-managed containers" translate="no"></a></h2> <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="upgrade-self-managed-deployments">Upgrade self-managed deployments<a href="#upgrade-self-managed-deployments" class="hash-link" aria-label="Direct link to Upgrade self-managed deployments" title="Direct link to Upgrade self-managed deployments" translate="no"></a></h2>
<ol> <ol>
<li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, and you want to preserve those changes, then you must <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Afterwards, you can import your flows or reference the exported flow JSON as needed.</li> <li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, and you want to preserve those changes, then you must <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Afterwards, you can import your flows or reference the exported flow JSON as needed.</li>
</ol> </ol>
@ -102,12 +101,15 @@ The TUI warns you if it detects a version mismatch.</p></div></div>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><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">podman</span><span class="token plain"> compose pull</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">podman</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">-d</span><span class="token plain"> --force-recreate</span><br></span></code></pre></div></div> <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><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">podman</span><span class="token plain"> compose pull</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">podman</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">-d</span><span class="token plain"> --force-recreate</span><br></span></code></pre></div></div>
<p>By default, OpenRAG&#x27;s <code>docker-compose</code> files pull the latest container images.</p> <p>By default, OpenRAG&#x27;s <code>docker-compose</code> files pull the latest container images.</p>
</li> </li>
<li class="">
<p>After the containers start, access the OpenRAG application at <code>http://localhost:3000</code>.</p>
</li>
</ol> </ol>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="see-also">See also<a href="#see-also" class="hash-link" aria-label="Direct link to See also" title="Direct link to See also" translate="no"></a></h2> <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="see-also">See also<a href="#see-also" class="hash-link" aria-label="Direct link to See also" title="Direct link to See also" translate="no"></a></h2>
<ul> <ul>
<li class=""><a class="" href="/manage-services">Manage OpenRAG services</a></li> <li class=""><a class="" href="/manage-services">Manage OpenRAG services</a></li>
<li class=""><a class="" href="/support/troubleshoot">Troubleshoot OpenRAG</a></li> <li class=""><a class="" href="/support/troubleshoot">Troubleshoot OpenRAG</a></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/upgrade.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="/docker"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Deploy self-managed services</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/reinstall"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Reinstall OpenRAG</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="#export-customized-flows-before-upgrading" class="table-of-contents__link toc-highlight">Export customized flows before upgrading</a></li><li><a href="#upgrade-tui-managed-installations" class="table-of-contents__link toc-highlight">Upgrade TUI-managed installations</a></li><li><a href="#upgrade-self-managed-containers" class="table-of-contents__link toc-highlight">Upgrade self-managed containers</a></li><li><a href="#see-also" class="table-of-contents__link toc-highlight">See also</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"> </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/upgrade.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="/docker"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Deploy self-managed services</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/reinstall"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Reinstall OpenRAG</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="#export-customized-flows-before-upgrading" class="table-of-contents__link toc-highlight">Export customized flows before upgrading</a></li><li><a href="#upgrade-tui-managed-deployments" class="table-of-contents__link toc-highlight">Upgrade TUI-managed deployments</a></li><li><a href="#upgrade-self-managed-deployments" class="table-of-contents__link toc-highlight">Upgrade self-managed deployments</a></li><li><a href="#see-also" class="table-of-contents__link toc-highlight">See also</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> <span>© 2025 OpenRAG</span>
</div></li></ul></div></div></div></footer></div> </div></li></ul></div></div></div></footer></div>
</body> </body>