deploy: 44f3f70858
This commit is contained in:
zznate
parent
0e94b70d87
commit
4f59595763
16 changed files with 41 additions and 23 deletions
2
404.html
2
404.html
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">OpenRAG</title><meta data-rh="true" property="og:title" content="OpenRAG"><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/404.html"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/404.html"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/404.html" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.51333837.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.c8893f6b.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Langflow Agents | 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/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="Langflow Agents | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG leverages Langflow's Agent component to power the OpenRAG OpenSearch Agent flow."><meta data-rh="true" property="og:description" content="OpenRAG leverages Langflow's Agent component to power the OpenRAG OpenSearch Agent flow."><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":"Langflow Agents","item":"https://docs.openr.ag/agents"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.51333837.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.c8893f6b.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
1
assets/js/749371cc.c67142db.js
Normal file
1
assets/js/749371cc.c67142db.js
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1 +1 @@
|
|||
(()=>{"use strict";var e,t,r,a,o,n={},f={};function c(e){var t=f[e];if(void 0!==t)return t.exports;var r=f[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,c),r.loaded=!0,r.exports}c.m=n,c.c=f,e=[],c.O=(t,r,a,o)=>{if(!r){var n=1/0;for(u=0;u<e.length;u++){r=e[u][0],a=e[u][1],o=e[u][2];for(var f=!0,i=0;i<r.length;i++)(!1&o||n>=o)&&Object.keys(c.O).every(e=>c.O[e](r[i]))?r.splice(i--,1):(f=!1,o<n&&(n=o));if(f){e.splice(u--,1);var d=a();void 0!==d&&(t=d)}}return t}o=o||0;for(var u=e.length;u>0&&e[u-1][2]>o;u--)e[u]=e[u-1];e[u]=[r,a,o]},c.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return c.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,c.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);c.r(o);var n={};t=t||[null,r({}),r([]),r(r)];for(var f=2&a&&e;("object"==typeof f||"function"==typeof f)&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach(t=>n[t]=()=>e[t]);return n.default=()=>e,c.d(o,n),o},c.d=(e,t)=>{for(var r in t)c.o(t,r)&&!c.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},c.f={},c.e=e=>Promise.all(Object.keys(c.f).reduce((t,r)=>(c.f[r](e,t),t),[])),c.u=e=>"assets/js/"+({26:"c8078f0a",48:"a94703ab",98:"a7bd4aaa",172:"e633a5ea",272:"749371cc",401:"17896441",532:"33362219",567:"22dd74f7",571:"0ba6a408",647:"5e95c892",668:"eb5b356a",717:"af920ffe",742:"aba21aa0",750:"d0314b07",919:"ca2c3c0c",961:"21afe7ac"}[e]||e)+"."+{26:"95121b15",48:"37079d87",98:"5b195d0f",172:"cbe02eaa",237:"4f1a14e7",272:"cc93e3ef",401:"3584c216",532:"d86f431d",567:"5a552cfa",571:"21d91e2f",647:"a118483c",668:"516bb081",717:"36fc9a9a",742:"ff196c6d",750:"81b2f228",758:"382c453d",919:"295b1c55",961:"f0feb7d8"}[e]+".js",c.miniCssF=e=>{},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="openrag-docs:",c.l=(e,t,r,n)=>{if(a[e])a[e].push(t);else{var f,i;if(void 0!==r)for(var d=document.getElementsByTagName("script"),u=0;u<d.length;u++){var l=d[u];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==o+r){f=l;break}}f||(i=!0,(f=document.createElement("script")).charset="utf-8",f.timeout=120,c.nc&&f.setAttribute("nonce",c.nc),f.setAttribute("data-webpack",o+r),f.src=e),a[e]=[t];var s=(t,r)=>{f.onerror=f.onload=null,clearTimeout(b);var o=a[e];if(delete a[e],f.parentNode&&f.parentNode.removeChild(f),o&&o.forEach(e=>e(r)),t)return t(r)},b=setTimeout(s.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=s.bind(null,f.onerror),f.onload=s.bind(null,f.onload),i&&document.head.appendChild(f)}},c.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c.p="/",c.gca=function(e){return e={17896441:"401",33362219:"532",c8078f0a:"26",a94703ab:"48",a7bd4aaa:"98",e633a5ea:"172","749371cc":"272","22dd74f7":"567","0ba6a408":"571","5e95c892":"647",eb5b356a:"668",af920ffe:"717",aba21aa0:"742",d0314b07:"750",ca2c3c0c:"919","21afe7ac":"961"}[e]||e,c.p+c.u(e)},(()=>{var e={354:0,869:0};c.f.j=(t,r)=>{var a=c.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(354|869)$/.test(t))e[t]=0;else{var o=new Promise((r,o)=>a=e[t]=[r,o]);r.push(a[2]=o);var n=c.p+c.u(t),f=new Error;c.l(n,r=>{if(c.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;f.message="Loading chunk "+t+" failed.\n("+o+": "+n+")",f.name="ChunkLoadError",f.type=o,f.request=n,a[1](f)}},"chunk-"+t,t)}},c.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,n=r[0],f=r[1],i=r[2],d=0;if(n.some(t=>0!==e[t])){for(a in f)c.o(f,a)&&(c.m[a]=f[a]);if(i)var u=i(c)}for(t&&t(r);d<n.length;d++)o=n[d],c.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return c.O(u)},r=self.webpackChunkopenrag_docs=self.webpackChunkopenrag_docs||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})()})();
|
||||
(()=>{"use strict";var e,t,r,a,o,n={},f={};function c(e){var t=f[e];if(void 0!==t)return t.exports;var r=f[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,c),r.loaded=!0,r.exports}c.m=n,c.c=f,e=[],c.O=(t,r,a,o)=>{if(!r){var n=1/0;for(u=0;u<e.length;u++){r=e[u][0],a=e[u][1],o=e[u][2];for(var f=!0,i=0;i<r.length;i++)(!1&o||n>=o)&&Object.keys(c.O).every(e=>c.O[e](r[i]))?r.splice(i--,1):(f=!1,o<n&&(n=o));if(f){e.splice(u--,1);var d=a();void 0!==d&&(t=d)}}return t}o=o||0;for(var u=e.length;u>0&&e[u-1][2]>o;u--)e[u]=e[u-1];e[u]=[r,a,o]},c.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return c.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,c.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);c.r(o);var n={};t=t||[null,r({}),r([]),r(r)];for(var f=2&a&&e;("object"==typeof f||"function"==typeof f)&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach(t=>n[t]=()=>e[t]);return n.default=()=>e,c.d(o,n),o},c.d=(e,t)=>{for(var r in t)c.o(t,r)&&!c.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},c.f={},c.e=e=>Promise.all(Object.keys(c.f).reduce((t,r)=>(c.f[r](e,t),t),[])),c.u=e=>"assets/js/"+({26:"c8078f0a",48:"a94703ab",98:"a7bd4aaa",172:"e633a5ea",272:"749371cc",401:"17896441",532:"33362219",567:"22dd74f7",571:"0ba6a408",647:"5e95c892",668:"eb5b356a",717:"af920ffe",742:"aba21aa0",750:"d0314b07",919:"ca2c3c0c",961:"21afe7ac"}[e]||e)+"."+{26:"95121b15",48:"37079d87",98:"5b195d0f",172:"cbe02eaa",237:"4f1a14e7",272:"c67142db",401:"3584c216",532:"d86f431d",567:"5a552cfa",571:"21d91e2f",647:"a118483c",668:"516bb081",717:"36fc9a9a",742:"ff196c6d",750:"81b2f228",758:"382c453d",919:"7eb785b4",961:"e09a4f35"}[e]+".js",c.miniCssF=e=>{},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="openrag-docs:",c.l=(e,t,r,n)=>{if(a[e])a[e].push(t);else{var f,i;if(void 0!==r)for(var d=document.getElementsByTagName("script"),u=0;u<d.length;u++){var l=d[u];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==o+r){f=l;break}}f||(i=!0,(f=document.createElement("script")).charset="utf-8",f.timeout=120,c.nc&&f.setAttribute("nonce",c.nc),f.setAttribute("data-webpack",o+r),f.src=e),a[e]=[t];var b=(t,r)=>{f.onerror=f.onload=null,clearTimeout(s);var o=a[e];if(delete a[e],f.parentNode&&f.parentNode.removeChild(f),o&&o.forEach(e=>e(r)),t)return t(r)},s=setTimeout(b.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=b.bind(null,f.onerror),f.onload=b.bind(null,f.onload),i&&document.head.appendChild(f)}},c.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c.p="/",c.gca=function(e){return e={17896441:"401",33362219:"532",c8078f0a:"26",a94703ab:"48",a7bd4aaa:"98",e633a5ea:"172","749371cc":"272","22dd74f7":"567","0ba6a408":"571","5e95c892":"647",eb5b356a:"668",af920ffe:"717",aba21aa0:"742",d0314b07:"750",ca2c3c0c:"919","21afe7ac":"961"}[e]||e,c.p+c.u(e)},(()=>{var e={354:0,869:0};c.f.j=(t,r)=>{var a=c.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(354|869)$/.test(t))e[t]=0;else{var o=new Promise((r,o)=>a=e[t]=[r,o]);r.push(a[2]=o);var n=c.p+c.u(t),f=new Error;c.l(n,r=>{if(c.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;f.message="Loading chunk "+t+" failed.\n("+o+": "+n+")",f.name="ChunkLoadError",f.type=o,f.request=n,a[1](f)}},"chunk-"+t,t)}},c.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,n=r[0],f=r[1],i=r[2],d=0;if(n.some(t=>0!==e[t])){for(a in f)c.o(f,a)&&(c.m[a]=f[a]);if(i)var u=i(c)}for(t&&t(r);d<n.length;d++)o=n[d],c.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return c.O(u)},r=self.webpackChunkopenrag_docs=self.webpackChunkopenrag_docs||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})()})();
|
||||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Deploy with Docker | 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/get-started/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 with Docker | OpenRAG"><meta data-rh="true" name="description" content="There are two different Docker Compose files."><meta data-rh="true" property="og:description" content="There are two different Docker Compose files."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/get-started/docker"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/get-started/docker" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/get-started/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 with Docker","item":"https://docs.openr.ag/get-started/docker"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.51333837.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.c8893f6b.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -21,6 +21,7 @@ They deploy the same applications and containers, but to different environments.
|
|||
<p><a href="https://github.com/langflow-ai/openrag/blob/main/docker-compose-cpu.yml" target="_blank" rel="noopener noreferrer"><code>docker-compose-cpu.yml</code></a> is a CPU-only version of OpenRAG for systems without GPU support. Use this Docker compose file for environments where GPU drivers aren't available.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Both Docker deployments depend on <code>docling serve</code> to be running on port <code>5001</code> on the host machine. This enables <a href="https://opensource.apple.com/projects/mlx/" target="_blank" rel="noopener noreferrer">Mac MLX</a> support for document processing. Installing OpenRAG with the TUI starts <code>docling serve</code> automatically, but for a Docker deployment you must manually start the <code>docling serve</code> process.</p>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="prerequisites">Prerequisites<a href="#prerequisites" class="hash-link" aria-label="Direct link to Prerequisites" title="Direct link to Prerequisites"></a></h2>
|
||||
<ul>
|
||||
<li><a href="https://www.python.org/downloads/release/python-3100/" target="_blank" rel="noopener noreferrer">Python Version 3.10 to 3.13</a></li>
|
||||
|
|
@ -38,6 +39,10 @@ They deploy the same applications and containers, but to different environments.
|
|||
<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">git clone https://github.com/langflow-ai/openrag.git</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">cd openrag</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
<li>
|
||||
<p>Install dependencies.</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 sync</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
<li>
|
||||
<p>Copy the example <code>.env</code> file included in the repository root.
|
||||
The example file includes all environment variables with comments to guide you in finding and setting their values.</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">cp .env.example .env</span><br></span></code></pre></div></div>
|
||||
|
|
@ -51,10 +56,21 @@ The following values are <strong>required</strong> to be set:</p>
|
|||
<p>For more information on configuring OpenRAG with environment variables, see <a href="/reference/configuration">Environment variables</a>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Start <code>docling serve</code> on the host machine.
|
||||
Both Docker deployments depend on <code>docling serve</code> to be running on port <code>5001</code> on the host machine. This enables <a href="https://opensource.apple.com/projects/mlx/" target="_blank" rel="noopener noreferrer">Mac MLX</a> support for document processing.</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 --port 5001</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
<li>
|
||||
<p>Confirm <code>docling serve</code> is running.</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">uv run python scripts/docling_ctl.py status</span><br></span></code></pre></div></div>
|
||||
<p>Successful result:</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">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>
|
||||
<li>
|
||||
<p>Deploy OpenRAG with Docker Compose based on your deployment type.</p>
|
||||
<p>For GPU-enabled systems, run the following command:</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">docker compose up -d</span><br></span></code></pre></div></div>
|
||||
<p>For CPU-only systems, run the following command:</p>
|
||||
<p>For GPU-enabled systems, run the following commands:</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">docker compose build</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">docker compose up -d</span><br></span></code></pre></div></div>
|
||||
<p>For environments without GPU support, run:</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">docker compose -f docker-compose-cpu.yml up -d</span><br></span></code></pre></div></div>
|
||||
<p>The OpenRAG Docker Compose file starts five containers:</p>
|
||||
<table><thead><tr><th>Container Name</th><th>Default Address</th><th>Purpose</th></tr></thead><tbody><tr><td>OpenRAG Backend</td><td><a href="http://localhost:8000" target="_blank" rel="noopener noreferrer">http://localhost:8000</a></td><td>FastAPI server and core functionality.</td></tr><tr><td>OpenRAG Frontend</td><td><a href="http://localhost:3000" target="_blank" rel="noopener noreferrer">http://localhost:3000</a></td><td>React web interface for users.</td></tr><tr><td>Langflow</td><td><a href="http://localhost:7860" target="_blank" rel="noopener noreferrer">http://localhost:7860</a></td><td>AI workflow engine and flow management.</td></tr><tr><td>OpenSearch</td><td><a href="http://localhost:9200" target="_blank" rel="noopener noreferrer">http://localhost:9200</a></td><td>Vector database for document storage.</td></tr><tr><td>OpenSearch Dashboards</td><td><a href="http://localhost:5601" target="_blank" rel="noopener noreferrer">http://localhost:5601</a></td><td>Database administration interface.</td></tr></tbody></table>
|
||||
|
|
@ -73,6 +89,8 @@ The following values are <strong>required</strong> to be set:</p>
|
|||
<p>Continue with <a href="#application-onboarding">Application Onboarding</a>.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p>To stop <code>docling serve</code> when you're done with your OpenRAG deployment, run:</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>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="application-onboarding">Application onboarding<a href="#application-onboarding" class="hash-link" aria-label="Direct link to Application onboarding" title="Direct link to Application onboarding"></a></h2>
|
||||
<p>The first time you start OpenRAG, whether using the TUI or a <code>.env</code> file, you must complete application onboarding.</p>
|
||||
<p>Most values from onboarding can be changed later in the OpenRAG <strong>Settings</strong> page, but there are important restrictions.</p>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Terminal User Interface (TUI) commands | 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/get-started/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="Terminal User Interface (TUI) commands | OpenRAG"><meta data-rh="true" name="description" content="The OpenRAG Terminal User Interface (TUI) allows you to set up, configure, and monitor your OpenRAG deployment directly from the terminal, on any operating system."><meta data-rh="true" property="og:description" content="The OpenRAG Terminal User Interface (TUI) allows you to set up, configure, and monitor your OpenRAG deployment directly from the terminal, on any operating system."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/get-started/tui"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/get-started/tui" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/get-started/tui" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Terminal User Interface (TUI)","item":"https://docs.openr.ag/get-started/tui"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.51333837.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.c8893f6b.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -40,8 +40,8 @@ The TUI then pulls the images and deploys the containers with the following comm
|
|||
<p>If images are missing, the TUI runs <code>docker compose pull</code>, then runs <code>docker compose up -d</code>.</p>
|
||||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="start-native-services">Start native services<a href="#start-native-services" class="hash-link" aria-label="Direct link to Start native services" title="Direct link to Start native services"></a></h3>
|
||||
<p>A "native" service in OpenRAG refers to a service run natively on your machine, and not within a container.
|
||||
The <code>docling-serve</code> process is a native service in OpenRAG, because it's a document processing service that is run on your local machine, and controlled separately from the containers.</p>
|
||||
<p>To start or stop <code>docling-serve</code> or any other native services, in the TUI main menu, click <strong>Start Native Services</strong> or <strong>Stop Native Services</strong>.</p>
|
||||
The <code>docling serve</code> process is a native service in OpenRAG, because it's a document processing service that is run on your local machine, and controlled separately from the containers.</p>
|
||||
<p>To start or stop <code>docling serve</code> or any other native services, in the TUI main menu, click <strong>Start Native Services</strong> or <strong>Stop Native Services</strong>.</p>
|
||||
<p>To view the status, port, or PID of a native service, in the TUI main menu, click <a href="#status">Status</a>.</p>
|
||||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="status">Status<a href="#status" class="hash-link" aria-label="Direct link to Status" title="Direct link to Status"></a></h3>
|
||||
<p>The <strong>Status</strong> menu displays information on your container deployment.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<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="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."><meta data-rh="true" property="og:description" content="OpenRAG is an open-source package for building agentic RAG systems."><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.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.51333837.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.c8893f6b.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Install OpenRAG | 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/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 | OpenRAG"><meta data-rh="true" name="description" content="Install the OpenRAG Python wheel, and then run the OpenRAG Terminal User Interface(TUI) to start your OpenRAG deployment with a guided setup process."><meta data-rh="true" property="og:description" content="Install the OpenRAG Python wheel, and then run the OpenRAG Terminal User Interface(TUI) to start your OpenRAG deployment with a guided setup process."><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":"Install OpenRAG","item":"https://docs.openr.ag/install"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.51333837.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.c8893f6b.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">OpenSearch Knowledge | 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/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="OpenSearch Knowledge | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG uses OpenSearch for its vector-backed knowledge store."><meta data-rh="true" property="og:description" content="OpenRAG uses OpenSearch for its vector-backed knowledge store."><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":"OpenSearch Knowledge","item":"https://docs.openr.ag/knowledge"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.51333837.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.c8893f6b.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<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="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="Get started with OpenRAG by loading your knowledge, swapping out your language model, and then chatting with the OpenRAG API."><meta data-rh="true" property="og:description" content="Get started with OpenRAG by loading your knowledge, swapping out your language model, and then chatting with the OpenRAG API."><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.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.51333837.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.c8893f6b.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<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="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 recognizes supported environment variables from the following sources:"><meta data-rh="true" property="og:description" content="OpenRAG recognizes supported environment variables from the following sources:"><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.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.51333837.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.c8893f6b.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Troubleshoot | 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/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"><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","item":"https://docs.openr.ag/support/troubleshoot"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.51333837.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.c8893f6b.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue