deploy: a460fd05fd
This commit is contained in:
parent
950b0ffabf
commit
7c8450169a
46 changed files with 176 additions and 244 deletions
2
404.html
2
404.html
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -33,7 +33,7 @@ To further explore and edit the flow, click <strong>Edit in Langflow</strong> to
|
|||
<li class="">
|
||||
<p>Click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-settings2 lucide-settings-2" aria-hidden="true"><path d="M14 17H5"></path><path d="M19 7h-9"></path><circle cx="17" cy="17" r="3"></circle><circle cx="7" cy="7" r="3"></circle></svg> <strong>Settings</strong>, and then click <strong>Edit in Langflow</strong> to launch the Langflow visual editor in a new browser window.</p>
|
||||
<p>If prompted to acknowledge that you are entering Langflow, click <strong>Proceed</strong>.</p>
|
||||
<p>If Langflow requests login information, enter the <code>LANGFLOW_SUPERUSER</code> and <code>LANGFLOW_SUPERUSER_PASSWORD</code> from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> in your OpenRAG installation directory.</p>
|
||||
<p>If Langflow requests login information, enter the <code>LANGFLOW_SUPERUSER</code> and <code>LANGFLOW_SUPERUSER_PASSWORD</code> from your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p>
|
||||
<p><img decoding="async" loading="lazy" alt="OpenRAG OpenSearch Agent flow" src="/assets/images/opensearch-agent-flow-f3b279e02425cd043002eb7749067108.png" width="4084" height="2176" class="img_ev3q"></p>
|
||||
</li>
|
||||
<li class="">
|
||||
|
|
@ -53,6 +53,10 @@ This is a destructive action that discards all customizations to the flow.</p>
|
|||
<li class="">Use <a href="https://docs.langflow.org/mcp-client" target="_blank" rel="noopener noreferrer" class="">MCP clients</a> and <a href="https://docs.langflow.org/mcp-server" target="_blank" rel="noopener noreferrer" class="">MCP servers</a>, and serve flows as MCP tools for your agentic flows.</li>
|
||||
</ul>
|
||||
<p>Explore the <a href="https://docs.langflow.org/" target="_blank" rel="noopener noreferrer" class="">Langflow documentation</a> to learn more about the Langflow platform, features, and visual editor.</p>
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="modify-a-flow-at-runtime">Modify a flow at runtime<a href="#modify-a-flow-at-runtime" class="hash-link" aria-label="Direct link to Modify a flow at runtime" title="Direct link to Modify a flow at runtime" translate="no"></a></h2>
|
||||
<p>You can use <em>tweaks</em> to modify flow settings at runtime without permanently changing the flow's configuration.
|
||||
Tweaks are one-time parameter modifications that are passed to specific Langflow components during flow execution.
|
||||
For more information on tweaks, see the Langflow documentation on <a href="https://docs.langflow.org/concepts-publish#input-schema" target="_blank" rel="noopener noreferrer" class="">Input schema (tweaks)</a>.</p>
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="set-the-langflow-version">Set the Langflow version<a href="#set-the-langflow-version" class="hash-link" aria-label="Direct link to Set the Langflow version" title="Direct link to Set the Langflow version" translate="no"></a></h2>
|
||||
<p>By default, OpenRAG is pinned to the latest Langflow Docker image for stability.</p>
|
||||
<p>If necessary, you can set a specific Langflow version with the <code>LANGFLOW_VERSION</code> <a class="" href="/reference/configuration">environment variable</a>. However, there are risks to changing this setting:</p>
|
||||
|
|
@ -66,7 +70,7 @@ This is a destructive action that discards all customizations to the flow.</p>
|
|||
<li class="">
|
||||
<p>Default settings and behaviors might change causing unexpected results when OpenRAG expects a newer default.</p>
|
||||
</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/core-components/agents.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="/manage-services"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Manage services</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/knowledge"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Configure knowledge</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="#inspect-and-modify-flows" class="table-of-contents__link toc-highlight">Inspect and modify flows</a><ul><li><a href="#revert-a-built-in-flow-to-its-original-configuration" class="table-of-contents__link toc-highlight">Revert a built-in flow to its original configuration</a></li></ul></li><li><a href="#build-custom-flows-and-use-other-langflow-functionality" class="table-of-contents__link toc-highlight">Build custom flows and use other Langflow functionality</a></li><li><a href="#set-the-langflow-version" class="table-of-contents__link toc-highlight">Set the Langflow version</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/core-components/agents.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="/manage-services"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Manage services</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/knowledge"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Configure knowledge</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="#inspect-and-modify-flows" class="table-of-contents__link toc-highlight">Inspect and modify flows</a><ul><li><a href="#revert-a-built-in-flow-to-its-original-configuration" class="table-of-contents__link toc-highlight">Revert a built-in flow to its original configuration</a></li></ul></li><li><a href="#build-custom-flows-and-use-other-langflow-functionality" class="table-of-contents__link toc-highlight">Build custom flows and use other Langflow functionality</a></li><li><a href="#modify-a-flow-at-runtime" class="table-of-contents__link toc-highlight">Modify a flow at runtime</a></li><li><a href="#set-the-langflow-version" class="table-of-contents__link toc-highlight">Set the Langflow version</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
|
||||
<span>© 2025 OpenRAG</span>
|
||||
</div></li></ul></div></div></div></footer></div>
|
||||
</body>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
1
assets/js/03ef5215.7da8ea5b.js
Normal file
1
assets/js/03ef5215.7da8ea5b.js
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1 +1 @@
|
|||
"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 using 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)}}}]);
|
||||
"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
1
assets/js/33362219.9fafa665.js
Normal file
1
assets/js/33362219.9fafa665.js
Normal file
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
1
assets/js/52896773.a3757d4b.js
Normal file
1
assets/js/52896773.a3757d4b.js
Normal file
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
1
assets/js/915a24fd.fd7e64ec.js
Normal file
1
assets/js/915a24fd.fd7e64ec.js
Normal file
File diff suppressed because one or more lines are too long
1
assets/js/af920ffe.492f9e55.js
Normal file
1
assets/js/af920ffe.492f9e55.js
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1
assets/js/c5b64a02.52bf4eef.js
Normal file
1
assets/js/c5b64a02.52bf4eef.js
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1
assets/js/c8078f0a.4baa8196.js
Normal file
1
assets/js/c8078f0a.4baa8196.js
Normal file
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
1
assets/js/ca2c3c0c.ca722922.js
Normal file
1
assets/js/ca2c3c0c.ca722922.js
Normal file
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
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -29,7 +29,7 @@ Then, the chunks, embeddings, and associated metadata (which connects chunks of
|
|||
</li>
|
||||
<li class="">
|
||||
<p>To upload one file, click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-file" aria-hidden="true"><path d="M6 22a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h8a2.4 2.4 0 0 1 1.704.706l3.588 3.588A2.4 2.4 0 0 1 20 8v12a2 2 0 0 1-2 2z"></path><path d="M14 2v5a1 1 0 0 0 1 1h5"></path></svg> <strong>File</strong>. To upload all documents in a folder, click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-folder" aria-hidden="true"><path d="M20 20a2 2 0 0 0 2-2V8a2 2 0 0 0-2-2h-7.9a2 2 0 0 1-1.69-.9L9.6 3.9A2 2 0 0 0 7.93 3H4a2 2 0 0 0-2 2v13a2 2 0 0 0 2 2Z"></path></svg> <strong>Folder</strong>.</p>
|
||||
<p>The default path is the <code>./documents</code> subdirectory in your OpenRAG installation directory.
|
||||
<p>The default path is <code>~/.openrag/documents</code>.
|
||||
To change this path, see <a class="" href="/knowledge#set-the-local-documents-path">Set the local documents path</a>.</p>
|
||||
</li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -35,8 +35,8 @@ Depending on your use case, OpenRAG can assist with service management, or you c
|
|||
This is required for all installation methods because it prepares the minimum required configuration for OpenRAG to run.
|
||||
For TUI-managed services, you must also complete initial setup before you start the OpenRAG services.
|
||||
For more information, see the instructions for your preferred installation method.</p>
|
||||
<p>Your OpenRAG configuration is stored in a <code>.env</code> file in the OpenRAG installation directory.
|
||||
When using TUI-managed services, this file is created automatically, or you can provide a pre-populated <code>.env</code> file before starting the TUI.
|
||||
<p>Your OpenRAG configuration is stored in a <code>.env</code> file.
|
||||
When using TUI-managed services, this file is created automatically at <code>~/.openrag/tui</code>, or you can provide a pre-populated <code>.env</code> file in this directory before starting the TUI.
|
||||
The TUI prompts you for the required values during setup and onboarding, and any values detected in a preexisting <code>.env</code> file are populated automatically.
|
||||
When using self-managed services, you must provide a pre-populated <code>.env</code> file, as you would for any Docker or Podman deployment.
|
||||
For more information, see the instructions for your preferred installation method and the <a class="" href="/reference/configuration">OpenRAG environment variables reference</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/get-started/install-options.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/quickstart"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Quickstart</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/install"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Run the installer script</div></a></nav></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">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -95,7 +95,7 @@ This is recommended because it adds OpenRAG to your <code>pyproject.toml</code>
|
|||
<p>For more options, see <a href="https://docs.astral.sh/uv/concepts/projects/dependencies/" target="_blank" rel="noopener noreferrer" class="">Managing dependencies with <code>uv</code></a>.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Optional: If you want to use a pre-populated <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>, copy it to this directory before starting OpenRAG.</p>
|
||||
<p>Optional: If you want to use a pre-populated <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>, create one at <code>~/.openrag/tui</code> before starting OpenRAG.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Start the OpenRAG TUI:</p>
|
||||
|
|
@ -112,7 +112,7 @@ This is recommended because it adds OpenRAG to your <code>pyproject.toml</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">uv pip </span><span class="token function" style="color:#d73a49">install</span><span class="token plain"> openrag</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Optional: If you want to use a pre-populated <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>, copy it to this directory before starting OpenRAG.</p>
|
||||
<p>Optional: If you want to use a pre-populated <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>, create one at <code>~/.openrag/tui</code> before starting OpenRAG.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Start the OpenRAG TUI:</p>
|
||||
|
|
@ -122,7 +122,7 @@ This is recommended because it adds OpenRAG to your <code>pyproject.toml</code>
|
|||
<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 <code>uv</code>, you manage the OpenRAG services with the TUI.
|
||||
The TUI guides you through the initial configuration process before you start the OpenRAG services.</p>
|
||||
<p>Your configuration values are stored in an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> that is created automatically in the Python project where you installed OpenRAG.
|
||||
<p>Your configuration values are stored in an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> that is created automatically at <code>~/.openrag/tui</code>.
|
||||
If OpenRAG detects an existing <code>.env</code> file in this directory, then the TUI can populate those values automatically during setup and onboarding.</p>
|
||||
<p>Container definitions are stored in the <code>docker-compose</code> files in the same directory as the OpenRAG <code>.env</code> file.</p>
|
||||
<p>You can use either <strong>Basic Setup</strong> or <strong>Advanced Setup</strong> to configure OpenRAG.
|
||||
|
|
@ -163,7 +163,7 @@ If you want to use a different model provider, you can leave this field empty.</
|
|||
</li>
|
||||
<li class="">
|
||||
<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> in your OpenRAG installation directory.
|
||||
<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>.
|
||||
If you modified any credentials that were pulled from an existing <code>.env</code> file, those values are updated in the <code>.env</code> file.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
|
|
@ -205,7 +205,7 @@ If you aren't sure which models or providers to use, you must provide an Op
|
|||
If you want to use a different model provider, you can leave this field empty.</p>
|
||||
</li>
|
||||
<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> in the OpenRAG installation directory.</p>
|
||||
<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>
|
||||
<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>
|
||||
|
|
@ -220,7 +220,7 @@ Register these redirect values with your OAuth provider as they are presented in
|
|||
</li>
|
||||
<li class="">
|
||||
<p>Click <strong>Save Configuration</strong>.</p>
|
||||
<p>Your passwords, API key, and OAuth credentials, if provided, are stored in the <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> in your OpenRAG installation directory.
|
||||
<p>Your passwords, API key, and OAuth credentials, if provided, are stored in the <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> at <code>~/.openrag/tui</code>.
|
||||
If you modified any credentials that were pulled from an existing <code>.env</code> file, those values are updated in the <code>.env</code> file.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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'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'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.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -61,7 +61,7 @@ Anthropic provides language models only; you must select an additional provider
|
|||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">mkdir</span><span class="token plain"> openrag-workspace</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token builtin class-name">cd</span><span class="token plain"> openrag-workspace</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Optional: If you want to use a pre-populated <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>, copy it to this directory before invoking OpenRAG.</p>
|
||||
<p>Optional: If you want to use a pre-populated <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>, create one at <code>~/.openrag/tui</code> before invoking OpenRAG.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Invoke OpenRAG:</p>
|
||||
|
|
@ -78,7 +78,7 @@ After clearing the cache, you can re-invoke OpenRAG (<code>uvx openrag</code>) t
|
|||
<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 <code>uvx</code>, you manage the OpenRAG services with the TUI.
|
||||
The TUI guides you through the initial configuration process before you start the OpenRAG services.</p>
|
||||
<p>Your configuration values are stored in an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> that is created automatically in the OpenRAG installation directory, which is the directory where you invoked OpenRAG.
|
||||
<p>Your configuration values are stored in an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> that is created automatically at <code>~/.openrag/tui</code>.
|
||||
If OpenRAG detects an existing <code>.env</code> file in this directory, then the TUI can populate those values automatically during setup and onboarding.</p>
|
||||
<p>Container definitions are stored in the <code>docker-compose</code> files in the same directory as the OpenRAG <code>.env</code> file.</p>
|
||||
<p>You can use either <strong>Basic Setup</strong> or <strong>Advanced Setup</strong> to configure OpenRAG.
|
||||
|
|
@ -119,7 +119,7 @@ If you want to use a different model provider, you can leave this field empty.</
|
|||
</li>
|
||||
<li class="">
|
||||
<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> in your OpenRAG installation directory.
|
||||
<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>.
|
||||
If you modified any credentials that were pulled from an existing <code>.env</code> file, those values are updated in the <code>.env</code> file.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
|
|
@ -161,7 +161,7 @@ If you aren't sure which models or providers to use, you must provide an Op
|
|||
If you want to use a different model provider, you can leave this field empty.</p>
|
||||
</li>
|
||||
<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> in the OpenRAG installation directory.</p>
|
||||
<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>
|
||||
<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>
|
||||
|
|
@ -176,7 +176,7 @@ Register these redirect values with your OAuth provider as they are presented in
|
|||
</li>
|
||||
<li class="">
|
||||
<p>Click <strong>Save Configuration</strong>.</p>
|
||||
<p>Your passwords, API key, and OAuth credentials, if provided, are stored in the <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> in your OpenRAG installation directory.
|
||||
<p>Your passwords, API key, and OAuth credentials, if provided, are stored in the <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> at <code>~/.openrag/tui</code>.
|
||||
If you modified any credentials that were pulled from an existing <code>.env</code> file, those values are updated in the <code>.env</code> file.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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're using Windows, you must install OpenRAG within the Windows Subsystem for Linux (WSL)."><meta data-rh="true" property="og:description" content="If you'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.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Install OpenRAG with the automatic installer script | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="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's core features, try the quickstart."><meta data-rh="true" property="og:description" content="To quickly install and test OpenRAG's core features, try the quickstart."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Run the installer script","item":"https://docs.openr.ag/install"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -69,7 +69,7 @@ After clearing the cache, run <code>uvx openrag</code> to <a class="" href="/tui
|
|||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="setup">Set up OpenRAG with the TUI<a href="#setup" class="hash-link" aria-label="Direct link to Set up OpenRAG with the TUI" title="Direct link to Set up OpenRAG with the TUI" translate="no"></a></h2>
|
||||
<p>When you install OpenRAG with the installer script, you manage the OpenRAG services with the TUI.
|
||||
The TUI guides you through the initial configuration process before you start the OpenRAG services.</p>
|
||||
<p>Your configuration values are stored in an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> that is created automatically in the OpenRAG installation directory, which is the directory where you ran the installer script.
|
||||
<p>Your configuration values are stored in an <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> that is created automatically at <code>~/.openrag/tui</code>.
|
||||
If OpenRAG detects an existing <code>.env</code> file in this directory, then the TUI can populate those values automatically during setup and onboarding.</p>
|
||||
<p>Container definitions are stored in the <code>docker-compose</code> files in the same directory as the OpenRAG <code>.env</code> file.</p>
|
||||
<p>You can use either <strong>Basic Setup</strong> or <strong>Advanced Setup</strong> to configure OpenRAG.
|
||||
|
|
@ -110,7 +110,7 @@ If you want to use a different model provider, you can leave this field empty.</
|
|||
</li>
|
||||
<li class="">
|
||||
<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> in your OpenRAG installation directory.
|
||||
<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>.
|
||||
If you modified any credentials that were pulled from an existing <code>.env</code> file, those values are updated in the <code>.env</code> file.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
|
|
@ -152,7 +152,7 @@ If you aren't sure which models or providers to use, you must provide an Op
|
|||
If you want to use a different model provider, you can leave this field empty.</p>
|
||||
</li>
|
||||
<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> in the OpenRAG installation directory.</p>
|
||||
<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>
|
||||
<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>
|
||||
|
|
@ -167,7 +167,7 @@ Register these redirect values with your OAuth provider as they are presented in
|
|||
</li>
|
||||
<li class="">
|
||||
<p>Click <strong>Save Configuration</strong>.</p>
|
||||
<p>Your passwords, API key, and OAuth credentials, if provided, are stored in the <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> in your OpenRAG installation directory.
|
||||
<p>Your passwords, API key, and OAuth credentials, if provided, are stored in the <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a> at <code>~/.openrag/tui</code>.
|
||||
If you modified any credentials that were pulled from an existing <code>.env</code> file, those values are updated in the <code>.env</code> file.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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'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'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.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -118,11 +118,11 @@ The default value is 200 characters, which represents an overlap of 20 percent i
|
|||
</li>
|
||||
</ul>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="set-the-local-documents-path">Set the local documents path<a href="#set-the-local-documents-path" class="hash-link" aria-label="Direct link to Set the local documents path" title="Direct link to Set the local documents path" translate="no"></a></h3>
|
||||
<p>The default path for local uploads is the <code>./openrag-documents</code> subdirectory in your OpenRAG installation directory. This is mounted to the <code>/app/openrag-documents/</code> directory inside the OpenRAG container. Files added to the host or container directory are visible in both locations.</p>
|
||||
<p>The default path for local uploads is <code>~/.openrag/documents</code>. This is mounted to the <code>/app/openrag-documents/</code> directory inside the OpenRAG container. Files added to the host or container directory are visible in both locations.</p>
|
||||
<p>To change this location, modify the <strong>Documents Paths</strong> variable in either the <a class="" href="/install#setup"><strong>Advanced Setup</strong> menu</a> or in your <a class="" href="/reference/configuration">OpenRAG <code>.env</code> file</a>.</p>
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="delete-knowledge">Delete knowledge<a href="#delete-knowledge" class="hash-link" aria-label="Direct link to Delete knowledge" title="Direct link to Delete knowledge" translate="no"></a></h2>
|
||||
<p>To clear your entire knowledge base, delete the contents of the <code>./opensearch-data</code> folder in your OpenRAG installation directory.
|
||||
This is a destructive operation that cannot be undone.</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 cannot be undone.</p></div></div>
|
||||
<p>To clear your entire knowledge base, <a class="" href="/manage-services#reset-containers">reset your OpenRAG containers</a> or <a class="" href="/reinstall">reinstall OpenRAG</a>.</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>
|
||||
<ul>
|
||||
<li class=""><a class="" href="/ingestion">Ingest knowledge</a></li>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -74,68 +74,43 @@ Then, click <strong>Start All Services</strong> to restart the OpenRAG container
|
|||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="upgrade-services">Upgrade services<a href="#upgrade-services" class="hash-link" aria-label="Direct link to Upgrade services" title="Direct link to Upgrade services" translate="no"></a></h2>
|
||||
<p>See <a class="" href="/upgrade">Upgrade OpenRAG</a>.</p>
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="reset-containers">Reset containers (destructive)<a href="#reset-containers" class="hash-link" aria-label="Direct link to Reset containers (destructive)" title="Direct link to Reset containers (destructive)" translate="no"></a></h2>
|
||||
<p>Reset your OpenRAG deployment by recreating the containers and removing some related data.</p>
|
||||
<p>To completely reset your OpenRAG deployment and delete all OpenRAG data, see <a class="" href="/reinstall">Reinstall OpenRAG</a>.</p>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="export-customized-flows-before-resetting-containers">Export customized flows before resetting containers<a href="#export-customized-flows-before-resetting-containers" class="hash-link" aria-label="Direct link to Export customized flows before resetting containers" title="Direct link to Export customized flows before resetting containers" translate="no"></a></h3>
|
||||
<p>If you modified the built-in flows or created custom flows in your OpenRAG Langflow instance, and you want to preserve those changes, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before resetting your OpenRAG containers.</p>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="factory-reset-with-the-tui">Factory Reset with the TUI<a href="#factory-reset-with-the-tui" class="hash-link" aria-label="Direct link to Factory Reset with the TUI" title="Direct link to Factory Reset with the TUI" translate="no"></a></h3>
|
||||
<div class="theme-admonition theme-admonition-warning admonition_xJq3 alert alert--warning"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>warning</div><div class="admonitionContent_BuS1"><p>This is a destructive action that does the following:</p><ul>
|
||||
<li class="">Destroys all OpenRAG containers, volumes, and local images with <code>docker compose down --volumes --remove-orphans --rmi local</code>.</li>
|
||||
<li class="">Prunes any additional container objects with <code>docker system prune -f</code>.</li>
|
||||
<li class="">Deletes the contents of OpenRAG's <code>config</code> and <code>./opensearch-data</code> directories.</li>
|
||||
<li class="">Deletes the <code>conversations.json</code> file.</li>
|
||||
</ul><p></p><p></p>Destroyed containers and deleted data are lost and cannot be recovered after running this operation.<p></p><p>This operation <em>doesn't</em> remove the <code>.env</code> file or the contents of the <code>./openrag-documents</code> directory.</p></div></div>
|
||||
<ol>
|
||||
<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="">Prunes any additional container objects.</li>
|
||||
<li class="">Deletes the contents of the <code>~/.openrag</code> directory <em>except</em> for OpenRAG's <code>.env</code> file and the <code>/documents</code> subdirectory.</li>
|
||||
</ul><p></p><p></p>Destroyed containers and deleted data are lost and cannot be recovered after running this operation.<p></p></div></div>
|
||||
<p>Use these steps to reset your OpenRAG deployment by recreating the containers and deleting all data in the <code>~/.openrag</code> directory <em>except</em> for the <code>.env</code> file and the <code>/documents</code> subdirectory.</p>
|
||||
<p>This restores your OpenRAG deployment to a near-initial state while preserving your configuration (in <code>.env</code>) and uploaded documents (in <code>/documents</code>).
|
||||
Your documents are reingested into a fresh OpenSearch index after the reset.</p>
|
||||
<p>To reset your OpenRAG deployment <em>and</em> delete all OpenRAG data, see <a class="" href="/reinstall">Reinstall OpenRAG</a>.</p>
|
||||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">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"><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>
|
||||
</ol><ol start="2">
|
||||
<li class="">
|
||||
<p>To destroy and recreate your OpenRAG containers, open the TUI's <strong>Status</strong> menu (<kbd>3</kbd>), and then click <strong>Factory Reset</strong>.</p>
|
||||
</li>
|
||||
<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>
|
||||
</li>
|
||||
</ol>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="rebuild-self-managed-containers">Rebuild self-managed containers<a href="#rebuild-self-managed-containers" class="hash-link" aria-label="Direct link to Rebuild self-managed containers" title="Direct link to Rebuild self-managed containers" translate="no"></a></h3>
|
||||
<p>This command destroys and recreates the containers. Data stored exclusively on the containers is lost, such as Langflow flows.</p>
|
||||
<p>If you want to preserve customized flows, see <a href="#export-customized-flows-before-resetting-containers" class="">Export customized flows before resetting containers</a>.</p>
|
||||
<p>The <code>.env</code> file, <code>config</code> directory, <code>./openrag-documents</code> directory, <code>./opensearch-data</code> directory, and the <code>conversations.json</code> file are preserved.</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"> compose up </span><span class="token parameter variable" style="color:#36acaa">--build</span><span class="token plain"> --force-recreate --remove-orphans</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">--build</span><span class="token plain"> --force-recreate --remove-orphans</span><br></span></code></pre></div></div>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="destroy-and-recreate-self-managed-containers">Destroy and recreate self-managed containers<a href="#destroy-and-recreate-self-managed-containers" class="hash-link" aria-label="Direct link to Destroy and recreate self-managed containers" title="Direct link to Destroy and recreate self-managed containers" translate="no"></a></h3>
|
||||
<p>Use separate commands to destroy and recreate the containers if you want to modify the configuration or delete other OpenRAG data before recreating the containers.</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>These are destructive operations that reset your OpenRAG deployment to an initial state.
|
||||
Destroyed containers and deleted data are lost and cannot be recovered after running this operation.</p></div></div>
|
||||
<ol>
|
||||
<li class="">
|
||||
<p>Destroy the containers, volumes, and local images, and then remove (prune) any additional container objects:</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"> compose down </span><span class="token parameter variable" style="color:#36acaa">--volumes</span><span class="token plain"> --remove-orphans </span><span class="token parameter variable" style="color:#36acaa">--rmi</span><span class="token plain"> </span><span class="token builtin class-name">local</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">docker</span><span class="token plain"> system prune </span><span class="token parameter variable" style="color:#36acaa">-f</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 down </span><span class="token parameter variable" style="color:#36acaa">--volumes</span><span class="token plain"> --remove-orphans </span><span class="token parameter variable" style="color:#36acaa">--rmi</span><span class="token plain"> </span><span class="token builtin class-name">local</span><span class="token plain"></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"> system prune </span><span class="token parameter variable" style="color:#36acaa">-f</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Optional: Remove data that wasn't deleted by the previous commands:</p>
|
||||
<ul>
|
||||
<li class="">OpenRAG's <code>.env</code> file</li>
|
||||
<li class="">The contents of OpenRAG's <code>config</code> directory</li>
|
||||
<li class="">The contents of the <code>./openrag-documents</code> directory</li>
|
||||
<li class="">The contents of the <code>./opensearch-data</code> directory</li>
|
||||
<li class="">The <code>conversations.json</code> file</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>If you deleted the <code>.env</code> file, prepare a new <code>.env</code> before redeploying the containers.
|
||||
For more information, see <a class="" href="/docker">Deploy OpenRAG with self-managed services</a>.</p>
|
||||
</li>
|
||||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><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>
|
||||
</ol><ol start="2">
|
||||
<li class="">
|
||||
<p>Recreate the 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"> 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">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">--build</span><span class="token plain"> --force-recreate --remove-orphans</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">--build</span><span class="token plain"> --force-recreate --remove-orphans</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Launch the OpenRAG app, and then repeat the <a class="" href="/docker#application-onboarding">application onboarding process</a>.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<li class="">
|
||||
<p>If you exported customized flows, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">import your flows</a> into Langflow after completing the onboarding process.</p>
|
||||
</li>
|
||||
</ol></div></div></div>
|
||||
<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>
|
||||
<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><ul><li><a href="#export-customized-flows-before-resetting-containers" class="table-of-contents__link toc-highlight">Export customized flows before resetting containers</a></li><li><a href="#factory-reset-with-the-tui" class="table-of-contents__link toc-highlight">Factory Reset with the TUI</a></li><li><a href="#rebuild-self-managed-containers" class="table-of-contents__link toc-highlight">Rebuild self-managed containers</a></li><li><a href="#destroy-and-recreate-self-managed-containers" class="table-of-contents__link toc-highlight">Destroy and recreate self-managed containers</a></li></ul></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" 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">
|
||||
<span>© 2025 OpenRAG</span>
|
||||
</div></li></ul></div></div></div></footer></div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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's core features."><meta data-rh="true" property="og:description" content="Use this quickstart to install OpenRAG, and then try some of OpenRAG'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.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -56,7 +56,7 @@ Once the environment is ready, the OpenRAG <a class="" href="/tui">Terminal User
|
|||
<p>This process can take some time while OpenRAG pulls and runs the container images.
|
||||
If all services start successfully, the TUI prints a confirmation message:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Services started successfully</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">Command completed successfully</span><br></span></code></pre></div></div>
|
||||
<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 in your OpenRAG installation directory, which is the directory where you ran the installer script.
|
||||
<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 class="">
|
||||
|
|
@ -94,7 +94,7 @@ You can click a document to view the chunks of the document as they are stored i
|
|||
<p>Click <strong>Add Knowledge</strong> to add your own documents to your OpenRAG knowledge base.</p>
|
||||
<p>For this quickstart, use either the <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-file" aria-hidden="true"><path d="M6 22a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h8a2.4 2.4 0 0 1 1.704.706l3.588 3.588A2.4 2.4 0 0 1 20 8v12a2 2 0 0 1-2 2z"></path><path d="M14 2v5a1 1 0 0 0 1 1h5"></path></svg> <strong>File</strong> or <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-folder" aria-hidden="true"><path d="M20 20a2 2 0 0 0 2-2V8a2 2 0 0 0-2-2h-7.9a2 2 0 0 1-1.69-.9L9.6 3.9A2 2 0 0 0 7.93 3H4a2 2 0 0 0-2 2v13a2 2 0 0 0 2 2Z"></path></svg> <strong>Folder</strong> upload options to load documents from your local machine.
|
||||
<strong>Folder</strong> uploads an entire directory.
|
||||
The default directory is the <code>/openrag-documents</code> subdirectory in your OpenRAG installation directory.</p>
|
||||
The default directory is <code>~/.openrag/documents</code>.</p>
|
||||
<p>For information about the cloud storage provider options, see <a class="" href="/ingestion#oauth-ingestion">Ingest files with OAuth connectors</a>.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
|
|
@ -123,7 +123,7 @@ If a document was chunked improperly, you might need to tweak the ingestion or m
|
|||
</li>
|
||||
<li class="">
|
||||
<p>For greater insight into the underlying <a class="" href="/agents">Langflow flow</a> that drives the OpenRAG chat, click <strong>Edit in Langflow</strong> and then click <strong>Proceed</strong> to launch the Langflow visual editor in a new browser window.</p>
|
||||
<p>If Langflow requests login information, enter the <code>LANGFLOW_SUPERUSER</code> and <code>LANGFLOW_SUPERUSER_PASSWORD</code> from the <code>.env</code> file in your OpenRAG installation directory.</p>
|
||||
<p>If Langflow requests login information, enter the <code>LANGFLOW_SUPERUSER</code> and <code>LANGFLOW_SUPERUSER_PASSWORD</code> from the <code>.env</code> file at <code>~/.openrag/tui</code>.</p>
|
||||
<p>The <strong>OpenRAG OpenSearch Agent</strong> flow opens in a new browser window.</p>
|
||||
<p><img decoding="async" loading="lazy" alt="OpenRAG OpenSearch Agent flow" src="/assets/images/opensearch-agent-flow-f3b279e02425cd043002eb7749067108.png" width="4084" height="2176" class="img_ev3q"></p>
|
||||
</li>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -47,7 +47,7 @@ This example increases the machine size to 8 GB of RAM, which should be sufficie
|
|||
This is likely due to a stale <code>uv</code> cache when you <a class="" href="/install-uvx">install OpenRAG with <code>uvx</code></a>.</p>
|
||||
<p>When you invoke OpenRAG with <code>uvx openrag</code>, <code>uvx</code> creates a cached, ephemeral environment that doesn't modify your project.
|
||||
The location and path of this cache depends on your operating system.
|
||||
For example, on macOS, this is typically a user cache directory, such as <code>/Users/USER_NAME/.cache/uv</code>.</p>
|
||||
For example, on macOS, this is typically a user cache directory, such as <code>~/.cache/uv</code>.</p>
|
||||
<p>This cache can become stale, producing errors like missing dependencies.</p>
|
||||
<ol>
|
||||
<li class="">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Use the TUI | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/tui"><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 the TUI | OpenRAG"><meta data-rh="true" name="description" content="The OpenRAG Terminal User Interface (TUI) provides a simplified and guided experience for configuring, managing, and monitoring your OpenRAG deployment directly from the terminal."><meta data-rh="true" property="og:description" content="The OpenRAG Terminal User Interface (TUI) provides a simplified and guided experience for configuring, managing, and monitoring your OpenRAG deployment directly from the terminal."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/tui"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/tui" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/tui" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Use the TUI","item":"https://docs.openr.ag/tui"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<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>If you install OpenRAG with the <a class="" href="/install">automatic installer script</a>, <a class="" href="/install-uv"><code>uv</code></a>, or <a class="" href="/install-uvx"><code>uvx</code></a>, you use the TUI to manage your OpenRAG deployment.
|
||||
The TUI guides you through the initial setup, automatically manages your OpenRAG <code>.env</code> and <code>docker-compose</code> files, and provides convenient access to <a class="" href="/manage-services">service management</a> controls.</p>
|
||||
<p>In contrast, when you <a class="" href="/docker">deploy OpenRAG with self-managed services</a>, you must manually configure OpenRAG by preparing a <code>.env</code> file and using Docker or Podman commands to deploy and manage your OpenRAG services.</p>
|
||||
<p>In contrast, when you <a class="" href="/docker">deploy OpenRAG with self-managed services</a>, you must manually configure OpenRAG by preparing a <code>.env</code> file, and then use Docker or Podman commands to deploy and manage your OpenRAG services.</p>
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="access-the-tui">Access the TUI<a href="#access-the-tui" class="hash-link" aria-label="Direct link to Access the TUI" title="Direct link to Access the TUI" translate="no"></a></h2>
|
||||
<p>If you installed OpenRAG with <code>uv</code>, access the TUI with <code>uv run openrag</code>.</p>
|
||||
<p>If you installed OpenRAG with the automatic installer script or <code>uvx</code>, access the TUI with <code>uvx openrag</code>.</p>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Remove 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/uninstall"><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="Remove OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="If you want to reset your OpenRAG containers without removing OpenRAG entirely, see Reset OpenRAG containers and Reinstall OpenRAG."><meta data-rh="true" property="og:description" content="If you want to reset your OpenRAG containers without removing OpenRAG entirely, see Reset OpenRAG containers and Reinstall OpenRAG."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/uninstall"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/uninstall" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/uninstall" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Remove OpenRAG","item":"https://docs.openr.ag/uninstall"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -26,14 +26,7 @@
|
|||
<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 down </span><span class="token parameter variable" style="color:#36acaa">--volumes</span><span class="token plain"> --remove-orphans </span><span class="token parameter variable" style="color:#36acaa">--rmi</span><span class="token plain"> </span><span class="token builtin class-name">local</span><span class="token plain"></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"> system prune </span><span class="token parameter variable" style="color:#36acaa">-f</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Remove data that wasn't deleted by the previous commands:</p>
|
||||
<ul>
|
||||
<li class="">OpenRAG's <code>.env</code> file</li>
|
||||
<li class="">The contents of OpenRAG's <code>config</code> directory</li>
|
||||
<li class="">The contents of the <code>./openrag-documents</code> directory</li>
|
||||
<li class="">The contents of the <code>./opensearch-data</code> directory</li>
|
||||
<li class="">The <code>conversations.json</code> file</li>
|
||||
</ul>
|
||||
<p>Remove OpenRAG's <code>.env</code> file and the <code>~/.openrag/documents</code> directory, which aren't deleted by the previous commands.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Stop <code>docling-serve</code>:</p>
|
||||
|
|
@ -78,14 +71,7 @@
|
|||
</ol>
|
||||
<ol start="7">
|
||||
<li class="">
|
||||
<p>Remove data that wasn't deleted by the previous commands:</p>
|
||||
<ul>
|
||||
<li class="">OpenRAG's <code>.env</code> file</li>
|
||||
<li class="">The contents of OpenRAG's <code>config</code> directory</li>
|
||||
<li class="">The contents of the <code>./openrag-documents</code> directory</li>
|
||||
<li class="">The contents of the <code>./opensearch-data</code> directory</li>
|
||||
<li class="">The <code>conversations.json</code> file</li>
|
||||
</ul>
|
||||
<p>Remove OpenRAG's <code>.env</code> file and the <code>~/.openrag/documents</code> directory, which aren't deleted by the previous commands.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Stop <code>docling-serve</code>:</p>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<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">
|
||||
<script src="/assets/js/runtime~main.c7097fe1.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.732f6967.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -20,6 +20,9 @@ This ensure that you won't lose your flows after upgrading, and you can ref
|
|||
<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>
|
||||
<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>
|
||||
</ol>
|
||||
<ol start="2">
|
||||
<li class="">
|
||||
<p>To check for updates, open the TUI's <strong>Status</strong> menu (<kbd>3</kbd>), and then click <strong>Upgrade</strong>.</p>
|
||||
</li>
|
||||
|
|
@ -75,7 +78,7 @@ The commands to upgrade the package depend on how you installed OpenRAG.</p>
|
|||
<li class="">
|
||||
<p>In the OpenRAG TUI, click <strong>Start All Services</strong>, and then wait while the upgraded containers 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>
|
||||
<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 <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.
|
||||
You might need to edit the <code>.env</code> file after upgrading the Python package to enforce a different container version.
|
||||
The TUI warns you if it detects a version mismatch.</p></div></div>
|
||||
|
|
@ -89,10 +92,17 @@ The TUI warns you if it detects a version mismatch.</p></div></div>
|
|||
</li>
|
||||
</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>
|
||||
<p>To fetch and apply the latest container images while preserving your OpenRAG data, run the commands for your container management tool.
|
||||
By default, OpenRAG's <code>docker-compose</code> files pull the latest container images.</p>
|
||||
<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>
|
||||
</ol>
|
||||
<ol start="2">
|
||||
<li class="">
|
||||
<p>Fetch and apply the latest container images while preserving your OpenRAG data:</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"> compose pull</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><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><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's <code>docker-compose</code> files pull the latest container images.</p>
|
||||
</li>
|
||||
</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>
|
||||
<ul>
|
||||
<li class=""><a class="" href="/manage-services">Manage OpenRAG services</a></li>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue