1 line
No EOL
9 KiB
JavaScript
1 line
No EOL
9 KiB
JavaScript
"use strict";(self.webpackChunkopenrag_docs=self.webpackChunkopenrag_docs||[]).push([[2668],{5014:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>l,metadata:()=>r,toc:()=>h});const r=JSON.parse('{"id":"support/troubleshoot","title":"Troubleshooting","description":"This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG.","source":"@site/docs/support/troubleshoot.mdx","sourceDirName":"support","slug":"/support/troubleshoot","permalink":"/support/troubleshoot","draft":false,"unlisted":false,"editUrl":"https://github.com/openrag/openrag/tree/main/docs/docs/support/troubleshoot.mdx","tags":[],"version":"current","frontMatter":{"title":"Troubleshooting","slug":"/support/troubleshoot"},"sidebar":"tutorialSidebar","previous":{"title":"Environment variables","permalink":"/reference/configuration"}}');var s=o(4848),a=o(8453),t=o(1470),i=o(9365);const l={title:"Troubleshooting",slug:"/support/troubleshoot"},c=void 0,d={},h=[{value:"OpenSearch fails to start",id:"opensearch-fails-to-start",level:2},{value:"OpenRAG fails to start from the TUI with "Operation not supported" error",id:"openrag-fails-to-start-from-the-tui-with-operation-not-supported-error",level:2},{value:"Langflow connection issues",id:"langflow-connection-issues",level:2},{value:"Memory errors",id:"memory-errors",level:2},{value:"Container out of memory errors",id:"container-out-of-memory-errors",level:3},{value:"Podman on macOS memory issues",id:"podman-on-macos-memory-issues",level:3},{value:"Port conflicts",id:"port-conflicts",level:2},{value:"OCR ingestion fails (easyocr not installed)",id:"ocr-ingestion-fails-easyocr-not-installed",level:2},{value:"Langflow container already exists",id:"langflow-container-already-exists",level:2}];function p(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG."}),"\n",(0,s.jsx)(n.h2,{id:"opensearch-fails-to-start",children:"OpenSearch fails to start"}),"\n",(0,s.jsxs)(n.p,{children:["Check that ",(0,s.jsx)(n.code,{children:"OPENSEARCH_PASSWORD"})," set in ",(0,s.jsx)(n.a,{href:"/reference/configuration",children:"Environment variables"})," meets requirements.\nThe password must contain at least 8 characters, and must contain at least one uppercase letter, one lowercase letter, one digit, and one special character that is strong."]}),"\n",(0,s.jsx)(n.h2,{id:"openrag-fails-to-start-from-the-tui-with-operation-not-supported-error",children:'OpenRAG fails to start from the TUI with "Operation not supported" error'}),"\n",(0,s.jsxs)(n.p,{children:["This error occurs when starting OpenRAG with the TUI in ",(0,s.jsx)(n.a,{href:"https://learn.microsoft.com/en-us/windows/wsl/install",children:"WSL (Windows Subsystem for Linux)"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["The error occurs because OpenRAG is running within a WSL environment, so ",(0,s.jsx)(n.code,{children:"webbrowser.open()"})," can't launch a browser automatically."]}),"\n",(0,s.jsxs)(n.p,{children:["To access the OpenRAG application, open a web browser and enter ",(0,s.jsx)(n.code,{children:"http://localhost:3000"})," in the address bar."]}),"\n",(0,s.jsx)(n.h2,{id:"langflow-connection-issues",children:"Langflow connection issues"}),"\n",(0,s.jsxs)(n.p,{children:["Verify the ",(0,s.jsx)(n.code,{children:"LANGFLOW_SUPERUSER"})," credentials set in ",(0,s.jsx)(n.a,{href:"/reference/configuration",children:"Environment variables"})," are correct."]}),"\n",(0,s.jsx)(n.h2,{id:"memory-errors",children:"Memory errors"}),"\n",(0,s.jsx)(n.h3,{id:"container-out-of-memory-errors",children:"Container out of memory errors"}),"\n",(0,s.jsxs)(n.p,{children:["Increase Docker memory allocation or use ",(0,s.jsx)(n.a,{href:"https://github.com/langflow-ai/openrag/blob/main/docker-compose-cpu.yml",children:"docker-compose-cpu.yml"})," to deploy OpenRAG."]}),"\n",(0,s.jsx)(n.h3,{id:"podman-on-macos-memory-issues",children:"Podman on macOS memory issues"}),"\n",(0,s.jsx)(n.p,{children:"If you're using Podman on macOS, you may need to increase VM memory on your Podman machine.\nThis example increases the machine size to 8 GB of RAM, which should be sufficient to run OpenRAG."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"podman machine stop\npodman machine rm\npodman machine init --memory 8192 # 8 GB example\npodman machine start\n"})}),"\n",(0,s.jsx)(n.h2,{id:"port-conflicts",children:"Port conflicts"}),"\n",(0,s.jsx)(n.p,{children:"Ensure ports 3000, 7860, 8000, 9200, 5601 are available."}),"\n",(0,s.jsx)(n.h2,{id:"ocr-ingestion-fails-easyocr-not-installed",children:"OCR ingestion fails (easyocr not installed)"}),"\n",(0,s.jsxs)(n.p,{children:["If Docling ingestion fails with an OCR-related error and mentions ",(0,s.jsx)(n.code,{children:"easyocr"})," is missing, this is likely due to a stale ",(0,s.jsx)(n.code,{children:"uv"})," cache."]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"easyocr"})," is already included as a dependency in OpenRAG's ",(0,s.jsx)(n.code,{children:"pyproject.toml"}),". Project-managed installations using ",(0,s.jsx)(n.code,{children:"uv sync"})," and ",(0,s.jsx)(n.code,{children:"uv run"})," always sync dependencies directly from your ",(0,s.jsx)(n.code,{children:"pyproject.toml"}),", so they should have ",(0,s.jsx)(n.code,{children:"easyocr"})," installed."]}),"\n",(0,s.jsxs)(n.p,{children:["If you're running OpenRAG with ",(0,s.jsx)(n.code,{children:"uvx openrag"}),", ",(0,s.jsx)(n.code,{children:"uvx"})," creates a cached, ephemeral environment that doesn't modify your project. This cache may become stale."]}),"\n",(0,s.jsxs)(n.p,{children:["On macOS, this cache directory is typically a user cache directory such as ",(0,s.jsx)(n.code,{children:"/Users/USER_NAME/.cache/uv"}),"."]}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["To clear the uv cache, run:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"uv cache clean\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["Start OpenRAG:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"uvx openrag\n"})}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["If you do not need OCR, you can disable OCR-based processing in your ingestion settings to avoid requiring ",(0,s.jsx)(n.code,{children:"easyocr"}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"langflow-container-already-exists",children:"Langflow container already exists"}),"\n",(0,s.jsx)(n.p,{children:"If you are running other versions of Langflow containers on your machine, you may encounter an issue where Docker or Podman thinks Langflow is already up."}),"\n",(0,s.jsx)(n.p,{children:"Remove just the problem container, or clean up all containers and start fresh."}),"\n",(0,s.jsx)(n.p,{children:"To reset your local containers and pull new images, do the following:"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Stop your containers and completely remove them."}),"\n",(0,s.jsxs)(t.A,{groupId:"Container software",children:[(0,s.jsx)(i.A,{value:"Podman",label:"Podman",children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"# Stop all running containers\npodman stop --all\n\n# Remove all containers (including stopped ones)\npodman rm --all --force\n\n# Remove all images\npodman rmi --all --force\n\n# Remove all volumes\npodman volume prune --force\n\n# Remove all networks (except default)\npodman network prune --force\n\n# Clean up any leftover data\npodman system prune --all --force --volumes\n"})})}),(0,s.jsx)(i.A,{value:"Docker",label:"Docker",default:!0,children:(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"# Stop all running containers\ndocker stop $(docker ps -q)\n\n# Remove all containers (including stopped ones)\ndocker rm --force $(docker ps -aq)\n\n# Remove all images\ndocker rmi --force $(docker images -q)\n\n# Remove all volumes\ndocker volume prune --force\n\n# Remove all networks (except default)\ndocker network prune --force\n\n# Clean up any leftover data\ndocker system prune --all --force --volumes\n"})})})]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Restart OpenRAG and upgrade to get the latest images for your containers."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"uv sync\nuv run openrag\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["In the OpenRAG TUI, click ",(0,s.jsx)(n.strong,{children:"Status"}),", and then click ",(0,s.jsx)(n.strong,{children:"Upgrade"}),".\nWhen the ",(0,s.jsx)(n.strong,{children:"Close"})," button is active, the upgrade is complete.\nClose the window and open the OpenRAG appplication."]}),"\n"]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}}}]); |