gmakstutis/openrag
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

deploy: dd507b15a3

Browse source
This commit is contained in:
aimurphy 2026-01-05 21:32:48 +00:00
parent 93b197f711
commit beea365793
30 changed files with 89 additions and 83 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
404.html
View file

File diff suppressed because one or more lines are too long

6
agents/index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -71,7 +71,7 @@ For more information on tweaks, see the Langflow documentation on <a href="https
<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="#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>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

2
assets/js/03ef5215.7bf71c16.js → assets/js/03ef5215.0f05b0ce.js
View file

File diff suppressed because one or more lines are too long

2
assets/js/52896773.66bfb2f3.js → assets/js/52896773.7edb6c39.js
View file

File diff suppressed because one or more lines are too long

2
assets/js/915a24fd.df85b0ea.js → assets/js/915a24fd.34562fc1.js
View file

File diff suppressed because one or more lines are too long

1
assets/js/ca2c3c0c.200d175f.js
View file

File diff suppressed because one or more lines are too long

1
assets/js/ca2c3c0c.dc47ac79.js Normal file
View file

File diff suppressed because one or more lines are too long

4
assets/js/main.e7d4b953.js → assets/js/main.bf3320e5.js
View file

File diff suppressed because one or more lines are too long

0
assets/js/main.e7d4b953.js.LICENSE.txt → assets/js/main.bf3320e5.js.LICENSE.txt
View file

2
assets/js/runtime~main.675daba5.js → assets/js/runtime~main.03e752b6.js
View file

File diff suppressed because one or more lines are too long

6
chat/index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -117,7 +117,7 @@ You could also pass the output from one flow as input to another flow.</p>
<li class="">Service is suddenly unavailable when it was working previously: If there is no other obvious cause, such as the service or container VM being stopped or disconnected, there might be a problem with the flow configuration. Use the <a class="" href="/agents#revert-a-built-in-flow-to-its-original-configuration"><strong>Restore flow</strong> option</a> to revert the <strong>OpenRAG OpenSearch Agent</strong> flow to its original configuration.
If you made customizations to the flow, make sure to <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flow</a> before restoring the flow.</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/chat.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="/knowledge-filters"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Filter knowledge</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/reference/configuration"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Environment variables</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="#flow" class="table-of-contents__link toc-highlight">OpenRAG OpenSearch Agent flow</a></li><li><a href="#nudges" class="table-of-contents__link toc-highlight">Nudges</a></li><li><a href="#upload-documents-to-the-chat" class="table-of-contents__link toc-highlight">Upload documents to the chat</a></li><li><a href="#inspect-tool-calls-and-knowledge" class="table-of-contents__link toc-highlight">Inspect tool calls and knowledge</a></li><li><a href="#integrate-openrag-chat-into-an-application" class="table-of-contents__link toc-highlight">Integrate OpenRAG chat into an application</a></li><li><a href="#troubleshoot-chat" class="table-of-contents__link toc-highlight">Troubleshoot chat</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
docker/index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -323,7 +323,7 @@ The overview demonstrates some basic functionality that is covered in the <a cla
<li class="">Learn how to <a class="" href="/manage-services">manage OpenRAG services</a>.</li>
<li class=""><a class="" href="/ingestion">Upload documents</a>, and then use the <a class="" href="/chat"><strong>Chat</strong></a> to explore your data.</li>
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/get-started/docker.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/install-windows"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Install OpenRAG on Windows</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/upgrade"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Upgrade OpenRAG</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#setup" class="table-of-contents__link toc-highlight">Prepare your deployment</a></li><li><a href="#start-services" class="table-of-contents__link toc-highlight">Start services</a></li><li><a href="#application-onboarding" class="table-of-contents__link toc-highlight">Complete the application onboarding process</a></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next steps</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -50,7 +50,7 @@ It provides powerful hybrid search capabilities with enterprise-grade security a
<p><strong>OpenRAG frontend</strong>: Provides the user interface for interacting with the OpenRAG platform.</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/get-started/what-is-openrag.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--next" href="/quickstart"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Quickstart</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">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

