Skip to content

Commit 47946fc

Browse files
committed
peer-review
1 parent b1f97ae commit 47946fc

1 file changed

Lines changed: 55 additions & 36 deletions

File tree

docs/docs/Support/troubleshooting.mdx

Lines changed: 55 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,10 @@ If you experience an error from the `webrtcvad` package, run `uv pip install web
8383

8484
## Langflow Desktop installation issues
8585

86+
The following issues can occur when Langflow Desktop installs or updates its bundled Langflow OSS instance.
87+
88+
To view Langflow Desktop logs, see [Desktop logs](/logging#desktop-logs).
89+
8690
### Protocol buffers (protoc) required for Intel-based Macs
8791

8892
If you're installing Langflow on an Intel-based Mac, you may encounter installation errors if Protocol Buffers Compiler (`protoc`) is not installed.
@@ -93,15 +97,9 @@ To resolve this issue, install `protoc` using `brew install protobuf`.
9397

9498
For more information, including alternative installation methods, see the [Protocol buffers installation documentation](https://protobuf.dev/installation/).
9599

96-
### C++ build tools required for Langflow Desktop on Windows
97-
98-
The following issues can occur when Langflow Desktop is setting up or installing Langflow OSS automatically during first-time setup or updates.
99-
100-
To view Langflow Desktop logs, see [Desktop logs](/logging#desktop-logs).
101-
102-
### Failed to install Langflow OSS: Unable to sanity check Langflow OSS version
100+
### Langflow Installation Error: langflow-install-error
103101

104-
Desktop installed Langflow OSS but couldn't verify the installation. You may see the error message: `Langflow Installation Error: langflow-install-error` or other `Langflow Installation Error:` messages.
102+
Langflow Desktop installed Langflow OSS but couldn't verify the installation. You may see error messages like `Langflow Installation Error: langflow-install-error`.
105103

106104
To resolve this error, do the following:
107105

@@ -113,9 +111,9 @@ To resolve this error, do the following:
113111

114112
If the issue persists, ensure you have installed Python version 3.10 or later, and it is accessible by your Langflow installation. If the Python version is correct, try reinstalling Langflow Desktop from [langflow.org/desktop](https://langflow.org/desktop).
115113

116-
### Langflow OSS health check failed
114+
### Langflow Health Check Error: Timeout after 80 attempts
117115

118-
Desktop installed Langflow OSS but the OSS backend isn't responding to health checks. You can get health check error messages like `Langflow Health Check Error: Timeout after 80 attempts - Langflow did not become ready`.
116+
Langflow Desktop installed Langflow OSS but the OSS backend isn't responding to health checks. You may see an error message like `Langflow Health Check Error: Timeout after 80 attempts - Langflow did not become ready`.
119117

120118
To resolve this error, do the following:
121119

@@ -135,20 +133,46 @@ The following error messages mean that Langflow Desktop can't locate the `uv` ex
135133

136134
To resolve this error, do the following:
137135

138-
1. Verify `uv` is installed by running `uv --version` in a terminal.
139-
2. If `uv` is not found, install `uv` using the instructions in "[Windows] All automatic installation strategies failed" below, or see the [uv installation guide](https://github.com/astral-sh/uv#installation).
140-
3. If `uv` is installed but not found, add it to your PATH environment variable:
141-
* Windows: Add `%USERPROFILE%\.cargo\bin` to your PATH. In PowerShell, run:
136+
1. In a terminal verify `uv` is installed by running `uv --version`.
137+
2. Based on the output, install `uv` or add it to your PATH:
138+
139+
<Tabs>
140+
<TabItem value="not-installed" label="uv is not installed (command not found)" default>
141+
142+
Install `uv` using one of the following methods:
143+
144+
* Windows (PowerShell):
145+
```powershell
146+
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
147+
```
148+
* macOS or Linux:
149+
```bash
150+
curl -LsSf https://astral.sh/uv/install.sh | sh
151+
```
152+
* Any platform (pip):
153+
```bash
154+
pip install uv
155+
```
156+
157+
</TabItem>
158+
<TabItem value="not-found" label="uv is installed but not found by Langflow Desktop">
159+
160+
Add `uv` to your PATH so Langflow Desktop can locate it:
161+
162+
* Windows: In PowerShell, run:
142163
```powershell
143164
[System.Environment]::SetEnvironmentVariable("Path", $env:Path + ";$env:USERPROFILE\.cargo\bin", "User")
144165
```
145-
* macOS or Linux: Add `~/.cargo/bin` to your PATH in `~/.bashrc` or `~/.zshrc`.
166+
* macOS or Linux: Add `~/.local/bin` to your PATH in `~/.bashrc` or `~/.zshrc`.
146167

147-
4. Restart Langflow Desktop.
168+
</TabItem>
169+
</Tabs>
148170

149-
### Failed to create Python virtual environment
171+
3. Restart Langflow Desktop.
172+
173+
### Python Environment Error: Creation failed
150174

151-
Desktop failed to create the Python virtual environment required for Langflow OSS. You may see the error message: `Python Environment Error: error_dns`, `Python Environment Error: Creation failed:` followed by error details, or other `Python Environment Error:` messages.
175+
Langflow Desktop failed to create the Python virtual environment required for Langflow OSS. You may see error messages like `Python Environment Error: Creation failed:` followed by error details, `Python Environment Error: error_dns`, or other `Python Environment Error:` messages.
152176

153177
To resolve this error, do the following:
154178

@@ -162,35 +186,30 @@ To resolve this error, do the following:
162186

163187
If the issue persists, ensure Python version >=3.10 is installed and accessible, or reinstall Langflow Desktop from [langflow.org/desktop](https://langflow.org/desktop).
164188

165-
### Failed to sanity check Python execution
166-
167-
Desktop created the Python virtual environment but couldn't verify that Python is working correctly. You may see the error message: `Python Environment Error: Python check failed:` followed by error details, or other `Python Environment Error:` messages.
189+
### Python Environment Error: Python check failed
168190

169-
To resolve this error, see [Failed to create Python virtual environment](#failed-to-create-python-virtual-environment).
191+
Langflow Desktop created the Python virtual environment but couldn't verify that Python is working correctly. You may see error messages like `Python Environment Error: Python check failed:` followed by error details, or other `Python Environment Error:` messages.
170192

171-
### Failed to install Langflow OSS: Xcode Command Line Tools are not installed
193+
To resolve this error, see [Python Environment Error: Creation failed](#python-environment-error-creation-failed).
172194

173-
Langflow Desktop requires [Xcode Command Line Tools](https://mac.install.guide/commandlinetools/) to install Langflow OSS on macOS. You may see the error message: `Langflow Installation Error: error_xcode` or a detailed message with the title `Xcode Command Line Tools required!`.
195+
### Langflow Installation Error: error_xcode
174196

175-
To install XCode Command Line Tools manually, do the following:
197+
Langflow Desktop requires [Xcode Command Line Tools](https://developer.apple.com/xcode/resources/) to install Langflow OSS on macOS. You may see error messages like `Langflow Installation Error: error_xcode` or a detailed message with the title `Xcode Command Line Tools required!`.
176198

177-
1. Open a terminal and run `xcode-select --install`.
178-
2. **The installation may take over 20 minutes**.
179-
To start the installation process, in the popup dialogue, click **Install**.
180-
3. Verify the installation by opening a new terminal and running `xcode-select -p`.
181-
The command should return a path like `/Library/Developer/CommandLineTools`.
182-
4. Restart Langflow Desktop.
199+
To resolve this error, do the following:
183200

184-
If the manual installation doesn't resolve the issue, download Xcode Command Line Tools from [Apple Developer Downloads](https://developer.apple.com/download/all/), and install the `.dmg` file manually.
201+
1. Install [Xcode Command Line Tools](https://developer.apple.com/xcode/resources/).
202+
2. Launch Xcode at least once. Xcode performs additional setup on first startup that other tools such as Git, VS Code, and Langflow Desktop depend on.
203+
3. Restart Langflow Desktop.
185204

186-
### Failed to install Langflow OSS: Missing C++ Build Tools
205+
### Langflow Installation Error: error_cpp
187206

188207
Microsoft Windows installations of Langflow Desktop require a C++ compiler that may not be present on your system.
189-
If you receive a `C++ Build Tools Required!` error, see the error message `Langflow Installation Error: error_cpp`, or see a detailed message with the title "C++ Build Tools required!", follow the on-screen prompt to install Microsoft C++ Build Tools, or install [Microsoft Visual Studio](https://visualstudio.microsoft.com/downloads/).
208+
If you receive a `Langflow Installation Error: error_cpp` error or a detailed message with the title `C++ Build Tools required!`, follow the on-screen prompt to install Microsoft C++ Build Tools, or install [Microsoft Visual Studio](https://visualstudio.microsoft.com/downloads/).
190209

191-
### All automatic installation strategies failed on Windows
210+
### UV Installation Error: uv-manual-install-required
192211

193-
Langflow Desktop tried multiple methods to automatically install `uv` but all attempts failed. Desktop requires `uv` to manage Python packages and virtual environments. You may see the error message: `UV Installation Error: uv-manual-install-required` or a detailed manual installation message.
212+
Langflow Desktop tried multiple methods to automatically install `uv` but all attempts failed. Desktop requires `uv` to manage Python packages and virtual environments. You may see error messages like `UV Installation Error: uv-manual-install-required` or a detailed manual installation message.
194213

195214
To resolve this error, do the following:
196215

0 commit comments

Comments
 (0)