1 line
No EOL
5.3 KiB
JavaScript
1 line
No EOL
5.3 KiB
JavaScript
"use strict";(globalThis.webpackChunkopenrag_docs=globalThis.webpackChunkopenrag_docs||[]).push([[6190],{5671:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"get-started/install-options","title":"Select an installation method","description":"The OpenRAG architecture is lightweight and container-based with a central OpenRAG backend that orchestrates the various services and external connectors.","source":"@site/docs/get-started/install-options.mdx","sourceDirName":"get-started","slug":"/install-options","permalink":"/install-options","draft":false,"unlisted":false,"editUrl":"https://github.com/openrag/openrag/tree/main/docs/docs/get-started/install-options.mdx","tags":[],"version":"current","frontMatter":{"title":"Select an installation method","slug":"/install-options"},"sidebar":"tutorialSidebar","previous":{"title":"Quickstart","permalink":"/quickstart"},"next":{"title":"Run the installer script","permalink":"/install"}}');var s=t(4848),r=t(8453);const o={title:"Select an installation method",slug:"/install-options"},a=void 0,l={},c=[];function d(e){const n={a:"a",admonition:"admonition",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.a,{href:"/#openrag-architecture",children:"OpenRAG architecture"})," is lightweight and container-based with a central OpenRAG backend that orchestrates the various services and external connectors.\nDepending on your use case, OpenRAG can assist with service management, or you can manage the services yourself."]}),"\n",(0,s.jsx)(n.p,{children:"Select the installation method that best fits your needs:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsxs)(n.strong,{children:["Use the ",(0,s.jsx)(n.a,{href:"/tui",children:"Terminal User Interface (TUI)"})," to manage services"]}),": For guided configuration and simplified service management, install OpenRAG with TUI-managed services. Use one of the following options:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/install",children:(0,s.jsx)(n.strong,{children:"Automatic installer script"})}),": Run one script to install the required dependencies and OpenRAG."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/install-uv",children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"uv"})})}),": Install OpenRAG as a dependency of a new or existing Python project."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/install-uvx",children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"uvx"})})}),": Install OpenRAG without creating a project or modifying your project's dependencies."]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/install-windows",children:(0,s.jsx)(n.strong,{children:"Install OpenRAG on Microsoft Windows"})}),": On Windows machines, you must install OpenRAG within the Windows Subsystem for Linux (WSL)."]}),"\n",(0,s.jsx)(n.admonition,{type:"warning",children:(0,s.jsx)(n.p,{children:"OpenRAG doesn't support nested virtualization; don't run OpenRAG on a WSL distribution that is inside a Windows VM."})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/docker",children:(0,s.jsx)(n.strong,{children:"Manage your own services"})}),": You can use Docker or Podman to deploy self-managed OpenRAG services."]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The first time you start OpenRAG, you must complete the application onboarding process.\nThis is required for all installation methods because it prepares the minimum required configuration for OpenRAG to run.\nFor TUI-managed services, you must also complete initial setup before you start the OpenRAG services.\nFor more information, see the instructions for your preferred installation method."}),"\n",(0,s.jsxs)(n.p,{children:["Your OpenRAG configuration is stored in a ",(0,s.jsx)(n.code,{children:".env"})," file in the OpenRAG installation directory.\nWhen using TUI-managed services, this file is created automatically, or you can provide a pre-populated ",(0,s.jsx)(n.code,{children:".env"})," file before starting the TUI.\nThe TUI prompts you for the required values during setup and onboarding, and any values detected in a preexisting ",(0,s.jsx)(n.code,{children:".env"})," file are populated automatically.\nWhen using self-managed services, you must provide a pre-populated ",(0,s.jsx)(n.code,{children:".env"})," file, as you would for any Docker or Podman deployment.\nFor more information, see the instructions for your preferred installation method and the ",(0,s.jsx)(n.a,{href:"/reference/configuration",children:"OpenRAG environment variables reference"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var i=t(6540);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); |