15
ingestion/index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -196,12 +196,15 @@ By default, this flow uses Docling Serve to import and process documents.</p><p>
</ul></div></div></details>
<p>You can <a href="#monitor-ingestion" class="">monitor ingestion</a> to see the progress of the uploads and check for failed uploads.</p>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="url-flow">Ingest knowledge from URLs<a href="#url-flow" class="hash-link" aria-label="Direct link to Ingest knowledge from URLs" title="Direct link to Ingest knowledge from URLs" translate="no">​</a></h2>
<p>When using the OpenRAG chat, you can enter URLs into the chat to be ingested in real-time during your conversation.</p>
<div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_BuS1"><p>Use <a href="https://www.w3schools.com/tags/ref_urlencode.ASP" target="_blank" rel="noopener noreferrer" class="">UTF-8 encoding</a> for URLs with special characters other than the standard slash, period, and colon characters.
For example, use <code>https://en.wikipedia.org/wiki/Caf%C3%A9</code> instead of <code>https://en.wikipedia.org/wiki/Café</code> or <code>https://en.wikipedia.org/wiki/Coffee%5Fculture</code> instead of <code>https://en.wikipedia.org/wiki/Coffee_culture</code>.</p></div></div>
<p>The <strong>OpenSearch URL Ingestion</strong> flow is used to ingest web content from URLs.
This flow isn&#x27;t directly accessible from the OpenRAG user interface.
Instead, this flow is called by the <a class="" href="/chat#flow"><strong>OpenRAG OpenSearch Agent</strong> flow</a> as a Model Context Protocol (MCP) tool.
The agent can call this component to fetch web content from a given URL, and then ingest that content into your OpenSearch knowledge base.</p>
<p>Like all OpenRAG flows, you can <a class="" href="/agents#inspect-and-modify-flows">inspect the flow in Langflow</a>, and you can customize it.</p>
<p>For more information about MCP in Langflow, see the Langflow documentation on <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-tutorial" target="_blank" rel="noopener noreferrer" class="">MCP servers</a>.</p>
The agent can call this component to fetch web content from a given URL, and then ingest that content into your OpenSearch knowledge base.
Like all OpenRAG flows, you can <a class="" href="/agents#inspect-and-modify-flows">inspect the flow in Langflow</a>, and you can customize it.
For more information about MCP in Langflow, see the Langflow documentation on <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-tutorial" target="_blank" rel="noopener noreferrer" class="">MCP servers</a>.</p>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="monitor-ingestion">Monitor ingestion<a href="#monitor-ingestion" class="hash-link" aria-label="Direct link to Monitor ingestion" title="Direct link to Monitor ingestion" translate="no">​</a></h2>
<p>Document ingestion tasks run in the background.</p>
<p>In the OpenRAG user interface, a badge is shown on <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-bell" aria-hidden="true"><path d="M10.268 21a2 2 0 0 0 3.464 0"></path><path d="M3.262 15.326A1 1 0 0 0 4 17h16a1 1 0 0 0 .74-1.673C19.41 13.956 18 12.499 18 8A6 6 0 0 0 6 8c0 4.499-1.411 5.956-2.738 7.326"></path></svg> <strong>Tasks</strong> when OpenRAG tasks are active.
@ -305,7 +308,7 @@ For example:</p>
<li class=""><a class="" href="/chat">Chat with knowledge</a></li>
<li class=""><a class="" href="/agents#inspect-and-modify-flows">Inspect and modify flows</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/core-components/ingestion.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="/knowledge"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Configure knowledge</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/knowledge-filters"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Filter 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="#ingest-local-files-and-folders" class="table-of-contents__link toc-highlight">Ingest local files and folders</a></li><li><a href="#ingest-local-files-temporarily" class="table-of-contents__link toc-highlight">Ingest local files temporarily</a></li><li><a href="#oauth-ingestion" class="table-of-contents__link toc-highlight">Ingest files with OAuth connectors</a><ul><li><a href="#enable-oauth-connectors" class="table-of-contents__link toc-highlight">Enable OAuth connectors</a></li><li><a href="#authenticate-and-ingest-files-from-cloud-storage" class="table-of-contents__link toc-highlight">Authenticate and ingest files from cloud storage</a></li></ul></li><li><a href="#url-flow" class="table-of-contents__link toc-highlight">Ingest knowledge from URLs</a></li><li><a href="#monitor-ingestion" class="table-of-contents__link toc-highlight">Monitor ingestion</a><ul><li><a href="#ingestion-performance-expectations" class="table-of-contents__link toc-highlight">Ingestion performance expectations</a></li></ul></li><li><a href="#troubleshoot-ingestion" class="table-of-contents__link toc-highlight">Troubleshoot ingestion</a><ul><li><a href="#failed-or-slow-ingestion" class="table-of-contents__link toc-highlight">Failed or slow ingestion</a></li><li><a href="#problems-when-referencing-documents-in-chat" class="table-of-contents__link toc-highlight">Problems when referencing documents in chat</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">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
install-options/index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -40,7 +40,7 @@ When using TUI-managed services, this file is created automatically at <code>~/.
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">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
install-uv/index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -416,7 +416,7 @@ The overview demonstrates some basic functionality that is covered in the <a cla
<li class="">Learn how to <a class="" href="/manage-services">manage OpenRAG services</a>.</li>
<li class=""><a class="" href="/ingestion">Upload documents</a>, and then use the <a class="" href="/chat"><strong>Chat</strong></a> to explore your data.</li>
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/get-started/install-uv.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/install"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Run the installer script</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/install-uvx"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Invoke OpenRAG with uvx</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#install-and-start-openrag-with-uv" class="table-of-contents__link toc-highlight">Install and start OpenRAG with uv</a><ul><li><a href="#uv-add" class="table-of-contents__link toc-highlight">Use uv add</a></li><li><a href="#uv-pip-install" class="table-of-contents__link toc-highlight">Use uv pip install</a></li></ul></li><li><a href="#setup" class="table-of-contents__link toc-highlight">Set up OpenRAG with the TUI</a></li><li><a href="#application-onboarding" class="table-of-contents__link toc-highlight">Complete the application onboarding process</a></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next steps</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
install-uvx/index.html
View file

