gmakstutis/openrag
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openrag/manage-services/index.html
aimurphy ce92e1c02e deploy: 83c90a760f
2026-01-17 00:29:31 +00:00

110 lines
No EOL
33 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="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"><link data-rh="true" rel="preconnect" href="https://SMEA51Q5OL-dsn.algolia.net" crossorigin="anonymous"><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="search" type="application/opensearchdescription+xml" title="OpenRAG" href="/opensearch.xml">
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("consent","default",{ad_storage:"denied",ad_user_data:"denied",ad_personalization:"denied",analytics_storage:"denied"})</script>
<script>!function(){function e(){if(void 0!==window.truste&&window.truste.cma){var e=window.truste.cma.callApi("getConsent",window.location.href)||{},n=1===e[2],t=1===e[3];gtag("consent","update",{ad_storage:n?"granted":"denied",ad_user_data:n?"granted":"denied",ad_personalization:n?"granted":"denied",analytics_storage:t?"granted":"denied"})}}window.addEventListener&&(window.addEventListener("cm_data_subject_consent_changed",e),window.addEventListener("cm_consent_preferences_set",e)),"complete"===document.readyState?e():window.addEventListener("load",e)}()</script>
<script>window._ibmAnalytics={settings:{name:"DataStax",tealiumProfileName:"ibm-subsidiary"},trustarc:{privacyPolicyLink:"https://ibm.com/privacy"}},window.digitalData={page:{pageInfo:{ibm:{siteId:"IBM_DataStax"}},category:{primaryCategory:"PC230"}}}</script>
<script src="//1.www.s81c.com/common/stats/ibm-common.js" async="true"></script><link rel="stylesheet" href="/assets/css/styles.29e42e49.css">
<script src="/assets/js/runtime~main.a09b72d8.js" defer="defer"></script>
<script src="/assets/js/main.e1ba3126.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"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Meta+k)" aria-keyshortcuts="Meta+k"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 24 24" aria-hidden="true"><circle cx="11" cy="11" r="8" stroke="currentColor" fill="none" stroke-width="1.4"></circle><path d="m21 21-4.3-4.3" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></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="/reference/api-sdk-overview"><span title="APIs and SDKs" class="linkLabel_WmDU">APIs and SDKs</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/support/contribute"><span title="Contribute to OpenRAG" class="linkLabel_WmDU">Contribute to OpenRAG</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/support/troubleshoot"><span title="Troubleshoot OpenRAG" class="linkLabel_WmDU">Troubleshoot OpenRAG</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a href="https://github.com/langflow-ai/openrag/releases" target="_blank" rel="noopener noreferrer" class="menu__link menuExternalLink_NmtK"><span title="Changelog" class="linkLabel_WmDU">Changelog</span><svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></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-and-view-logs">Monitor services and view logs<a href="#monitor-services-and-view-logs" class="hash-link" aria-label="Direct link to Monitor services and view logs" title="Direct link to Monitor services and view logs" translate="no">​</a></h2>
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>In the TUI, click <strong>Status</strong> to access diagnostics and controls for all OpenRAG services, including container health, ports, and image versions.</p><p>To view streaming logs, click the name of a service, and then press <kbd>l</kbd>.</p><p>For the Docling native service, see <a href="#start-native-services" class="">Stop, start, and inspect native services</a>.</p></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>For self-managed container services, you can get container logs with <a href="https://docs.docker.com/reference/cli/docker/compose/logs/" target="_blank" rel="noopener noreferrer" class=""><code>docker compose logs</code></a> or <a href="https://docs.podman.io/en/latest/markdown/podman-logs.1.html" target="_blank" rel="noopener noreferrer" class=""><code>podman logs</code></a>.</p><p>For the Docling native service, see <a href="#start-native-services" class="">Stop, start, and inspect native services</a>.</p></div></div></div>
<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>On the TUI&#x27;s <strong>Status</strong> page, you can stop, start, and restart OpenRAG&#x27;s container-based services.</p><p>When you click <strong>Restart</strong> or <strong>Start Services</strong>, the following processes are triggered:</p><ol>
<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>On the TUI&#x27;s <strong>Status</strong> page, you can stop, start, restart, and inspect OpenRAG&#x27;s native services.</p><p>The <strong>Native Services</strong> section lists the status, port, and process ID (PID) for each native service.</p><p>To manage a native service, click the service&#x27;s name, and then click <strong>Stop</strong>, <strong>Start</strong> or <strong>Restart</strong>.</p><p>To view the logs for a native service, click the service&#x27;s name, and then press <kbd>l</kbd>.</p></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Because the Docling service doesn&#x27;t run in a container, you must start and stop it manually on the host machine:</p><ul>
<li class="">
<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>
<div class="theme-admonition theme-admonition-warning admonition_xJq3 alert alert--warning"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>warning</div><div class="admonitionContent_BuS1"><p>This is a destructive operation that does the following:</p><ul>
<li class="">Destroys all OpenRAG containers, volumes, and local images.</li>
<li class="">Prunes any additional container objects.</li>
<li class="">Deletes the contents of the <code>~/.openrag</code> directory <em>except</em> for OpenRAG&#x27;s <code>.env</code> file and the <code>/documents</code> subdirectory.</li>
</ul><p></p><p></p>Destroyed containers and deleted data are lost and cannot be recovered after running this operation.<p></p></div></div>
<p>Use these steps to reset your OpenRAG deployment by recreating the containers and deleting all data in the <code>~/.openrag</code> directory <em>except</em> for the <code>.env</code> file and the <code>/documents</code> subdirectory.</p>
<p>This restores your OpenRAG deployment to a near-initial state while preserving your configuration (in <code>.env</code>) and uploaded documents (in <code>/documents</code>).
Your documents are reingested into a fresh OpenSearch index after the reset.</p>
<p>To reset your OpenRAG deployment <em>and</em> delete all OpenRAG data, see <a class="" href="/reinstall">Reinstall OpenRAG</a>.</p>
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">TUI-managed services</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Self-managed services</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><ol>
<li class="">If you modified the built-in flows or created custom flows in your <a class="" href="/agents">OpenRAG Langflow instance</a>, <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>
</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>
<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>, <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>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Docker</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">docker</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">--build</span><span class="token plain"> --force-recreate --remove-orphans</span><br></span></code></pre></div></div>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockTitle_OeMC">Podman</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">podman</span><span class="token plain"> compose up </span><span class="token parameter variable" style="color:#36acaa">--build</span><span class="token plain"> --force-recreate --remove-orphans</span><br></span></code></pre></div></div>
</li>
<li class="">
<p>Launch the OpenRAG app, and then repeat the <a class="" href="/docker#application-onboarding">application onboarding process</a>.</p>
</li>
<li class="">
<p>If you exported customized flows, <a href="https://docs.langflow.org/concepts-flows-import" target="_blank" rel="noopener noreferrer" class="">import your flows</a> into Langflow after completing the onboarding process.</p>
</li>
</ol></div></div></div>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="prune-images">Prune images<a href="#prune-images" class="hash-link" aria-label="Direct link to Prune images" title="Direct link to Prune images" translate="no">​</a></h2>
<p>Use image pruning to free up disk space by removing unused OpenRAG container images.</p>
<p>For TUI-managed services, use the TUI&#x27;s <strong>Prune Images</strong> option to clean up your OpenRAG container images.
You can choose to prune unused images only or all images.
If you prune all images, the OpenRAG services are stopped, all images are pruned, and then the required images are pulled the next time you start the OpenRAG services.</p>
<p>For self-managed services, use <a href="https://docs.docker.com/engine/reference/commandline/image_prune/" target="_blank" rel="noopener noreferrer" class=""><code>docker image prune</code></a> or <a href="https://docs.podman.io/en/latest/markdown/podman-image-prune.1.html" target="_blank" rel="noopener noreferrer" class=""><code>podman image prune</code></a> to remove unused images.</p>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="see-also">See also<a href="#see-also" class="hash-link" aria-label="Direct link to See also" title="Direct link to See also" translate="no">​</a></h2>
<ul>
<li class=""><a class="" href="/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>© 2026 OpenRAG</span>
<span id="preferenceCenterContainer"> ·&nbsp; <a href="#" onclick='return"undefined"!=typeof window&&window.truste&&window.truste.eu&&window.truste.eu.clickListener&&window.truste.eu.clickListener(),!1' style="cursor: pointer;">Manage Privacy Choices</a></span>
</div></li></ul></div></div></div></footer></div>
</body>
</html>
Reference in a new issue View git blame Copy permalink