Skip to content

Commit fddd40a

Browse files
authored
docs: clarify Node.js heap memory instructions for cross-platform usage (#5041)
docs: clarify Node.js heap config for all platforms
1 parent bbcfb5a commit fddd40a

File tree

1 file changed

+31
-16
lines changed

1 file changed

+31
-16
lines changed

README.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ English | [繁體中文](./i18n/README-TW.md) | [简体中文](./i18n/README-ZH.
2323

2424
## 📚 Table of Contents
2525

26-
- [⚡ Quick Start](#-quick-start)
27-
- [🐳 Docker](#-docker)
28-
- [👨‍💻 Developers](#-developers)
29-
- [🌱 Env Variables](#-env-variables)
30-
- [📖 Documentation](#-documentation)
31-
- [🌐 Self Host](#-self-host)
32-
- [☁️ Flowise Cloud](#️-flowise-cloud)
33-
- [🙋 Support](#-support)
34-
- [🙌 Contributing](#-contributing)
35-
- [📄 License](#-license)
26+
- [⚡ Quick Start](#-quick-start)
27+
- [🐳 Docker](#-docker)
28+
- [👨‍💻 Developers](#-developers)
29+
- [🌱 Env Variables](#-env-variables)
30+
- [📖 Documentation](#-documentation)
31+
- [🌐 Self Host](#-self-host)
32+
- [☁️ Flowise Cloud](#️-flowise-cloud)
33+
- [🙋 Support](#-support)
34+
- [🙌 Contributing](#-contributing)
35+
- [📄 License](#-license)
3636

3737
## ⚡Quick Start
3838

@@ -64,18 +64,19 @@ Download and Install [NodeJS](https://nodejs.org/en/download) >= 18.15.0
6464
### Docker Image
6565

6666
1. Build the image locally:
67-
67+
6868
```bash
6969
docker build --no-cache -t flowise .
7070
```
71+
7172
2. Run image:
72-
73+
7374
```bash
7475
docker run -d --name flowise -p 3000:3000 flowise
7576
```
7677

7778
3. Stop image:
78-
79+
7980
```bash
8081
docker stop flowise
8182
```
@@ -124,10 +125,24 @@ Flowise has 3 different modules in a single mono repository.
124125

125126
<details>
126127
<summary>Exit code 134 (JavaScript heap out of memory)</summary>
127-
If you get this error when running the above `build` script, try increasing the Node.js heap size and run the script again:
128+
If you get this error when running the above `build` script, try increasing the Node.js heap size and run the script again:
129+
130+
```bash
131+
# macOS / Linux / Git Bash
132+
export NODE_OPTIONS="--max-old-space-size=4096"
133+
134+
# Windows PowerShell
135+
$env:NODE_OPTIONS="--max-old-space-size=4096"
128136
129-
export NODE_OPTIONS="--max-old-space-size=4096"
130-
pnpm build
137+
# Windows CMD
138+
set NODE_OPTIONS=--max-old-space-size=4096
139+
```
140+
141+
Then run:
142+
143+
```bash
144+
pnpm build
145+
```
131146

132147
</details>
133148

0 commit comments

Comments
 (0)