@ -4,8 +4,8 @@
<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&#x27;s dependencies."><meta data-rh="true" property="og:description" content="Use uvx to invoke OpenRAG outside of a Python project or without modifying your project&#x27;s dependencies."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install-uvx"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-uvx" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-uvx" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Invoke OpenRAG with uvx","item":"https://docs.openr.ag/install-uvx"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -372,7 +372,7 @@ The overview demonstrates some basic functionality that is covered in the <a cla
<li class="">Learn how to <a class="" href="/manage-services">manage OpenRAG services</a>.</li>
<li class=""><a class="" href="/ingestion">Upload documents</a>, and then use the <a class="" href="/chat"><strong>Chat</strong></a> to explore your data.</li>
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/get-started/install-uvx.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/install-uv"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Install OpenRAG with uv</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/install-windows"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Install OpenRAG on Windows</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#install-and-run-openrag-with-uvx" class="table-of-contents__link toc-highlight">Install and run OpenRAG with uvx</a></li><li><a href="#setup" class="table-of-contents__link toc-highlight">Set up OpenRAG with the TUI</a></li><li><a href="#application-onboarding" class="table-of-contents__link toc-highlight">Complete the application onboarding process</a></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next steps</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
install-windows/index.html
View file

@ -4,8 +4,8 @@
<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&#x27;re using Windows, you must install OpenRAG within the Windows Subsystem for Linux (WSL)."><meta data-rh="true" property="og:description" content="If you&#x27;re using Windows, you must install OpenRAG within the Windows Subsystem for Linux (WSL)."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install-windows"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-windows" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install-windows" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Install OpenRAG on Windows","item":"https://docs.openr.ag/install-windows"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -41,7 +41,7 @@ You can install OpenRAG in your WSL distribution using any of the <a class="" hr
</ol>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="troubleshoot-openrag-in-wsl">Troubleshoot OpenRAG in WSL<a href="#troubleshoot-openrag-in-wsl" class="hash-link" aria-label="Direct link to Troubleshoot OpenRAG in WSL" title="Direct link to Troubleshoot OpenRAG in WSL" translate="no">​</a></h2>
<p>If you encounter issues with port forwarding or the Windows Firewall, you might need to adjust the <a href="https://learn.microsoft.com/en-us/windows/security/operating-system-security/network-security/windows-firewall/hyper-v-firewall" target="_blank" rel="noopener noreferrer" class="">Hyper-V firewall settings</a> to allow communication between your WSL distribution and the Windows host. For more troubleshooting advice for networking issues, see <a href="https://learn.microsoft.com/en-us/windows/wsl/troubleshooting#common-issues" target="_blank" rel="noopener noreferrer" class="">Troubleshooting WSL common issues</a>.</p></div><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-windows.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/install-uvx"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Invoke OpenRAG with uvx</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docker"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Deploy self-managed services</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="#install-openrag-in-the-wsl" class="table-of-contents__link toc-highlight">Install OpenRAG in the WSL</a></li><li><a href="#troubleshoot-openrag-in-wsl" class="table-of-contents__link toc-highlight">Troubleshoot OpenRAG in WSL</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
install/index.html
View file

