deploy: ef2014f82e
This commit is contained in:
aimurphy
parent
bff942537b
commit
1b642b9efe
19 changed files with 102 additions and 83 deletions
2
404.html
2
404.html
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">OpenRAG</title><meta data-rh="true" property="og:title" content="OpenRAG"><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/404.html"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/404.html"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/404.html" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.ce59c02b.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.e45e845e.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.c55814c2.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Use Langflow in OpenRAG | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/agents"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Use Langflow in OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG includes a built-in Langflow instance for creating and managing functional application workflows called flows."><meta data-rh="true" property="og:description" content="OpenRAG includes a built-in Langflow instance for creating and managing functional application workflows called flows."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/agents"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/agents" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/agents" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Flows","item":"https://docs.openr.ag/agents"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.ce59c02b.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.e45e845e.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.c55814c2.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1
assets/js/d0314b07.7b0b4caa.js
Normal file
1
assets/js/d0314b07.7b0b4caa.js
Normal file
File diff suppressed because one or more lines are too long
1
assets/js/eb5b356a.5256f349.js
Normal file
1
assets/js/eb5b356a.5256f349.js
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1 +1 @@
|
|||
(()=>{"use strict";var e,a,t,r,o,c={},n={};function d(e){var a=n[e];if(void 0!==a)return a.exports;var t=n[e]={id:e,loaded:!1,exports:{}};return c[e].call(t.exports,t,t.exports,d),t.loaded=!0,t.exports}d.m=c,d.c=n,e=[],d.O=(a,t,r,o)=>{if(!t){var c=1/0;for(b=0;b<e.length;b++){t=e[b][0],r=e[b][1],o=e[b][2];for(var n=!0,f=0;f<t.length;f++)(!1&o||c>=o)&&Object.keys(d.O).every(e=>d.O[e](t[f]))?t.splice(f--,1):(n=!1,o<c&&(c=o));if(n){e.splice(b--,1);var i=r();void 0!==i&&(a=i)}}return a}o=o||0;for(var b=e.length;b>0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[t,r,o]},d.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return d.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var o=Object.create(null);d.r(o);var c={};a=a||[null,t({}),t([]),t(t)];for(var n=2&r&&e;("object"==typeof n||"function"==typeof n)&&!~a.indexOf(n);n=t(n))Object.getOwnPropertyNames(n).forEach(a=>c[a]=()=>e[a]);return c.default=()=>e,d.d(o,c),o},d.d=(e,a)=>{for(var t in a)d.o(a,t)&&!d.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce((a,t)=>(d.f[t](e,a),a),[])),d.u=e=>"assets/js/"+({98:"af920ffe",571:"0ba6a408",1567:"22dd74f7",2076:"common",2272:"749371cc",2668:"eb5b356a",3207:"27b4a875",5490:"71478a5d",5742:"aba21aa0",5750:"d0314b07",6919:"ca2c3c0c",7098:"a7bd4aaa",8401:"17896441",9026:"c8078f0a",9048:"a94703ab",9172:"e633a5ea",9532:"33362219",9647:"5e95c892"}[e]||e)+"."+{98:"bef0ec8d",165:"c26d6a3e",291:"cd97fb9c",571:"dd2959ac",617:"1447cf1d",1e3:"3d4d9f77",1203:"6c86c874",1567:"b9173093",1741:"070da722",1746:"4b809a87",2076:"0dd27f1f",2130:"0c95b4e7",2237:"b77c091f",2272:"6ea54965",2279:"0f9c36da",2291:"8a38f6d3",2325:"d0a48f1d",2334:"dbc94d93",2668:"5a0abd05",2821:"5850139d",3207:"26de3408",3488:"7023792e",3490:"618f86cf",3815:"503d6709",4250:"12e4bf74",4379:"c2ae56a8",4616:"28af5598",4802:"bbffcf8d",4981:"1178b3ff",5480:"82213497",5490:"3a49b919",5742:"35622335",5750:"788dda5b",5901:"a84db486",5955:"6630df13",5996:"aa2ae341",6241:"70145387",6319:"c05e2240",6366:"03bf2589",6567:"44bf886a",6919:"e8524bce",6992:"ce79b8a2",7098:"bc099609",7592:"35906688",7873:"ad98bc5d",7928:"25b35ee3",8142:"538be8cd",8249:"7b519ea1",8401:"11b57c0a",8565:"cea3e8a9",8756:"a32f496b",9026:"d456318f",9032:"8d15afa4",9048:"bfa519e3",9172:"6a095ec9",9412:"74eee71d",9510:"f78dc8f8",9532:"356477a0",9647:"251a99dd"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},o="openrag-docs:",d.l=(e,a,t,c)=>{if(r[e])r[e].push(a);else{var n,f;if(void 0!==t)for(var i=document.getElementsByTagName("script"),b=0;b<i.length;b++){var u=i[b];if(u.getAttribute("src")==e||u.getAttribute("data-webpack")==o+t){n=u;break}}n||(f=!0,(n=document.createElement("script")).charset="utf-8",n.timeout=120,d.nc&&n.setAttribute("nonce",d.nc),n.setAttribute("data-webpack",o+t),n.src=e),r[e]=[a];var l=(a,t)=>{n.onerror=n.onload=null,clearTimeout(s);var o=r[e];if(delete r[e],n.parentNode&&n.parentNode.removeChild(n),o&&o.forEach(e=>e(t)),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=l.bind(null,n.onerror),n.onload=l.bind(null,n.onload),f&&document.head.appendChild(n)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/",d.gca=function(e){return e={17896441:"8401",33362219:"9532",af920ffe:"98","0ba6a408":"571","22dd74f7":"1567",common:"2076","749371cc":"2272",eb5b356a:"2668","27b4a875":"3207","71478a5d":"5490",aba21aa0:"5742",d0314b07:"5750",ca2c3c0c:"6919",a7bd4aaa:"7098",c8078f0a:"9026",a94703ab:"9048",e633a5ea:"9172","5e95c892":"9647"}[e]||e,d.p+d.u(e)},(()=>{var e={5354:0,1869:0};d.f.j=(a,t)=>{var r=d.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var o=new Promise((t,o)=>r=e[a]=[t,o]);t.push(r[2]=o);var c=d.p+d.u(a),n=new Error;d.l(c,t=>{if(d.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var o=t&&("load"===t.type?"missing":t.type),c=t&&t.target&&t.target.src;n.message="Loading chunk "+a+" failed.\n("+o+": "+c+")",n.name="ChunkLoadError",n.type=o,n.request=c,r[1](n)}},"chunk-"+a,a)}},d.O.j=a=>0===e[a];var a=(a,t)=>{var r,o,c=t[0],n=t[1],f=t[2],i=0;if(c.some(a=>0!==e[a])){for(r in n)d.o(n,r)&&(d.m[r]=n[r]);if(f)var b=f(d)}for(a&&a(t);i<c.length;i++)o=c[i],d.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return d.O(b)},t=self.webpackChunkopenrag_docs=self.webpackChunkopenrag_docs||[];t.forEach(a.bind(null,0)),t.push=a.bind(null,t.push.bind(t))})()})();
|
||||
(()=>{"use strict";var e,a,t,r,o,c={},n={};function d(e){var a=n[e];if(void 0!==a)return a.exports;var t=n[e]={id:e,loaded:!1,exports:{}};return c[e].call(t.exports,t,t.exports,d),t.loaded=!0,t.exports}d.m=c,d.c=n,e=[],d.O=(a,t,r,o)=>{if(!t){var c=1/0;for(b=0;b<e.length;b++){t=e[b][0],r=e[b][1],o=e[b][2];for(var n=!0,f=0;f<t.length;f++)(!1&o||c>=o)&&Object.keys(d.O).every(e=>d.O[e](t[f]))?t.splice(f--,1):(n=!1,o<c&&(c=o));if(n){e.splice(b--,1);var i=r();void 0!==i&&(a=i)}}return a}o=o||0;for(var b=e.length;b>0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[t,r,o]},d.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return d.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var o=Object.create(null);d.r(o);var c={};a=a||[null,t({}),t([]),t(t)];for(var n=2&r&&e;("object"==typeof n||"function"==typeof n)&&!~a.indexOf(n);n=t(n))Object.getOwnPropertyNames(n).forEach(a=>c[a]=()=>e[a]);return c.default=()=>e,d.d(o,c),o},d.d=(e,a)=>{for(var t in a)d.o(a,t)&&!d.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce((a,t)=>(d.f[t](e,a),a),[])),d.u=e=>"assets/js/"+({98:"af920ffe",571:"0ba6a408",1567:"22dd74f7",2076:"common",2272:"749371cc",2668:"eb5b356a",3207:"27b4a875",5490:"71478a5d",5742:"aba21aa0",5750:"d0314b07",6919:"ca2c3c0c",7098:"a7bd4aaa",8401:"17896441",9026:"c8078f0a",9048:"a94703ab",9172:"e633a5ea",9532:"33362219",9647:"5e95c892"}[e]||e)+"."+{98:"140c3203",165:"c26d6a3e",291:"cd97fb9c",571:"dd2959ac",617:"1447cf1d",1e3:"3d4d9f77",1203:"6c86c874",1567:"b9173093",1741:"070da722",1746:"4b809a87",2076:"0dd27f1f",2130:"0c95b4e7",2237:"b77c091f",2272:"6ea54965",2279:"0f9c36da",2291:"8a38f6d3",2325:"d0a48f1d",2334:"dbc94d93",2668:"5256f349",2821:"5850139d",3207:"26de3408",3488:"7023792e",3490:"618f86cf",3815:"503d6709",4250:"12e4bf74",4379:"c2ae56a8",4616:"28af5598",4802:"bbffcf8d",4981:"1178b3ff",5480:"82213497",5490:"3a49b919",5742:"35622335",5750:"7b0b4caa",5901:"a84db486",5955:"6630df13",5996:"aa2ae341",6241:"70145387",6319:"c05e2240",6366:"03bf2589",6567:"44bf886a",6919:"e8524bce",6992:"ce79b8a2",7098:"bc099609",7592:"35906688",7873:"ad98bc5d",7928:"25b35ee3",8142:"538be8cd",8249:"7b519ea1",8401:"11b57c0a",8565:"cea3e8a9",8756:"a32f496b",9026:"f1c0e5b8",9032:"8d15afa4",9048:"bfa519e3",9172:"6a095ec9",9412:"74eee71d",9510:"f78dc8f8",9532:"356477a0",9647:"251a99dd"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},o="openrag-docs:",d.l=(e,a,t,c)=>{if(r[e])r[e].push(a);else{var n,f;if(void 0!==t)for(var i=document.getElementsByTagName("script"),b=0;b<i.length;b++){var u=i[b];if(u.getAttribute("src")==e||u.getAttribute("data-webpack")==o+t){n=u;break}}n||(f=!0,(n=document.createElement("script")).charset="utf-8",n.timeout=120,d.nc&&n.setAttribute("nonce",d.nc),n.setAttribute("data-webpack",o+t),n.src=e),r[e]=[a];var l=(a,t)=>{n.onerror=n.onload=null,clearTimeout(s);var o=r[e];if(delete r[e],n.parentNode&&n.parentNode.removeChild(n),o&&o.forEach(e=>e(t)),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=l.bind(null,n.onerror),n.onload=l.bind(null,n.onload),f&&document.head.appendChild(n)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/",d.gca=function(e){return e={17896441:"8401",33362219:"9532",af920ffe:"98","0ba6a408":"571","22dd74f7":"1567",common:"2076","749371cc":"2272",eb5b356a:"2668","27b4a875":"3207","71478a5d":"5490",aba21aa0:"5742",d0314b07:"5750",ca2c3c0c:"6919",a7bd4aaa:"7098",c8078f0a:"9026",a94703ab:"9048",e633a5ea:"9172","5e95c892":"9647"}[e]||e,d.p+d.u(e)},(()=>{var e={5354:0,1869:0};d.f.j=(a,t)=>{var r=d.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var o=new Promise((t,o)=>r=e[a]=[t,o]);t.push(r[2]=o);var c=d.p+d.u(a),n=new Error;d.l(c,t=>{if(d.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var o=t&&("load"===t.type?"missing":t.type),c=t&&t.target&&t.target.src;n.message="Loading chunk "+a+" failed.\n("+o+": "+c+")",n.name="ChunkLoadError",n.type=o,n.request=c,r[1](n)}},"chunk-"+a,a)}},d.O.j=a=>0===e[a];var a=(a,t)=>{var r,o,c=t[0],n=t[1],f=t[2],i=0;if(c.some(a=>0!==e[a])){for(r in n)d.o(n,r)&&(d.m[r]=n[r]);if(f)var b=f(d)}for(a&&a(t);i<c.length;i++)o=c[i],d.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return d.O(b)},t=self.webpackChunkopenrag_docs=self.webpackChunkopenrag_docs||[];t.forEach(a.bind(null,0)),t.push=a.bind(null,t.push.bind(t))})()})();
|
||||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Chat in OpenRAG | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/chat"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Chat in OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="After you upload documents to your knowledge base, you can use the OpenRAG Chat feature to interact with your knowledge through natural language queries."><meta data-rh="true" property="og:description" content="After you upload documents to your knowledge base, you can use the OpenRAG Chat feature to interact with your knowledge through natural language queries."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/chat"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/chat" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/chat" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Chat","item":"https://docs.openr.ag/chat"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.ce59c02b.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.e45e845e.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.c55814c2.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Install OpenRAG containers | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/docker"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Install OpenRAG containers | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG has two Docker Compose files. Both files deploy the same applications and containers locally, but they are for different environments:"><meta data-rh="true" property="og:description" content="OpenRAG has two Docker Compose files. Both files deploy the same applications and containers locally, but they are for different environments:"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/docker"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/docker" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/docker" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Install OpenRAG containers","item":"https://docs.openr.ag/docker"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.ce59c02b.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.e45e845e.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.c55814c2.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">What is OpenRAG? | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="What is OpenRAG? | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG is an open-source package for building agentic RAG systems that integrates with a wide range of orchestration tools, vector databases, and LLM providers."><meta data-rh="true" property="og:description" content="OpenRAG is an open-source package for building agentic RAG systems that integrates with a wide range of orchestration tools, vector databases, and LLM providers."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/" hreflang="x-default"><script data-rh="true">function insertBanner(){var n=document.createElement("div");n.id="__docusaurus-base-url-issue-banner-container";n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/</span> (default value)</p>\n <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n',document.body.prepend(n);var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,o="/"===s.substr(-1)?s:s+"/";e.innerHTML=o}document.addEventListener("DOMContentLoaded",function(){void 0===window.docusaurus&&insertBanner()})</script><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"About OpenRAG","item":"https://docs.openr.ag/"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.ce59c02b.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.e45e845e.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.c55814c2.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Ingest knowledge | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/ingestion"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Ingest knowledge | OpenRAG"><meta data-rh="true" name="description" content="Upload documents to your OpenRAG OpenSearch instance to populate your knowledge base with unique content, such as your own company documents, research papers, or websites."><meta data-rh="true" property="og:description" content="Upload documents to your OpenRAG OpenSearch instance to populate your knowledge base with unique content, such as your own company documents, research papers, or websites."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/ingestion"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/ingestion" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/ingestion" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Ingest knowledge","item":"https://docs.openr.ag/ingestion"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.ce59c02b.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.e45e845e.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.c55814c2.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Install OpenRAG with TUI | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/install"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Install OpenRAG with TUI | OpenRAG"><meta data-rh="true" name="description" content="Install OpenRAG 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 OpenRAG 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 with TUI","item":"https://docs.openr.ag/install"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.ce59c02b.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.e45e845e.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.c55814c2.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -323,40 +323,59 @@ For more information, see <a href="#tui-container-management" class="">Manage Op
|
|||
If you installed OpenRAG with <code>uvx</code>, run <code>uvx openrag</code>.</p>
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="tui-container-management">Manage OpenRAG containers with the TUI<a href="#tui-container-management" class="hash-link" aria-label="Direct link to Manage OpenRAG containers with the TUI" title="Direct link to Manage OpenRAG containers with the TUI" translate="no"></a></h2>
|
||||
<p>After installation, the TUI can deploy, manage, and upgrade your OpenRAG containers.</p>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="start-all-services">Start all services<a href="#start-all-services" class="hash-link" aria-label="Direct link to Start all services" title="Direct link to Start all services" translate="no"></a></h3>
|
||||
<p>Click <strong>Start All Services</strong> to start the OpenRAG containers.
|
||||
The TUI 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.
|
||||
The TUI then pulls the images and deploys the containers with 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>If images are missing, the TUI runs <code>docker compose pull</code>, then runs <code>docker compose up -d</code>.</p>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="diagnostics">Diagnostics<a href="#diagnostics" class="hash-link" aria-label="Direct link to Diagnostics" title="Direct link to Diagnostics" translate="no"></a></h3>
|
||||
<p>The <strong>Diagnostics</strong> menu provides health monitoring for your container runtimes and monitoring of your OpenSearch security.</p>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="status">Status<a href="#status" class="hash-link" aria-label="Direct link to Status" title="Direct link to Status" translate="no"></a></h3>
|
||||
<p>The <strong>Status</strong> menu displays information on your container deployment.
|
||||
Here you can check container health, find your service ports, view logs, and upgrade your containers.</p>
|
||||
<p>To view streaming logs, select the container you want to view, and press <kbd>l</kbd>.
|
||||
To copy your logs, click <strong>Copy to Clipboard</strong>.</p>
|
||||
<p>To <strong>upgrade</strong> your containers, click <strong>Upgrade</strong>.
|
||||
<strong>Upgrade</strong> runs <code>docker compose pull</code> and then <code>docker compose up -d --force-recreate</code>.
|
||||
For more information, see <a href="#upgrade-openrag-containers-with-the-tui" class="">Upgrade OpenRAG containers with the TUI</a>.</p>
|
||||
<p>To <strong>reset</strong> your containers, click <strong>Reset</strong>.
|
||||
Reset gives you a completely fresh start.
|
||||
Reset deletes all of your data, including OpenSearch data, uploaded documents, and authentication.
|
||||
<strong>Reset</strong> runs two commands.
|
||||
It first stops and removes all containers, volumes, and local images.</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">docker compose down --volumes --remove-orphans --rmi local</span><br></span></code></pre></div></div>
|
||||
<p>When the first command is complete, OpenRAG removes any additional Docker objects with <code>prune</code>.</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">docker system prune -f</span><br></span></code></pre></div></div>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="native-services-status">Native services status<a href="#native-services-status" class="hash-link" aria-label="Direct link to Native services status" title="Direct link to Native services status" translate="no"></a></h3>
|
||||
<p>A <em>native service</em> in OpenRAG refers to a service run locally 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 Status menu, click <strong>Stop</strong> or <strong>Restart</strong>.</p>
|
||||
<p>To view the status, port, or PID of a native service, in the TUI main menu, click <a href="#status" class="">Status</a>.</p>
|
||||
<ul>
|
||||
<li class="">
|
||||
<p><strong>Logs</strong>: To view streaming logs, select the container you want to view, and press <kbd>l</kbd>.
|
||||
To copy the logs, click <strong>Copy to Clipboard</strong>.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p><strong>Upgrade</strong>: Check for updates. For more information, see <a href="#upgrade" class="">upgrade OpenRAG</a>.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p><strong>Reset</strong>: This is a destructive action that <a href="#reset-containers" class="">resets your containers</a>.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p><strong>Native services</strong>: From the <strong>Status</strong> menu, you can view the status, port, and process ID (PID) of the OpenRAG native services.
|
||||
You can also click <strong>Stop</strong> or <strong>Restart</strong> to stop and start OpenRAG native services.</p>
|
||||
<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>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="reset-containers">Reset containers<a href="#reset-containers" class="hash-link" aria-label="Direct link to Reset containers" title="Direct link to Reset containers" 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 destroys and recreates all of your OpenRAG containers.</p></div></div>
|
||||
<p>To destroy and recreate your OpenRAG containers, go to the TUI <a href="#status" class=""><strong>Status</strong> menu</a>, and then click <strong>Reset</strong>.</p>
|
||||
<p>The <strong>Reset</strong> function runs two commands. First, it stops and removes all containers, volumes, and local images:</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 down --volumes --remove-orphans --rmi local</span><br></span></code></pre></div></div>
|
||||
<p>Then, it removes any additional Docker objects with <code>docker system prune -f</code>.</p>
|
||||
<p>If you reset your containers as part of reinstalling OpenRAG, continue the <a href="#reinstall" class="">reinstallation process</a> after resetting the containers.</p>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="start-all-services">Start all services<a href="#start-all-services" class="hash-link" aria-label="Direct link to Start all services" title="Direct link to Start all services" translate="no"></a></h3>
|
||||
<p>On the TUI main page, click <strong>Start All Services</strong> to start the OpenRAG containers and launch OpenRAG itself.</p>
|
||||
<p>When you start all services, the following processes happen:</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.</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>
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="upgrade">Upgrade OpenRAG<a href="#upgrade" class="hash-link" aria-label="Direct link to Upgrade OpenRAG" title="Direct link to Upgrade OpenRAG" translate="no"></a></h2>
|
||||
<p>To upgrade OpenRAG, upgrade the OpenRAG Python package, and then upgrade the OpenRAG containers using the OpenRAG TUI.</p>
|
||||
<p>Upgrading the OpenRAG Python package updates the TUI and Python code, but container versions are controlled separately by environment variables in your <code>.env</code> file.</p>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="upgrade-openrag-python-package">Upgrade OpenRAG python package<a href="#upgrade-openrag-python-package" class="hash-link" aria-label="Direct link to Upgrade OpenRAG python package" title="Direct link to Upgrade OpenRAG python package" translate="no"></a></h3>
|
||||
<p>Use the following steps to upgrade the OpenRAG Python package to the latest version from <a href="https://pypi.org/project/openrag/" target="_blank" rel="noopener noreferrer" class="">PyPI</a>.
|
||||
After upgrading the Python package, you should also <a href="#upgrade-openrag-containers-with-the-tui" class="">upgrade your OpenRAG containers</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">Automatic installer / uvx</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Python project with uv add</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Existing virtual environment with uv pip install</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>If you installed OpenRAG using the <a href="#install" class="">automatic installer</a> or <a href="#install" class="">uvx</a>, follow these steps to upgrade:</p><ol>
|
||||
<p>To upgrade OpenRAG, upgrade the OpenRAG Python package, and then upgrade the OpenRAG containers.</p>
|
||||
<p>This is a two part process because upgrading the OpenRAG Python package updates the TUI and Python code, but the container versions are controlled by environment variables in your <code>.env</code> file.</p>
|
||||
<ol>
|
||||
<li class="">
|
||||
<p>Stop your OpenRAG containers: In the OpenRAG TUI, go to the <strong>Status</strong> menu, and then click <strong>Stop Services</strong>.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Upgrade the OpenRAG Python package to the latest version from <a href="https://pypi.org/project/openrag/" target="_blank" rel="noopener noreferrer" class="">PyPI</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">Automatic installer or uvx</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Python project (uv add)</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Virtual environment (uv pip install)</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>Use these steps to upgrade the Python package if you installed OpenRAG using the automatic installer or <code>uvx</code>:</p><ol>
|
||||
<li class="">
|
||||
<p>Navigate to your OpenRAG workspace directory:</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">cd openrag-workspace</span><br></span></code></pre></div></div>
|
||||
|
|
@ -367,10 +386,7 @@ After upgrading the Python package, you should also <a href="#upgrade-openrag-co
|
|||
<p>To upgrade to a specific version:</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">uvx --from openrag==0.1.33 openrag</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>After upgrading the Python package, <a href="#upgrade-openrag-containers-with-the-tui" class="">upgrade your containers</a>.</p>
|
||||
</li>
|
||||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
|
||||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Use these steps to upgrade the Python package if you installed OpenRAG in a Python project with <code>uv add</code>:</p><ol>
|
||||
<li class="">
|
||||
<p>Navigate to your project directory:</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">cd YOUR_PROJECT_NAME</span><br></span></code></pre></div></div>
|
||||
|
|
@ -385,10 +401,7 @@ After upgrading the Python package, you should also <a href="#upgrade-openrag-co
|
|||
<p>Start the OpenRAG TUI:</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 openrag</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>After upgrading the Python package, <a href="#upgrade-openrag-containers-with-the-tui" class="">upgrade your containers</a>.</p>
|
||||
</li>
|
||||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
|
||||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>Use these steps to upgrade the Python package if you installed OpenRAG in a venv with <code>uv pip install</code>:</p><ol>
|
||||
<li class="">
|
||||
<p>Activate your virtual environment.</p>
|
||||
</li>
|
||||
|
|
@ -402,38 +415,38 @@ After upgrading the Python package, you should also <a href="#upgrade-openrag-co
|
|||
<p>Start the OpenRAG TUI:</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 openrag</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>After upgrading the Python package, <a href="#upgrade-openrag-containers-with-the-tui" class="">upgrade your containers</a>.</p>
|
||||
</li>
|
||||
</ol></div></div></div>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="upgrade-openrag-containers-with-the-tui">Upgrade OpenRAG containers with the TUI<a href="#upgrade-openrag-containers-with-the-tui" class="hash-link" aria-label="Direct link to Upgrade OpenRAG containers with the TUI" title="Direct link to Upgrade OpenRAG containers with the TUI" translate="no"></a></h3>
|
||||
<p>After upgrading the OpenRAG Python package, upgrade your containers to ensure they match the <code>latest</code> version.
|
||||
<strong>Upgrade</strong> runs <code>docker compose pull</code>, which pulls container images based on versions specified in your <code>.env</code> file.
|
||||
<code>OPENRAG_VERSION</code> is set to <code>latest</code> by default, so it pulls the <code>latest</code> available container images.</p>
|
||||
<ol>
|
||||
<li class="">In the OpenRAG TUI, click <strong>Status</strong>, and then click <strong>Upgrade</strong>.</li>
|
||||
<li class="">When the upgrade completes, close the <strong>Status</strong> window and continue using OpenRAG.</li>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Start the upgraded OpenRAG containers: In the OpenRAG TUI, click <strong>Start All Services</strong>, and then wait while the containers start.</p>
|
||||
<p>After upgrading the Python package, OpenRAG runs <code>docker compose pull</code> to get the appropriate container images matching the version specified in your OpenRAG <code>.env</code> file. Then, it recreates the containers with the new images using <code>docker compose up -d --force-recreate</code>.</p>
|
||||
<p>In the <code>.env</code> file, the <code>OPENRAG_VERSION</code> <a class="" href="/reference/configuration#system-settings">environment variable</a> is set to <code>latest</code> by default, which it pulls the <code>latest</code> available container images.
|
||||
To pin a specific container image version, you can set <code>OPENRAG_VERSION</code> to the desired container image version, such as <code>OPENRAG_VERSION=0.1.33</code>.</p>
|
||||
<p>However, when you upgrade the Python package, OpenRAG automatically attempts to keep the <code>OPENRAG_VERSION</code> synchronized with the Python package version.
|
||||
You might need to edit the <code>.env</code> file after upgrading the Python package to enforce a different container version.
|
||||
The TUI warns you if it detects a version mismatch.</p>
|
||||
<p>If you get an error that <code>langflow container already exists</code> error during upgrade, see <a class="" href="/support/troubleshoot#langflow-container-already-exists-during-upgrade">Langflow container already exists during upgrade</a>.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>When the upgrade process is complete, you can close the <strong>Status</strong> window and continue using OpenRAG.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<p>If you encounter a <code>langflow container already exists</code> error during upgrade, see <a class="" href="/support/troubleshoot#langflow-container-already-exists-during-upgrade">Langflow container already exists during upgrade</a> in the troubleshooting guide.</p>
|
||||
<p>To pin container versions to a specific release other than <code>latest</code>, set the <code>OPENRAG_VERSION</code> in your <code>.env</code> file:</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">OPENRAG_VERSION=0.1.33</span><br></span></code></pre></div></div>
|
||||
<p>For more information, see <a class="" href="/reference/configuration#system-settings">System settings environment variables</a>.</p>
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="diagnostics">Diagnostics<a href="#diagnostics" class="hash-link" aria-label="Direct link to Diagnostics" title="Direct link to Diagnostics" translate="no"></a></h2>
|
||||
<p>The <strong>Diagnostics</strong> menu provides health monitoring for your container runtimes and monitoring of your OpenSearch security.</p>
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="reinstall">Reinstall OpenRAG<a href="#reinstall" class="hash-link" aria-label="Direct link to Reinstall OpenRAG" title="Direct link to Reinstall OpenRAG" translate="no"></a></h2>
|
||||
<p>To reinstall OpenRAG with a completely fresh setup:</p>
|
||||
<ol>
|
||||
<li class="">
|
||||
<p>Reset your containers using the <strong>Reset</strong> button in the <a href="#status" class="">TUI status</a> menu.
|
||||
This removes all containers, volumes, and data.</p>
|
||||
<p>In the TUI <strong>Status</strong> menu, <a href="#reset-containers" class="">reset your containers</a> to destroy the existing OpenRAG containers and their data.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>Optional: Delete your project's <code>.env</code> file.
|
||||
The Reset operation doesn't remove your project's <code>.env</code> file, so your passwords, API keys, and OAuth settings can be preserved.
|
||||
If you delete the <code>.env</code> file, run the <a href="#setup" class="">Set up OpenRAG with the TUI</a> process again to create a new configuration.</p>
|
||||
<p>Optional: Delete your project's <code>.env</code> file.</p>
|
||||
<p>The Reset operation doesn't remove your project's <code>.env</code> file, so your passwords, API keys, and OAuth settings can be preserved.
|
||||
If you delete the <code>.env</code> file, you must run the <a href="#setup" class="">Set up OpenRAG with the TUI</a> process again to create a new configuration file.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>In the TUI Setup menu, follow these steps from <a href="#setup" class="">Basic Setup</a>:</p>
|
||||
<p>Optional: Delete your OpenSearch knowledge base by deleting the contents of the <code>./opensearch-data</code> folder in your OpenRAG installation directory.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
<p>In the TUI <strong>Setup</strong> menu, repeat the <a href="#setup" class="">Basic Setup</a> process:</p>
|
||||
<ol>
|
||||
<li class="">Click <strong>Start All Services</strong> to pull container images and start them.</li>
|
||||
<li class="">Under <strong>Native Services</strong>, click <strong>Start</strong> to start the Docling service.</li>
|
||||
|
|
@ -441,7 +454,8 @@ If you delete the <code>.env</code> file, run the <a href="#setup" class="">Set
|
|||
<li class="">Continue with <a href="#application-onboarding" class="">application onboarding</a>.</li>
|
||||
</ol>
|
||||
</li>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/get-started/install.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/quickstart"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Quickstart</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docker"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Install OpenRAG containers</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#install" class="table-of-contents__link toc-highlight">Install OpenRAG</a></li><li><a href="#setup" class="table-of-contents__link toc-highlight">Set up OpenRAG with the TUI</a></li><li><a href="#application-onboarding" class="table-of-contents__link toc-highlight">Application onboarding</a></li><li><a href="#exit-the-openrag-tui" class="table-of-contents__link toc-highlight">Exit the OpenRAG TUI</a></li><li><a href="#tui-container-management" class="table-of-contents__link toc-highlight">Manage OpenRAG containers with the TUI</a><ul><li><a href="#start-all-services" class="table-of-contents__link toc-highlight">Start all services</a></li><li><a href="#status" class="table-of-contents__link toc-highlight">Status</a></li><li><a href="#native-services-status" class="table-of-contents__link toc-highlight">Native services status</a></li></ul></li><li><a href="#upgrade" class="table-of-contents__link toc-highlight">Upgrade OpenRAG</a><ul><li><a href="#upgrade-openrag-python-package" class="table-of-contents__link toc-highlight">Upgrade OpenRAG python package</a></li><li><a href="#upgrade-openrag-containers-with-the-tui" class="table-of-contents__link toc-highlight">Upgrade OpenRAG containers with the TUI</a></li></ul></li><li><a href="#diagnostics" class="table-of-contents__link toc-highlight">Diagnostics</a></li><li><a href="#reinstall" class="table-of-contents__link toc-highlight">Reinstall OpenRAG</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">
|
||||
</ol>
|
||||
<p>If reinstalling OpenRAG and deleting the <code>.env</code> file doesn't reset setup or onboarding, see <a class="" href="/support/troubleshoot#reinstalling-openrag-doesnt-reset-onboarding">Reinstalling OpenRAG doesn't reset onboarding</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/get-started/install.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/quickstart"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Quickstart</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docker"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Install OpenRAG containers</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#install" class="table-of-contents__link toc-highlight">Install OpenRAG</a></li><li><a href="#setup" class="table-of-contents__link toc-highlight">Set up OpenRAG with the TUI</a></li><li><a href="#application-onboarding" class="table-of-contents__link toc-highlight">Application onboarding</a></li><li><a href="#exit-the-openrag-tui" class="table-of-contents__link toc-highlight">Exit the OpenRAG TUI</a></li><li><a href="#tui-container-management" class="table-of-contents__link toc-highlight">Manage OpenRAG containers with the TUI</a><ul><li><a href="#diagnostics" class="table-of-contents__link toc-highlight">Diagnostics</a></li><li><a href="#status" class="table-of-contents__link toc-highlight">Status</a></li><li><a href="#reset-containers" class="table-of-contents__link toc-highlight">Reset containers</a></li><li><a href="#start-all-services" class="table-of-contents__link toc-highlight">Start all services</a></li></ul></li><li><a href="#upgrade" class="table-of-contents__link toc-highlight">Upgrade OpenRAG</a></li><li><a href="#reinstall" class="table-of-contents__link toc-highlight">Reinstall OpenRAG</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
|
||||
<span>© 2025 OpenRAG</span>
|
||||
</div></li></ul></div></div></div></footer></div>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Filter knowledge | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/knowledge-filters"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Filter knowledge | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG's knowledge filters help you organize and manage your knowledge base by creating pre-defined views of your documents."><meta data-rh="true" property="og:description" content="OpenRAG's knowledge filters help you organize and manage your knowledge base by creating pre-defined views of your documents."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/knowledge-filters"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge-filters" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge-filters" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Filter knowledge","item":"https://docs.openr.ag/knowledge-filters"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.ce59c02b.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.e45e845e.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.c55814c2.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Configure knowledge | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/knowledge"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Configure knowledge | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG includes a built-in OpenSearch instance that serves as the underlying datastore for your knowledge (documents)."><meta data-rh="true" property="og:description" content="OpenRAG includes a built-in OpenSearch instance that serves as the underlying datastore for your knowledge (documents)."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/knowledge"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Configure knowledge","item":"https://docs.openr.ag/knowledge"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.ce59c02b.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.e45e845e.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.c55814c2.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Quickstart | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/quickstart"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Quickstart | OpenRAG"><meta data-rh="true" name="description" content="Use this quickstart to install OpenRAG, and then try some of OpenRAG's core features."><meta data-rh="true" property="og:description" content="Use this quickstart to install OpenRAG, and then try some of OpenRAG's core features."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/quickstart"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/quickstart" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/quickstart" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Quickstart","item":"https://docs.openr.ag/quickstart"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.ce59c02b.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.e45e845e.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.c55814c2.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -209,7 +209,7 @@ You could also pass the output from one flow as input to another flow.</p>
|
|||
<ul>
|
||||
<li class="">
|
||||
<p><strong>Reinstall OpenRAG with your preferred settings</strong>: This quickstart used a minimal setup to demonstrate OpenRAG's core functionality.
|
||||
It is recommended that you reinstall OpenRAG with your preferred configuration because some settings are immutable after initial setup.
|
||||
It is recommended that you <a class="" href="/install#reinstall">reinstall OpenRAG</a> with your preferred configuration because some settings are immutable after initial setup.
|
||||
For all installation options, see <a class="" href="/install">Install OpenRAG with TUI</a> and <a class="" href="/docker">Install OpenRAG with containers</a>.</p>
|
||||
</li>
|
||||
<li class="">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Environment variables | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/reference/configuration"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Environment variables | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG recognizes environment variables from the following sources:"><meta data-rh="true" property="og:description" content="OpenRAG recognizes 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.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.ce59c02b.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.e45e845e.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.c55814c2.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -80,7 +80,7 @@ Some values are immutable and can only be changed by recreating the OpenRAG cont
|
|||
<table><thead><tr><th>Variable</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>OPENSEARCH_HOST</code></td><td><code>localhost</code></td><td>OpenSearch host.</td></tr><tr><td><code>OPENSEARCH_PASSWORD</code></td><td>-</td><td>Password for OpenSearch admin user. Required.</td></tr><tr><td><code>OPENSEARCH_PORT</code></td><td><code>9200</code></td><td>OpenSearch port.</td></tr><tr><td><code>OPENSEARCH_USERNAME</code></td><td><code>admin</code></td><td>OpenSearch username.</td></tr></tbody></table>
|
||||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="system-settings">System settings<a href="#system-settings" class="hash-link" aria-label="Direct link to System settings" title="Direct link to System settings" translate="no"></a></h3>
|
||||
<p>Configure general system components, session management, and logging.</p>
|
||||
<table><thead><tr><th>Variable</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>LANGFLOW_KEY_RETRIES</code></td><td><code>15</code></td><td>Number of retries for Langflow key generation.</td></tr><tr><td><code>LANGFLOW_KEY_RETRY_DELAY</code></td><td><code>2.0</code></td><td>Delay between retries in seconds.</td></tr><tr><td><code>LANGFLOW_VERSION</code></td><td><code>latest</code></td><td>Langflow Docker image version.</td></tr><tr><td><code>LOG_FORMAT</code></td><td>Disabled</td><td>Set to <code>json</code> to enabled JSON-formatted log output.</td></tr><tr><td><code>LOG_LEVEL</code></td><td><code>INFO</code></td><td>Logging level (DEBUG, INFO, WARNING, ERROR).</td></tr><tr><td><code>MAX_WORKERS</code></td><td><code>1</code></td><td>Maximum number of workers for document processing.</td></tr><tr><td><code>OPENRAG_VERSION</code></td><td><code>latest</code></td><td>OpenRAG Docker image version.</td></tr><tr><td><code>SERVICE_NAME</code></td><td><code>openrag</code></td><td>Service name for logging.</td></tr><tr><td><code>SESSION_SECRET</code></td><td>Automatically generated</td><td>Session management.</td></tr></tbody></table>
|
||||
<table><thead><tr><th>Variable</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>LANGFLOW_KEY_RETRIES</code></td><td><code>15</code></td><td>Number of retries for Langflow key generation.</td></tr><tr><td><code>LANGFLOW_KEY_RETRY_DELAY</code></td><td><code>2.0</code></td><td>Delay between retries in seconds.</td></tr><tr><td><code>LANGFLOW_VERSION</code></td><td><code>OPENRAG_VERSION</code></td><td>Langflow Docker image version. By default, OpenRAG uses the <code>OPENRAG_VERSION</code> for the Langflow Docker image version.</td></tr><tr><td><code>LOG_FORMAT</code></td><td>Disabled</td><td>Set to <code>json</code> to enabled JSON-formatted log output.</td></tr><tr><td><code>LOG_LEVEL</code></td><td><code>INFO</code></td><td>Logging level (DEBUG, INFO, WARNING, ERROR).</td></tr><tr><td><code>MAX_WORKERS</code></td><td><code>1</code></td><td>Maximum number of workers for document processing.</td></tr><tr><td><code>OPENRAG_VERSION</code></td><td><code>latest</code></td><td>The version of the OpenRAG Docker images to run. For more information, see <a class="" href="/install#upgrade">Upgrade OpenRAG</a></td></tr><tr><td><code>SERVICE_NAME</code></td><td><code>openrag</code></td><td>Service name for logging.</td></tr><tr><td><code>SESSION_SECRET</code></td><td>Automatically generated</td><td>Session management.</td></tr></tbody></table>
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="langflow-runtime-overrides">Langflow runtime overrides<a href="#langflow-runtime-overrides" class="hash-link" aria-label="Direct link to Langflow runtime overrides" title="Direct link to Langflow runtime overrides" translate="no"></a></h2>
|
||||
<p>You can modify <a class="" href="/agents">flow</a> settings at runtime without permanently changing the flow's configuration.</p>
|
||||
<p>Runtime overrides are implemented through <em>tweaks</em>, which are one-time parameter modifications that are passed to specific Langflow components during flow execution.</p>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Troubleshoot OpenRAG | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/support/troubleshoot"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Troubleshoot OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG."><meta data-rh="true" property="og:description" content="This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/support/troubleshoot"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/support/troubleshoot" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/support/troubleshoot" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Troubleshoot OpenRAG","item":"https://docs.openr.ag/support/troubleshoot"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||||
<script src="/assets/js/runtime~main.ce59c02b.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.e45e845e.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.c55814c2.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -74,8 +74,8 @@ This example increases the machine size to 8 GB of RAM, which should be sufficie
|
|||
</ol></div></div></div>
|
||||
<p>If reinstalling the Langflow container doesn't resolve the issue, you must reset to a fresh installation by removing all OpenRAG containers and data.
|
||||
Then, you can retry the upgrade.</p>
|
||||
<div class="theme-admonition theme-admonition-warning admonition_xJq3 alert alert--warning"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>warning</div><div class="admonitionContent_BuS1"><p>This is a destructive operation that completely resets your OpenRAG containers and removes all OpenRAG data, including OpenSearch data, uploaded documents, and authentication details.
|
||||
Your <code>.env</code> file is preserved, so your configuration settings remain intact, but all other data is lost.</p></div></div>
|
||||
<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 destroys your OpenRAG containers and their contents.
|
||||
However, your <code>.env</code> file (configuration settings) and <code>./opensearch-data</code> (OpenSearch knowledge base) are preserved.</p></div></div>
|
||||
<p>To reset your installation, stop your containers, and then completely remove them.
|
||||
After removing the containers, retry the upgrade in the OpenRAG TUI by clicking <strong>Status</strong> and then <strong>Upgrade</strong>.</p>
|
||||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Podman</li><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Docker</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
|
||||
|
|
@ -129,8 +129,13 @@ After removing the containers, retry the upgrade in the OpenRAG TUI by clicking
|
|||
<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 system prune --all --force --volumes</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
</ol></div></div></div>
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="reinstalling-openrag-doesnt-reset-onboarding">Reinstalling OpenRAG doesn't reset onboarding<a href="#reinstalling-openrag-doesnt-reset-onboarding" class="hash-link" aria-label="Direct link to Reinstalling OpenRAG doesn't reset onboarding" title="Direct link to Reinstalling OpenRAG doesn't reset onboarding" translate="no"></a></h2>
|
||||
<p>If you <a class="" href="/install#reinstall">reinstall OpenRAG</a>, you can restore your installation to it's original, default state by resetting the containers <em>and</em> deleting the <code>.env</code> file.</p>
|
||||
<p>When you start OpenRAG after doing this, you should be prompted to go through the initial setup and onboarding process again.</p>
|
||||
<p>Due to a known issue, the onboarding process might not reset when you reinstall OpenRAG.
|
||||
If this occurs, <a class="" href="/install#install">install OpenRAG in a new Python project directory</a> (with <code>uv init</code> and <code>uv add openrag</code>).</p>
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="document-ingestion-or-similarity-search-issues">Document ingestion or similarity search issues<a href="#document-ingestion-or-similarity-search-issues" class="hash-link" aria-label="Direct link to Document ingestion or similarity search issues" title="Direct link to Document ingestion or similarity search issues" translate="no"></a></h2>
|
||||
<p>See <a class="" href="/ingestion#troubleshoot-ingestion">Troubleshoot ingestion</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/support/troubleshoot.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/reference/configuration"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Environment variables</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#opensearch-fails-to-start" class="table-of-contents__link toc-highlight">OpenSearch fails to start</a></li><li><a href="#openrag-fails-to-start-from-the-tui-with-operation-not-supported" class="table-of-contents__link toc-highlight">OpenRAG fails to start from the TUI with operation not supported</a></li><li><a href="#openrag-installation-fails-with-unable-to-get-local-issuer-certificate" class="table-of-contents__link toc-highlight">OpenRAG installation fails with unable to get local issuer certificate</a></li><li><a href="#langflow-connection-issues" class="table-of-contents__link toc-highlight">Langflow connection issues</a></li><li><a href="#container-out-of-memory-errors" class="table-of-contents__link toc-highlight">Container out of memory errors</a></li><li><a href="#memory-issue-with-podman-on-macos" class="table-of-contents__link toc-highlight">Memory issue with Podman on macOS</a></li><li><a href="#port-conflicts" class="table-of-contents__link toc-highlight">Port conflicts</a></li><li><a href="#ocr-ingestion-fails-easyocr-not-installed" class="table-of-contents__link toc-highlight">OCR ingestion fails (easyocr not installed)</a></li><li><a href="#langflow-container-already-exists-during-upgrade" class="table-of-contents__link toc-highlight">Upgrade fails due to Langflow container already exists</a></li><li><a href="#document-ingestion-or-similarity-search-issues" class="table-of-contents__link toc-highlight">Document ingestion or similarity search issues</a></li></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">
|
||||
<p>See <a class="" href="/ingestion#troubleshoot-ingestion">Troubleshoot ingestion</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/support/troubleshoot.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/reference/configuration"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Environment variables</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#opensearch-fails-to-start" class="table-of-contents__link toc-highlight">OpenSearch fails to start</a></li><li><a href="#openrag-fails-to-start-from-the-tui-with-operation-not-supported" class="table-of-contents__link toc-highlight">OpenRAG fails to start from the TUI with operation not supported</a></li><li><a href="#openrag-installation-fails-with-unable-to-get-local-issuer-certificate" class="table-of-contents__link toc-highlight">OpenRAG installation fails with unable to get local issuer certificate</a></li><li><a href="#langflow-connection-issues" class="table-of-contents__link toc-highlight">Langflow connection issues</a></li><li><a href="#container-out-of-memory-errors" class="table-of-contents__link toc-highlight">Container out of memory errors</a></li><li><a href="#memory-issue-with-podman-on-macos" class="table-of-contents__link toc-highlight">Memory issue with Podman on macOS</a></li><li><a href="#port-conflicts" class="table-of-contents__link toc-highlight">Port conflicts</a></li><li><a href="#ocr-ingestion-fails-easyocr-not-installed" class="table-of-contents__link toc-highlight">OCR ingestion fails (easyocr not installed)</a></li><li><a href="#langflow-container-already-exists-during-upgrade" class="table-of-contents__link toc-highlight">Upgrade fails due to Langflow container already exists</a></li><li><a href="#reinstalling-openrag-doesnt-reset-onboarding" class="table-of-contents__link toc-highlight">Reinstalling OpenRAG doesn't reset onboarding</a></li><li><a href="#document-ingestion-or-similarity-search-issues" class="table-of-contents__link toc-highlight">Document ingestion or similarity search issues</a></li></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>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue