1 line
No EOL
5.7 KiB
JavaScript
1 line
No EOL
5.7 KiB
JavaScript
"use strict";(globalThis.webpackChunkopenrag_docs=globalThis.webpackChunkopenrag_docs||[]).push([[8615],{8296:(n,s,e)=>{e.r(s),e.d(s,{assets:()=>a,contentTitle:()=>l,default:()=>c,frontMatter:()=>r,metadata:()=>t,toc:()=>d});const t=JSON.parse('{"id":"get-started/install-windows","title":"Install OpenRAG on Microsoft Windows","description":"If you\'re using Windows, you must install OpenRAG within the Windows Subsystem for Linux (WSL).","source":"@site/docs/get-started/install-windows.mdx","sourceDirName":"get-started","slug":"/install-windows","permalink":"/install-windows","draft":false,"unlisted":false,"editUrl":"https://github.com/openrag/openrag/tree/main/docs/docs/get-started/install-windows.mdx","tags":[],"version":"current","frontMatter":{"title":"Install OpenRAG on Microsoft Windows","slug":"/install-windows"},"sidebar":"tutorialSidebar","previous":{"title":"Invoke OpenRAG with uvx","permalink":"/install-uvx"},"next":{"title":"Deploy self-managed services","permalink":"/docker"}}');var i=e(4848),o=e(8453);const r={title:"Install OpenRAG on Microsoft Windows",slug:"/install-windows"},l=void 0,a={},d=[{value:"Install OpenRAG in the WSL",id:"install-openrag-in-the-wsl",level:2},{value:"Troubleshoot OpenRAG in WSL",id:"troubleshoot-openrag-in-wsl",level:2}];function u(n){const s={a:"a",admonition:"admonition",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.p,{children:"If you're using Windows, you must install OpenRAG within the Windows Subsystem for Linux (WSL)."}),"\n",(0,i.jsxs)(s.admonition,{type:"warning",children:[(0,i.jsx)(s.p,{children:"Nested virtualization isn't supported."}),(0,i.jsx)(s.p,{children:"OpenRAG isn't compatible with nested virtualization, which can cause networking issues.\nDon't install OpenRAG on a WSL distribution that is installed inside a Windows VM.\nInstead, install OpenRAG on your base OS or a non-nested Linux VM."})]}),"\n",(0,i.jsx)(s.h2,{id:"install-openrag-in-the-wsl",children:"Install OpenRAG in the WSL"}),"\n",(0,i.jsxs)(s.ol,{children:["\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"https://learn.microsoft.com/en-us/windows/wsl/install",children:"Install WSL"})," with an Ubuntu distribution using WSL 2:"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-powershell",children:"wsl --install -d Ubuntu\n"})}),"\n",(0,i.jsxs)(s.p,{children:["For new installations, the ",(0,i.jsx)(s.code,{children:"wsl --install"})," command uses WSL 2 and Ubuntu by default."]}),"\n",(0,i.jsxs)(s.p,{children:["For existing WSL installations, you can ",(0,i.jsx)(s.a,{href:"https://learn.microsoft.com/en-us/windows/wsl/install#change-the-default-linux-distribution-installed",children:"change the distribution"})," and ",(0,i.jsx)(s.a,{href:"https://learn.microsoft.com/en-us/windows/wsl/install#upgrade-version-from-wsl-1-to-wsl-2",children:"check the WSL version"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"https://learn.microsoft.com/en-us/windows/wsl/install#ways-to-run-multiple-linux-distributions-with-wsl",children:"Start your WSL Ubuntu distribution"})," if it doesn't start automatically."]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"https://learn.microsoft.com/en-us/windows/wsl/setup/environment#set-up-your-linux-username-and-password",children:"Set up a username and password for your WSL distribution"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers",children:"Install Docker Desktop for Windows with WSL 2"}),". When you reach the Docker Desktop ",(0,i.jsx)(s.strong,{children:"WSL integration"})," settings, make sure your Ubuntu distribution is enabled, and then click ",(0,i.jsx)(s.strong,{children:"Apply & Restart"})," to enable Docker support in WSL."]}),"\n",(0,i.jsx)(s.p,{children:"The Docker Desktop WSL integration makes Docker available within your WSL distribution.\nYou don't need to install Docker or Podman separately in your WSL distribution before you install OpenRAG."}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsxs)(s.p,{children:["Install and run OpenRAG from within your WSL Ubuntu distribution.\nYou can install OpenRAG in your WSL distribution using any of the ",(0,i.jsx)(s.a,{href:"/install-options",children:"OpenRAG installation methods"}),"."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"troubleshoot-openrag-in-wsl",children:"Troubleshoot OpenRAG in WSL"}),"\n",(0,i.jsxs)(s.p,{children:["If you encounter issues with port forwarding or the Windows Firewall, you might need to adjust the ",(0,i.jsx)(s.a,{href:"https://learn.microsoft.com/en-us/windows/security/operating-system-security/network-security/windows-firewall/hyper-v-firewall",children:"Hyper-V firewall settings"})," to allow communication between your WSL distribution and the Windows host. For more troubleshooting advice for networking issues, see ",(0,i.jsx)(s.a,{href:"https://learn.microsoft.com/en-us/windows/wsl/troubleshooting#common-issues",children:"Troubleshooting WSL common issues"}),"."]})]})}function c(n={}){const{wrapper:s}={...(0,o.R)(),...n.components};return s?(0,i.jsx)(s,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},8453:(n,s,e)=>{e.d(s,{R:()=>r,x:()=>l});var t=e(6540);const i={},o=t.createContext(i);function r(n){const s=t.useContext(o);return t.useMemo(function(){return"function"==typeof n?n(s):{...s,...n}},[s,n])}function l(n){let s;return s=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:r(n.components),t.createElement(o.Provider,{value:s},n.children)}}}]); |