@ -4,8 +4,8 @@
<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&#x27;s core features, try the quickstart."><meta data-rh="true" property="og:description" content="To quickly install and test OpenRAG&#x27;s core features, try the quickstart."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Run the installer script","item":"https://docs.openr.ag/install"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -360,7 +360,7 @@ The overview demonstrates some basic functionality that is covered in the <a cla
<li class="">Learn how to <a class="" href="/manage-services">manage OpenRAG services</a>.</li>
<li class=""><a class="" href="/ingestion">Upload documents</a>, and then use the <a class="" href="/chat"><strong>Chat</strong></a> to explore your data.</li>
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/get-started/install.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/install-options"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Select an installation method</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/install-uv"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Install OpenRAG with uv</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#install" class="table-of-contents__link toc-highlight">Run the installer script</a></li><li><a href="#setup" class="table-of-contents__link toc-highlight">Set up OpenRAG with the TUI</a></li><li><a href="#application-onboarding" class="table-of-contents__link toc-highlight">Complete the application onboarding process</a></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next steps</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
knowledge-filters/index.html
View file

@ -4,8 +4,8 @@
<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&#x27;s knowledge filters help you organize and manage your knowledge base by creating pre-defined views of your documents."><meta data-rh="true" property="og:description" content="OpenRAG&#x27;s knowledge filters help you organize and manage your knowledge base by creating pre-defined views of your documents."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/knowledge-filters"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge-filters" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge-filters" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Filter knowledge","item":"https://docs.openr.ag/knowledge-filters"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -70,7 +70,7 @@ Chat filters apply to one chat session only.</p>
<p>Click <strong>Delete Filter</strong>.</p>
</li>
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/core-components/knowledge-filters.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="/ingestion"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Ingest knowledge</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/chat"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Chat</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="#built-in-filters" class="table-of-contents__link toc-highlight">Built-in filters</a></li><li><a href="#create-a-filter" class="table-of-contents__link toc-highlight">Create a filter</a></li><li><a href="#apply-a-filter" class="table-of-contents__link toc-highlight">Apply a filter</a></li><li><a href="#delete-a-filter" class="table-of-contents__link toc-highlight">Delete a filter</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
knowledge/index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -130,7 +130,7 @@ The default value is 200 characters, which represents an overlap of 20 percent i
<li class=""><a class="" href="/chat">Chat with knowledge</a></li>
<li class=""><a class="" href="/agents#inspect-and-modify-flows">Inspect and modify flows</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/core-components/knowledge.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="/agents"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Flows</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/ingestion"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Ingest 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="#browse-knowledge" class="table-of-contents__link toc-highlight">Browse knowledge</a><ul><li><a href="#default-documents" class="table-of-contents__link toc-highlight">Default documents</a></li></ul></li><li><a href="#auth" class="table-of-contents__link toc-highlight">OpenSearch authentication and document access</a></li><li><a href="#opensearch-indexes" class="table-of-contents__link toc-highlight">OpenSearch indexes</a></li><li><a href="#knowledge-ingestion-settings" class="table-of-contents__link toc-highlight">Knowledge ingestion settings</a><ul><li><a href="#set-the-embedding-model-and-dimensions" class="table-of-contents__link toc-highlight">Set the embedding model and dimensions</a></li><li><a href="#set-docling-parameters" class="table-of-contents__link toc-highlight">Set Docling parameters</a></li><li><a href="#set-the-local-documents-path" class="table-of-contents__link toc-highlight">Set the local documents path</a></li></ul></li><li><a href="#delete-knowledge" class="table-of-contents__link toc-highlight">Delete knowledge</a></li><li><a href="#see-also" class="table-of-contents__link toc-highlight">See also</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

13
manage-services/index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -61,7 +61,7 @@ However, some services, like Docling, run directly on the local machine.</p>
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>
<li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Although OpenRAG can preserve changes to the built-in flows, it doesn&#x27;t preserve user-created flows. As a general best practice, exporting your flows is recommended to create backups of your customizations. Afterwards, you can reimport 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, click <strong>Status</strong> in the TUI, and then click <strong>Factory Reset</strong>.</p>
@ -69,8 +69,11 @@ Your documents are reingested into a fresh OpenSearch index after the reset.</p>
<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>
<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 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>
<li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Although OpenRAG can preserve changes to the built-in flows, it doesn&#x27;t preserve user-created flows. As a general best practice, exporting your flows is recommended to create backups of your customizations. Afterwards, you can reimport your flows or reference the exported flow JSON as needed.</li>
</ol><ol start="2">
<li class="">
<p>Recreate the containers:</p>
@ -94,7 +97,7 @@ If you prune all images, the OpenRAG services are stopped, all images are pruned
<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-and-view-logs" class="table-of-contents__link toc-highlight">Monitor services and view logs</a></li><li><a href="#stop-and-start-containers" class="table-of-contents__link toc-highlight">Stop and start containers</a></li><li><a href="#start-native-services" class="table-of-contents__link toc-highlight">Stop, start, and inspect native services (Docling)</a></li><li><a href="#upgrade-services" class="table-of-contents__link toc-highlight">Upgrade services</a></li><li><a href="#reset-containers" class="table-of-contents__link toc-highlight">Reset containers (destructive)</a></li><li><a href="#prune-images" class="table-of-contents__link toc-highlight">Prune images</a></li><li><a href="#see-also" class="table-of-contents__link toc-highlight">See also</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
quickstart/index.html
View file

