Sultan
/
Flowise
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: clarify Node.js heap memory instructions for cross-platform usage (#5041) 

docs: clarify Node.js heap config for all platforms
This commit is contained in:
Hung-Ruei Wu 2025-08-08 22:40:21 +08:00 committed by GitHub
parent bbcfb5ab63
commit fddd40a5cd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 31 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -23,16 +23,16 @@ English | [繁體中文](./i18n/README-TW.md) | [简体中文](./i18n/README-ZH.
## 📚 Table of Contents ## 📚 Table of Contents
- [⚡ Quick Start](#-quick-start) - [⚡ Quick Start](#-quick-start)
- [🐳 Docker](#-docker) - [🐳 Docker](#-docker)
- [👨‍💻 Developers](#-developers) - [👨‍💻 Developers](#-developers)
- [🌱 Env Variables](#-env-variables) - [🌱 Env Variables](#-env-variables)
- [📖 Documentation](#-documentation) - [📖 Documentation](#-documentation)
- [🌐 Self Host](#-self-host) - [🌐 Self Host](#-self-host)
- [☁️ Flowise Cloud](#️-flowise-cloud) - [☁️ Flowise Cloud](#️-flowise-cloud)
- [🙋 Support](#-support) - [🙋 Support](#-support)
- [🙌 Contributing](#-contributing) - [🙌 Contributing](#-contributing)
- [📄 License](#-license) - [📄 License](#-license)
## ⚡Quick Start ## ⚡Quick Start
@ -64,18 +64,19 @@ Download and Install [NodeJS](https://nodejs.org/en/download) >= 18.15.0
### Docker Image ### Docker Image
1. Build the image locally: 1. Build the image locally:
```bash ```bash
docker build --no-cache -t flowise . docker build --no-cache -t flowise .
``` ```
2. Run image: 2. Run image:
```bash ```bash
docker run -d --name flowise -p 3000:3000 flowise docker run -d --name flowise -p 3000:3000 flowise
``` ```
3. Stop image: 3. Stop image:
```bash ```bash
docker stop flowise docker stop flowise
``` ```
@ -124,10 +125,24 @@ Flowise has 3 different modules in a single mono repository.
<details> <details>
<summary>Exit code 134 (JavaScript heap out of memory)</summary> <summary>Exit code 134 (JavaScript heap out of memory)</summary>
If you get this error when running the above `build` script, try increasing the Node.js heap size and run the script again: If you get this error when running the above `build` script, try increasing the Node.js heap size and run the script again:
export NODE_OPTIONS="--max-old-space-size=4096" ```bash
pnpm build # macOS / Linux / Git Bash
export NODE_OPTIONS="--max-old-space-size=4096"
# Windows PowerShell
$env:NODE_OPTIONS="--max-old-space-size=4096"
# Windows CMD
set NODE_OPTIONS=--max-old-space-size=4096
```
Then run:
```bash
pnpm build
```
</details> </details>