142 lines
No EOL
34 KiB
HTML
142 lines
No EOL
34 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-get-started/manage-services" data-has-hydrated="false">
|
||
<head>
|
||
<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.5f015f17.js" defer="defer"></script>
|
||
<script src="/assets/js/main.b10c6137.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg style="display: none;"><defs>
|
||
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/img/logo-openrag-light.svg"><link rel="preload" as="image" href="/img/logo-openrag-dark.svg"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo-openrag-light.svg" alt="OpenRAG Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/logo-openrag-dark.svg" alt="OpenRAG Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/langflow-ai/openrag" target="_blank" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/"><span title="About OpenRAG" class="linkLabel_WmDU">About OpenRAG</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/quickstart"><span title="Quickstart" class="linkLabel_WmDU">Quickstart</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/install-options"><span title="Installation" class="categoryLinkLabel_W154">Installation</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tui"><span title="Use the TUI" class="linkLabel_WmDU">Use the TUI</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/manage-services"><span title="Manage services" class="linkLabel_WmDU">Manage services</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/agents"><span title="Flows" class="linkLabel_WmDU">Flows</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/knowledge"><span title="Knowledge" class="categoryLinkLabel_W154">Knowledge</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/chat"><span title="Chat" class="linkLabel_WmDU">Chat</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/reference/configuration"><span title="Environment variables" class="linkLabel_WmDU">Environment variables</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/support/troubleshoot"><span title="Troubleshoot OpenRAG" class="linkLabel_WmDU">Troubleshoot OpenRAG</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Manage services</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Manage OpenRAG containers and services</h1></header><p>Service management is an essential part of maintaining your OpenRAG deployment.</p>
|
||
<p>Most OpenRAG services run in containers.
|
||
However, some services, like Docling, run directly on the local machine.</p>
|
||
<p>If you <a class="" href="/install-options">installed OpenRAG</a> with the automated installer script, <code>uv</code>, or <code>uvx</code>, you can use the <a class="" href="/tui">Terminal User Interface (TUI)</a> to manage your OpenRAG configuration and services.</p>
|
||
<p>For <a class="" href="/docker">self-managed deployments</a>, run Docker or Podman commands to manage your OpenRAG services.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="monitor-services">Monitor services<a href="#monitor-services" class="hash-link" aria-label="Direct link to Monitor services" title="Direct link to Monitor services" translate="no"></a></h2>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><ul>
|
||
<li class="">
|
||
<p><strong>TUI Status menu</strong>: In the <strong>Status</strong> menu (<kbd>3</kbd>), you can access streaming logs for all OpenRAG services.
|
||
Select the service you want to view, and then press <kbd>l</kbd>.
|
||
To copy the logs, click <strong>Copy to Clipboard</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>TUI Diagnostics menu</strong>: The TUI's <strong>Diagnostics</strong> menu (<kbd>4</kbd>) provides health monitoring for your container runtimes and monitoring of your OpenSearch instance.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>Docling</strong>: See <a href="#start-native-services" class="">Stop, start, and inspect native services</a>.</p>
|
||
</li>
|
||
</ul></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ul>
|
||
<li class="">
|
||
<p><strong>Containers</strong>: Get container logs with <a href="https://docs.docker.com/reference/cli/docker/compose/logs/" target="_blank" rel="noopener noreferrer" class=""><code>docker compose logs</code></a> or <a href="https://docs.podman.io/en/latest/markdown/podman-logs.1.html" target="_blank" rel="noopener noreferrer" class=""><code>podman logs</code></a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p><strong>Docling</strong>: See <a href="#start-native-services" class="">Stop, start, and inspect native services</a>.</p>
|
||
</li>
|
||
</ul></div></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="stop-and-start-containers">Stop and start containers<a href="#stop-and-start-containers" class="hash-link" aria-label="Direct link to Stop and start containers" title="Direct link to Stop and start containers" translate="no"></a></h2>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>In the TUI's <strong>Status</strong> menu (<kbd>3</kbd>), click <strong>Stop Services</strong> to stop all OpenRAG container-based services.
|
||
Then, click <strong>Start All Services</strong> to restart the OpenRAG containers.</p><p>When you click <strong>Start All Services</strong>, the following processes are triggered:</p><ol>
|
||
<li class="">
|
||
<p>OpenRAG automatically detects your container runtime, and then checks if your machine has compatible GPU support by checking for <code>CUDA</code>, <code>NVIDIA_SMI</code>, and Docker/Podman runtime support. This check determines which Docker Compose file OpenRAG uses because there are separate Docker Compose files for GPU and CPU deployments.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>OpenRAG pulls the OpenRAG container images with <code>docker compose pull</code> if any images are missing.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>OpenRAG deploys the containers with <code>docker compose up -d</code>.</p>
|
||
</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Use <a href="https://docs.docker.com/reference/cli/docker/compose/down/" target="_blank" rel="noopener noreferrer" class=""><code>docker compose down</code></a> and <a href="https://docs.docker.com/reference/cli/docker/compose/up/" target="_blank" rel="noopener noreferrer" class=""><code>docker compose up -d</code></a>.</p><p>To stop or start individual containers, use targeted commands like <code>docker stop CONTAINER_ID</code> and <code>docker start CONTAINER_ID</code>.</p></div></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="start-native-services">Stop, start, and inspect native services (Docling)<a href="#start-native-services" class="hash-link" aria-label="Direct link to Stop, start, and inspect native services (Docling)" title="Direct link to Stop, start, and inspect native services (Docling)" translate="no"></a></h2>
|
||
<p>A <em>native service</em> in OpenRAG is a service that runs locally on your machine, not within a container. For example, the <code>docling serve</code> process is an OpenRAG native service because this document processing service runs on your local machine, separate from the OpenRAG containers.</p>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>From the TUI's <strong>Status</strong> menu (<kbd>3</kbd>), click <strong>Native Services</strong> to do the following:</p><ul>
|
||
<li class="">View the service's status, port, and process ID (PID).</li>
|
||
<li class="">Stop, start, and restart native services.</li>
|
||
</ul></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Because the Docling service doesn't run in a container, you must start and stop it manually on the host machine:</p><ul>
|
||
<li class="">
|
||
<p>Stop <code>docling serve</code>:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv run python scripts/docling_ctl.py stop</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Start <code>docling serve</code>:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv run python scripts/docling_ctl.py start </span><span class="token parameter variable" style="color:#36acaa">--port</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">5001</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Check that <code>docling serve</code> is running:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">uv run python scripts/docling_ctl.py status</span><br></span></code></pre></div></div>
|
||
<p>If <code>docling serve</code> is running, the output includes the status, address, and process ID (PID):</p>
|
||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Status: running</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">Endpoint: http://127.0.0.1:5001</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">Docs: http://127.0.0.1:5001/docs</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">PID: 27746</span><br></span></code></pre></div></div>
|
||
</li>
|
||
</ul></div></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="upgrade-services">Upgrade services<a href="#upgrade-services" class="hash-link" aria-label="Direct link to Upgrade services" title="Direct link to Upgrade services" translate="no"></a></h2>
|
||
<p>See <a class="" href="/upgrade">Upgrade OpenRAG</a>.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="reset-containers">Reset containers (destructive)<a href="#reset-containers" class="hash-link" aria-label="Direct link to Reset containers (destructive)" title="Direct link to Reset containers (destructive)" translate="no"></a></h2>
|
||
<p>Reset your OpenRAG deployment by recreating the containers and removing some related data.</p>
|
||
<p>To completely reset your OpenRAG deployment and delete all OpenRAG data, see <a class="" href="/reinstall">Reinstall OpenRAG</a>.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="export-customized-flows-before-resetting-containers">Export customized flows before resetting containers<a href="#export-customized-flows-before-resetting-containers" class="hash-link" aria-label="Direct link to Export customized flows before resetting containers" title="Direct link to Export customized flows before resetting containers" translate="no"></a></h3>
|
||
<p>If you modified the built-in flows or created custom flows in your OpenRAG Langflow instance, and you want to preserve those changes, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">export your flows</a> before resetting your OpenRAG containers.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="factory-reset-with-the-tui">Factory Reset with the TUI<a href="#factory-reset-with-the-tui" class="hash-link" aria-label="Direct link to Factory Reset with the TUI" title="Direct link to Factory Reset with the TUI" translate="no"></a></h3>
|
||
<div class="theme-admonition theme-admonition-warning admonition_xJq3 alert alert--warning"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>warning</div><div class="admonitionContent_BuS1"><p>This is a destructive action that does the following:</p><ul>
|
||
<li class="">Destroys all OpenRAG containers, volumes, and local images with <code>docker compose down --volumes --remove-orphans --rmi local</code>.</li>
|
||
<li class="">Prunes any additional container objects with <code>docker system prune -f</code>.</li>
|
||
<li class="">Deletes the contents of OpenRAG's <code>config</code> and <code>./opensearch-data</code> directories.</li>
|
||
<li class="">Deletes the <code>conversations.json</code> file.</li>
|
||
</ul><p></p><p></p>Destroyed containers and deleted data are lost and cannot be recovered after running this operation.<p></p><p>This operation <em>doesn't</em> remove the <code>.env</code> file or the contents of the <code>./openrag-documents</code> directory.</p></div></div>
|
||
<ol>
|
||
<li class="">
|
||
<p>To destroy and recreate your OpenRAG containers, open the TUI's <strong>Status</strong> menu (<kbd>3</kbd>), and then click <strong>Factory Reset</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Repeat the <a class="" href="/install#setup">setup process</a> to restart the services and launch the OpenRAG app. Your OpenRAG passwords, OAuth credentials (if previously set), and onboarding configuration are restored from the <code>.env</code> file.</p>
|
||
</li>
|
||
</ol>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="rebuild-self-managed-containers">Rebuild self-managed containers<a href="#rebuild-self-managed-containers" class="hash-link" aria-label="Direct link to Rebuild self-managed containers" title="Direct link to Rebuild self-managed containers" translate="no"></a></h3>
|
||
<p>This command destroys and recreates the containers. Data stored exclusively on the containers is lost, such as Langflow flows.</p>
|
||
<p>If you want to preserve customized flows, see <a href="#export-customized-flows-before-resetting-containers" class="">Export customized flows before resetting containers</a>.</p>
|
||
<p>The <code>.env</code> file, <code>config</code> directory, <code>./openrag-documents</code> directory, <code>./opensearch-data</code> directory, and the <code>conversations.json</code> file are preserved.</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Docker</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">docker</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">--build</span><span class="token plain"> --force-recreate --remove-orphans</span><br></span></code></pre></div></div>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">podman</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">--build</span><span class="token plain"> --force-recreate --remove-orphans</span><br></span></code></pre></div></div>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="destroy-and-recreate-self-managed-containers">Destroy and recreate self-managed containers<a href="#destroy-and-recreate-self-managed-containers" class="hash-link" aria-label="Direct link to Destroy and recreate self-managed containers" title="Direct link to Destroy and recreate self-managed containers" translate="no"></a></h3>
|
||
<p>Use separate commands to destroy and recreate the containers if you want to modify the configuration or delete other OpenRAG data before recreating the containers.</p>
|
||
<div class="theme-admonition theme-admonition-warning admonition_xJq3 alert alert--warning"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>warning</div><div class="admonitionContent_BuS1"><p>These are destructive operations that reset your OpenRAG deployment to an initial state.
|
||
Destroyed containers and deleted data are lost and cannot be recovered after running this operation.</p></div></div>
|
||
<ol>
|
||
<li class="">
|
||
<p>Destroy the containers, volumes, and local images, and then remove (prune) any additional container objects:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Docker</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">docker</span><span class="token plain"> compose down </span><span class="token parameter variable" style="color:#36acaa">--volumes</span><span class="token plain"> --remove-orphans </span><span class="token parameter variable" style="color:#36acaa">--rmi</span><span class="token plain"> </span><span class="token builtin class-name">local</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">docker</span><span class="token plain"> system prune </span><span class="token parameter variable" style="color:#36acaa">-f</span><br></span></code></pre></div></div>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">podman</span><span class="token plain"> compose down </span><span class="token parameter variable" style="color:#36acaa">--volumes</span><span class="token plain"> --remove-orphans </span><span class="token parameter variable" style="color:#36acaa">--rmi</span><span class="token plain"> </span><span class="token builtin class-name">local</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">podman</span><span class="token plain"> system prune </span><span class="token parameter variable" style="color:#36acaa">-f</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Optional: Remove data that wasn't deleted by the previous commands:</p>
|
||
<ul>
|
||
<li class="">OpenRAG's <code>.env</code> file</li>
|
||
<li class="">The contents of OpenRAG's <code>config</code> directory</li>
|
||
<li class="">The contents of the <code>./openrag-documents</code> directory</li>
|
||
<li class="">The contents of the <code>./opensearch-data</code> directory</li>
|
||
<li class="">The <code>conversations.json</code> file</li>
|
||
</ul>
|
||
</li>
|
||
<li class="">
|
||
<p>If you deleted the <code>.env</code> file, prepare a new <code>.env</code> before redeploying the containers.
|
||
For more information, see <a class="" href="/docker">Deploy OpenRAG with self-managed services</a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Recreate the containers:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Docker</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">docker</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">-d</span><br></span></code></pre></div></div>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">podman</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">-d</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">
|
||
<p>Launch the OpenRAG app, and then repeat the <a class="" href="/docker#application-onboarding">application onboarding process</a>.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="see-also">See also<a href="#see-also" class="hash-link" aria-label="Direct link to See also" title="Direct link to See also" translate="no"></a></h2>
|
||
<ul>
|
||
<li class=""><a class="" href="/uninstall">Uninstall OpenRAG</a></li>
|
||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/get-started/manage-services.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/tui"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Use the TUI</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/agents"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Flows</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#monitor-services" class="table-of-contents__link toc-highlight">Monitor services</a></li><li><a href="#stop-and-start-containers" class="table-of-contents__link toc-highlight">Stop and start containers</a></li><li><a href="#start-native-services" class="table-of-contents__link toc-highlight">Stop, start, and inspect native services (Docling)</a></li><li><a href="#upgrade-services" class="table-of-contents__link toc-highlight">Upgrade services</a></li><li><a href="#reset-containers" class="table-of-contents__link toc-highlight">Reset containers (destructive)</a><ul><li><a href="#export-customized-flows-before-resetting-containers" class="table-of-contents__link toc-highlight">Export customized flows before resetting containers</a></li><li><a href="#factory-reset-with-the-tui" class="table-of-contents__link toc-highlight">Factory Reset with the TUI</a></li><li><a href="#rebuild-self-managed-containers" class="table-of-contents__link toc-highlight">Rebuild self-managed containers</a></li><li><a href="#destroy-and-recreate-self-managed-containers" class="table-of-contents__link toc-highlight">Destroy and recreate self-managed containers</a></li></ul></li><li><a href="#see-also" class="table-of-contents__link toc-highlight">See also</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
|
||
<span>© 2025 OpenRAG</span>
|
||
</div></li></ul></div></div></div></footer></div>
|
||
</body>
|
||
</html> |