@ -4,8 +4,8 @@
<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&#x27;s core features."><meta data-rh="true" property="og:description" content="Use this quickstart to install OpenRAG, and then try some of OpenRAG&#x27;s core features."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/quickstart"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/quickstart" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/quickstart" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Quickstart","item":"https://docs.openr.ag/quickstart"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -196,7 +196,7 @@ It is recommended that you <a class="" href="/reinstall">reinstall OpenRAG</a> w
<p><strong>Learn more about Langflow</strong>: For a deep dive on the Langflow API and visual editor, see the <a href="https://docs.langflow.org/" target="_blank" rel="noopener noreferrer" class="">Langflow documentation</a>.</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/get-started/quickstart.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">About OpenRAG</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/install-options"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Select an installation method</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#install-openrag" class="table-of-contents__link toc-highlight">Install OpenRAG</a></li><li><a href="#chat-with-documents" class="table-of-contents__link toc-highlight">Load and chat with documents</a></li><li><a href="#change-components" class="table-of-contents__link toc-highlight">Change the language model and chat settings</a></li><li><a href="#integrate-openrag-into-an-application" class="table-of-contents__link toc-highlight">Integrate OpenRAG into an application</a></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next steps</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
reference/configuration/index.html
View file

@ -4,8 +4,8 @@
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Environment variables | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/reference/configuration"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Environment variables | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG&#x27;s .env file is the primary configuration file for OpenRAG."><meta data-rh="true" property="og:description" content="OpenRAG&#x27;s .env file is the primary configuration file for OpenRAG."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/reference/configuration"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reference/configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reference/configuration" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Environment variables","item":"https://docs.openr.ag/reference/configuration"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -58,7 +58,7 @@ Some of these variables are immutable and can only be changed by redeploying Ope
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="system-settings">System settings<a href="#system-settings" class="hash-link" aria-label="Direct link to System settings" title="Direct link to System settings" translate="no">​</a></h2>
<p>Configure general system components, session management, and logging.</p>
<table><thead><tr><th>Variable</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>LANGFLOW_KEY_RETRIES</code></td><td><code>15</code></td><td>Number of retries for Langflow key generation.</td></tr><tr><td><code>LANGFLOW_KEY_RETRY_DELAY</code></td><td><code>2.0</code></td><td>Delay between retries in seconds.</td></tr><tr><td><code>LANGFLOW_VERSION</code></td><td><code>OPENRAG_VERSION</code></td><td>Langflow Docker image version. By default, OpenRAG uses the <code>OPENRAG_VERSION</code> for the Langflow Docker image version.</td></tr><tr><td><code>LOG_FORMAT</code></td><td>Not set</td><td>Set to <code>json</code> to enabled JSON-formatted log output. If this variable isn&#x27;t set, then the default logging format is used.</td></tr><tr><td><code>LOG_LEVEL</code></td><td><code>INFO</code></td><td>Logging level. Can be one of <code>DEBUG</code>, <code>INFO</code>, <code>WARNING</code>, or <code>ERROR</code>. <code>DEBUG</code> provides the most detailed logs but can impact performance.</td></tr><tr><td><code>MAX_WORKERS</code></td><td><code>1</code></td><td>Maximum number of workers for document processing.</td></tr><tr><td><code>OPENRAG_VERSION</code></td><td><code>latest</code></td><td>The version of the OpenRAG Docker images to run. For more information, see <a class="" href="/upgrade">Upgrade OpenRAG</a></td></tr><tr><td><code>SERVICE_NAME</code></td><td><code>openrag</code></td><td>Service name for logging.</td></tr><tr><td><code>SESSION_SECRET</code></td><td>Automatically generated</td><td>Session management.</td></tr></tbody></table></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/reference/configuration.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="/chat"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Chat</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/support/contribute"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Contribute to OpenRAG</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#set-environment-variables" class="table-of-contents__link toc-highlight">Edit the <code>.env</code> file</a></li><li><a href="#model-provider-settings" class="table-of-contents__link toc-highlight">Model provider settings</a></li><li><a href="#document-processing-settings" class="table-of-contents__link toc-highlight">Document processing settings</a></li><li><a href="#langflow-settings" class="table-of-contents__link toc-highlight">Langflow settings</a></li><li><a href="#oauth-provider-settings" class="table-of-contents__link toc-highlight">OAuth provider settings</a></li><li><a href="#opensearch-settings" class="table-of-contents__link toc-highlight">OpenSearch settings</a></li><li><a href="#system-settings" class="table-of-contents__link toc-highlight">System settings</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

12
reinstall/index.html
View file

@ -4,8 +4,8 @@
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Reinstall OpenRAG | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/reinstall"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Reinstall OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="You can reset your OpenRAG deployment to its initial state by recreating the containers and deleting accessory data, such as the .env file and ingested documents."><meta data-rh="true" property="og:description" content="You can reset your OpenRAG deployment to its initial state by recreating the containers and deleting accessory data, such as the .env file and ingested documents."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/reinstall"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reinstall" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reinstall" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Reinstall OpenRAG","item":"https://docs.openr.ag/reinstall"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -16,7 +16,7 @@
Destroyed containers and deleted data are lost and cannot be recovered after running these operations.</p></div></div>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="reinstall-tui-managed-containers">Reinstall TUI-managed containers<a href="#reinstall-tui-managed-containers" class="hash-link" aria-label="Direct link to Reinstall TUI-managed containers" title="Direct link to Reinstall TUI-managed containers" translate="no">​</a></h2>
<ol>
<li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, and you want to preserve those changes, then you must <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Afterwards, you can import your flows or reference the exported flow JSON as needed.</li>
<li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Although OpenRAG can preserve changes to the built-in flows, it doesn&#x27;t preserve user-created flows. As a general best practice, exporting your flows is recommended to create backups of your customizations. Afterwards, you can reimport your flows or reference the exported flow JSON as needed.</li>
</ol>
<ol start="2">
<li class="">
@ -49,7 +49,7 @@ Then, launch the OpenRAG app and repeat the <a class="" href="/install#applicati
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="reinstall-self-managed-containers-with-docker-compose-or-podman-compose">Reinstall self-managed containers with <code>docker compose</code> or <code>podman compose</code><a href="#reinstall-self-managed-containers-with-docker-compose-or-podman-compose" class="hash-link" aria-label="Direct link to reinstall-self-managed-containers-with-docker-compose-or-podman-compose" title="Direct link to reinstall-self-managed-containers-with-docker-compose-or-podman-compose" translate="no">​</a></h2>
<p>Use these steps to reinstall OpenRAG containers with streamlined <code>docker compose</code> or <code>podman compose</code> commands:</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>
<li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Although OpenRAG can preserve changes to the built-in flows, it doesn&#x27;t preserve user-created flows. As a general best practice, exporting your flows is recommended to create backups of your customizations. Afterwards, you can reimport your flows or reference the exported flow JSON as needed.</li>
</ol>
<ol start="2">
<li class="">
@ -82,7 +82,7 @@ It is recommended that you preserve OpenRAG&#x27;s <a href="https://github.com/l
<p>Use these commands to remove and clean up OpenRAG containers with discrete <code>docker</code> or <code>podman</code> commands.</p>
<p>If you want to reinstall one container, specify the container name in the commands instead of running the commands on all containers.</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>
<li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Although OpenRAG can preserve changes to the built-in flows, it doesn&#x27;t preserve user-created flows. As a general best practice, exporting your flows is recommended to create backups of your customizations. Afterwards, you can reimport your flows or reference the exported flow JSON as needed.</li>
</ol>
<ol start="2">
<li class="">
@ -132,7 +132,7 @@ It is recommended that you preserve OpenRAG&#x27;s <a href="https://github.com/l
If you removed only one container, redeploy that container with the appropriate <code>docker run</code> or <code>podman run</code> command.</p>
</li>
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/get-started/reinstall.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="/upgrade"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Upgrade OpenRAG</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/uninstall"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Remove OpenRAG</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#reinstall-tui-managed-containers" class="table-of-contents__link toc-highlight">Reinstall TUI-managed containers</a></li><li><a href="#reinstall-self-managed-containers-with-docker-compose-or-podman-compose" class="table-of-contents__link toc-highlight">Reinstall self-managed containers with <code>docker compose</code> or <code>podman compose</code></a></li><li><a href="#reinstall-self-managed-containers-with-discrete-docker-or-podman-commands" class="table-of-contents__link toc-highlight">Reinstall self-managed containers with discrete <code>docker</code> or <code>podman</code> commands</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
support/contribute/index.html
View file

@ -4,8 +4,8 @@
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Contribute to 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/contribute"><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="Contribute to OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="There are several ways you can interact with the OpenRAG community and contribute to the OpenRAG codebase."><meta data-rh="true" property="og:description" content="There are several ways you can interact with the OpenRAG community and contribute to the OpenRAG codebase."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/support/contribute"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/support/contribute" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/support/contribute" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Contribute to OpenRAG","item":"https://docs.openr.ag/support/contribute"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
<script src="/assets/js/runtime~main.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -139,7 +139,7 @@ This can help you find broken links before creating a PR.</p>
</li>
</ol>
<p>OpenRAG technical writers can directly edit documentation PRs to enforce style guidelines and fix errors.</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/support/contribute.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="/reference/configuration"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Environment variables</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/support/troubleshoot"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Troubleshoot OpenRAG</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#star-openrag-on-github" class="table-of-contents__link toc-highlight">Star OpenRAG on GitHub</a></li><li><a href="#watch-the-github-repository" class="table-of-contents__link toc-highlight">Watch the GitHub repository</a></li><li><a href="#request-enhancements-and-get-help-through-github" class="table-of-contents__link toc-highlight">Request enhancements and get help through GitHub</a><ul><li><a href="#github-issues" class="table-of-contents__link toc-highlight">GitHub issues</a></li><li><a href="#github-discussions" class="table-of-contents__link toc-highlight">GitHub discussions</a></li></ul></li><li><a href="#community-guidelines-and-tips" class="table-of-contents__link toc-highlight">Community guidelines and tips</a></li><li><a href="#contribute-to-the-codebase" class="table-of-contents__link toc-highlight">Contribute to the codebase</a><ul><li><a href="#tips-for-successful-submissions" class="table-of-contents__link toc-highlight">Tips for successful submissions</a></li><li><a href="#use-of-ai-tools-in-contributions" class="table-of-contents__link toc-highlight">Use of AI tools in contributions</a></li></ul></li><li><a href="#contribute-documentation" class="table-of-contents__link toc-highlight">Contribute documentation</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
support/troubleshoot/index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -125,7 +125,7 @@ For example, some models might produce unexpected results, such as JSON-formatte
You can submit an <a href="https://github.com/langflow-ai/openrag/issues" target="_blank" rel="noopener noreferrer" class="">OpenRAG GitHub issue</a> to request support for specific models.</p>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="chat-issues">Chat issues<a href="#chat-issues" class="hash-link" aria-label="Direct link to Chat issues" title="Direct link to Chat issues" translate="no">​</a></h2>
<p>See <a class="" href="/chat#troubleshoot-chat">Troubleshoot chat</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/support/troubleshoot.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="/support/contribute"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Contribute to OpenRAG</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#installation-and-start-up-issues" class="table-of-contents__link toc-highlight">Installation and start up issues</a><ul><li><a href="#opensearch-fails-to-start" class="table-of-contents__link toc-highlight">OpenSearch fails to start</a></li><li><a href="#openrag-fails-to-start-from-the-tui-with-operation-not-supported" class="table-of-contents__link toc-highlight">OpenRAG fails to start from the TUI with operation not supported</a></li><li><a href="#openrag-installation-fails-with-unable-to-get-local-issuer-certificate" class="table-of-contents__link toc-highlight">OpenRAG installation fails with unable to get local issuer certificate</a></li><li><a href="#application-onboarding-gets-stuck-on-google-chrome" class="table-of-contents__link toc-highlight">Application onboarding gets stuck on Google Chrome</a></li></ul></li><li><a href="#langflow-connection-issues" class="table-of-contents__link toc-highlight">Langflow connection issues</a></li><li><a href="#container-out-of-memory-errors" class="table-of-contents__link toc-highlight">Container out of memory errors</a></li><li><a href="#memory-issue-with-podman-on-macos" class="table-of-contents__link toc-highlight">Memory issue with Podman on macOS</a></li><li><a href="#port-conflicts" class="table-of-contents__link toc-highlight">Port conflicts</a></li><li><a href="#ocr-ingestion-fails-easyocr-not-installed" class="table-of-contents__link toc-highlight">OCR ingestion fails (easyocr not installed)</a></li><li><a href="#langflow-container-already-exists-during-upgrade" class="table-of-contents__link toc-highlight">Upgrade fails due to Langflow container already exists</a></li><li><a href="#document-ingestion-or-similarity-search-issues" class="table-of-contents__link toc-highlight">Document ingestion or similarity search issues</a></li><li><a href="#ollama-model-issues" class="table-of-contents__link toc-highlight">Ollama model issues</a></li><li><a href="#chat-issues" class="table-of-contents__link toc-highlight">Chat issues</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
tui/index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -34,7 +34,7 @@ For more information, see <a class="" href="/manage-services">Manage OpenRAG ser
<p>Exiting the TUI doesn&#x27;t stop your OpenRAG services.
Your OpenRAG services continue to run until they are stopped from within the TUI or by another process that inadvertently stops them.</p>
<p>To restart the TUI, see <a href="#access-the-tui" class="">Access the TUI</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/tui.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="/uninstall"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Remove OpenRAG</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/manage-services"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Manage services</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="#access-the-tui" class="table-of-contents__link toc-highlight">Access the TUI</a></li><li><a href="#navigate-the-tui" class="table-of-contents__link toc-highlight">Navigate the TUI</a></li><li><a href="#manage-services-with-the-tui" class="table-of-contents__link toc-highlight">Manage services with the TUI</a></li><li><a href="#toggle-gpucpu-mode" class="table-of-contents__link toc-highlight">Toggle GPU/CPU mode</a></li><li><a href="#exit-the-openrag-tui" class="table-of-contents__link toc-highlight">Exit the OpenRAG TUI</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

6
uninstall/index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -79,7 +79,7 @@
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv run python scripts/docling_ctl.py stop</span><br></span></code></pre></div></div>
</li>
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/get-started/uninstall.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="/reinstall"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Reinstall OpenRAG</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/tui"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Use the TUI</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="#uninstall-tui-managed-deployments" class="table-of-contents__link toc-highlight">Uninstall TUI-managed deployments</a></li><li><a href="#uninstall-self-managed-deployments" class="table-of-contents__link toc-highlight">Uninstall self-managed deployments</a><ul><li><a href="#uninstall-with-docker-compose-or-podman-compose" class="table-of-contents__link toc-highlight">Uninstall with <code>docker compose</code> or <code>podman compose</code></a></li><li><a href="#uninstall-with-discrete-docker-or-podman-commands" class="table-of-contents__link toc-highlight">Uninstall with discrete <code>docker</code> or <code>podman</code> commands</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>

10
upgrade/index.html
View file

@ -4,8 +4,8 @@
<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.675daba5.js" defer="defer"></script>
<script src="/assets/js/main.e7d4b953.js" defer="defer"></script>
<script src="/assets/js/runtime~main.03e752b6.js" defer="defer"></script>
<script src="/assets/js/main.bf3320e5.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
@ -20,7 +20,7 @@ This ensure that you won&#x27;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>
<li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Although OpenRAG can preserve changes to the built-in flows, it doesn&#x27;t preserve user-created flows. As a general best practice, exporting your flows is recommended to create backups of your customizations. Afterwards, you can reimport your flows or reference the exported flow JSON as needed.</li>
</ol>
<ol start="2">
<li class="">
@ -92,7 +92,7 @@ The TUI warns you if it detects a version mismatch.</p></div></div>
</ol>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="upgrade-self-managed-deployments">Upgrade self-managed deployments<a href="#upgrade-self-managed-deployments" class="hash-link" aria-label="Direct link to Upgrade self-managed deployments" title="Direct link to Upgrade self-managed deployments" translate="no">​</a></h2>
<ol>
<li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, and you want to preserve those changes, then you must <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Afterwards, you can import your flows or reference the exported flow JSON as needed.</li>
<li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before starting this process. Although OpenRAG can preserve changes to the built-in flows, it doesn&#x27;t preserve user-created flows. As a general best practice, exporting your flows is recommended to create backups of your customizations. Afterwards, you can reimport your flows or reference the exported flow JSON as needed.</li>
</ol>
<ol start="2">
<li class="">
@ -110,7 +110,7 @@ The TUI warns you if it detects a version mismatch.</p></div></div>
<li class=""><a class="" href="/manage-services">Manage OpenRAG services</a></li>
<li class=""><a class="" href="/support/troubleshoot">Troubleshoot OpenRAG</a></li>
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/get-started/upgrade.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docker"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Deploy self-managed services</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/reinstall"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Reinstall OpenRAG</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#export-customized-flows-before-upgrading" class="table-of-contents__link toc-highlight">Export customized flows before upgrading</a></li><li><a href="#upgrade-tui-managed-deployments" class="table-of-contents__link toc-highlight">Upgrade TUI-managed deployments</a></li><li><a href="#upgrade-self-managed-deployments" class="table-of-contents__link toc-highlight">Upgrade self-managed deployments</a></li><li><a href="#see-also" class="table-of-contents__link toc-highlight">See also</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
<span>© 2025 OpenRAG</span>
<span>© 2026 OpenRAG</span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>