File: README.md
Flowise has been archived. Refer to [Future of Flowise](https://github.com/FlowiseAI/Flowise/discussions/6727)
Build AI Agents, Visually
๐ Table of Contents
- โก Quick Start
- ๐ณ Docker
- ๐จโ๐ป Developers
- ๐ฑ Env Variables
- ๐ Documentation
- ๐ Self Host
- โ๏ธ Flowise Cloud
- ๐ Support
- ๐ Contributing
- ๐ License
โกQuick Start
Download and Install NodeJS >= 20.0.0
Install Flowise
bashnpm install flowiseStart Flowise
bashnpx flowise start
๐ณ Docker
Docker Compose
- Clone the Flowise project
- Go to
dockerfolder at the root of the project - Copy
.env.examplefile, paste it into the same location, and rename to.envfile docker compose up -d- Open http://localhost:3000
- You can bring the containers down by
docker compose stop
Docker Image
Build the image locally:
bashdocker build --no-cache -t flowise .Run image:
bashdocker run -d --name flowise -p 3000:3000 flowiseStop image:
bashdocker stop flowise
๐จโ๐ป Developers
Flowise has 3 different modules in a single mono repository.
server: Node backend to serve API logicsui: React frontendcomponents: Third-party nodes integrationsapi-documentation: Auto-generated swagger-ui API docs from express
Prerequisite
- Install PNPMbash
npm i pnpm
Setup
Clone the repository:
bashgit clone https://github.com/FlowiseAI/Flowise.gitGo into repository folder:
bashcd FlowiseInstall all dependencies of all modules:
bashpnpm installBuild all the code:
bashpnpm buildExit code 134 (JavaScript heap out of memory)
If you get this error when running the abovebuildscript, try increasing the Node.js heap size and run the script again:bash# 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=4096Then run:
bashpnpm buildStart the app:
bashpnpm startYou can now access the app on http://localhost:3000
For development build:
Create
.envfile and specify theVITE_PORT(refer to.env.example) inpackages/uiCreate
.envfile and specify thePORT(refer to.env.example) inpackages/serverRun:
bashpnpm dev
Any code changes will reload the app automatically on http://localhost:8080
๐ฑ Env Variables
Flowise supports different environment variables to configure your instance. You can specify the following variables in the .env file inside packages/server folder. Read more
๐ Documentation
You can view the Flowise Docs here
๐ Self Host
Deploy Flowise self-hosted in your existing infrastructure, we support various deployments
- text
Others
โ๏ธ Flowise Cloud
Get Started with Flowise Cloud.
๐ Support
Feel free to ask any questions, raise problems, and request new features in Discussion.
๐ Contributing
Thanks go to these awesome contributors
See Contributing Guide. Reach out to us at Discord if you have any questions or issues.
๐ License
Source code in this repository is made available under the Apache License Version 2.0.
File: docker/worker/README.md
Flowise Worker
By utilizing worker instances when operating in queue mode, Flowise can be scaled horizontally by adding more workers to handle increased workloads or scaled down by removing workers when demand decreases.
Hereโs an overview of the process:
- The primary Flowise instance sends an execution ID to a message broker, Redis, which maintains a queue of pending executions, allowing the next available worker to process them.
- A worker from the pool retrieves a message from Redis.
The worker starts execute the actual job. - Once the execution is completed, the worker alerts the main instance that the execution is finished.
How to use
Setting up Main Server:
- Follow setup guide
- In the
.env.example, setup all the necessary env variables forQUEUE CONFIGURATION
Setting up Worker:
- Navigate to
docker/workerfolder - In the
.env.example, setup all the necessary env variables forQUEUE CONFIGURATION. Env variables for worker must match the one for main server. Change theWORKER_PORTto other available port numbers to listen for healthcheck. Ex: 5566 docker compose up -d- You can bring the worker container down by
docker compose stop
Entrypoint:
Different from main server image which is using flowise start, entrypoint for worker is pnpm run start-worker. This is because the worker's Dockerfile build the image from source files via pnpm build instead of npm registry via RUN npm install flowise.
File: docker/README.md
Flowise Docker Hub Image
Starts Flowise from DockerHub Image
Usage
- Create
.envfile and specify thePORT(refer to.env.example) docker compose up -d- Open http://localhost:3000
- You can bring the containers down by
docker compose stop
๐ฑ Env Variables
If you like to persist your data (flows, logs, credentials, storage), set these variables in the .env file inside docker folder:
- DATABASE_PATH=/home/node/.flowise
- LOG_PATH=/home/node/.flowise/logs
- SECRETKEY_PATH=/home/node/.flowise
- BLOB_STORAGE_PATH=/home/node/.flowise/storage
Flowise also support different environment variables to configure your instance. Read more
The container runs as the non-root
nodeuser (uid 1000), whose home directory is/home/node. If you bind-mount a host directory (e.g.~/.flowise) for persistence, make sure it's writable by that user - on Linux hosts this may requirechown -R 1000:1000 ~/.flowise.
Queue Mode:
Building from source:
You can build the images for worker and main from scratch with:
docker compose -f docker-compose-queue-source.yml up -dMonitor Health:
docker compose -f docker-compose-queue-source.yml psFrom pre-built images:
You can also use the pre-built images:
docker compose -f docker-compose-queue-prebuilt.yml up -dMonitor Health:
docker compose -f docker-compose-queue-prebuilt.yml psFile: packages/ui/README.md
Flowise UI
English | ไธญๆ
React frontend ui for Flowise.
Install:
npm i flowise-uiLicense
Source code in this repository is made available under the Apache License Version 2.0.
File: packages/ui/README-ZH.md
ๆต็จ็้ข
English | ไธญๆ
Flowise ็ React ๅ็ซฏ็้ขใ
ๅฎ่ฃ ๏ผ
npm i flowise-ui่ฎธๅฏ่ฏ
ๆฌไปๅบไธญ็ๆบไปฃ็ ๅจApache License Version 2.0 ่ฎธๅฏ่ฏไธๆไพใ
File: packages/server/README.md
Flowise
English | ไธญๆ
Build AI Agents, Visually
โกQuick Start
Install Flowise
bashnpm install flowiseStart Flowise
bashnpx flowise start
๐ฑ Env Variables
Flowise support different environment variables to configure your instance. You can specify the following variables in the .env file inside packages/server folder. Read more
You can also specify the env variables when using npx. For example:
npx flowise start --PORT=3000 --DEBUG=true๐ Tests
We use Cypress for our e2e testing. If you want to run the test suite in dev mode please follow this guide:
cd Flowise/packages/server
pnpm install
./node_modules/.bin/cypress install
pnpm build
#Only for writing new tests on local dev -> pnpm run cypress:open
pnpm run e2e๐ Documentation
๐ Self Host
- text
Others
โ๏ธ Flowise Cloud
Get Started with Flowise Cloud
๐ Support
Feel free to ask any questions, raise problems, and request new features in discussion
๐ Contributing
See contributing guide. Reach out to us at Discord if you have any questions or issues.
๐ License
Source code in this repository is made available under the Apache License Version 2.0.
File: packages/server/README-ZH.md
Flowise
English | ไธญๆ
ไปฅๅฏ่งๅๆนๅผๆๅปบ AI Agents
โก ๅฟซ้ๅ ฅ้จ
ๅฎ่ฃ Flowise
bashnpm install flowiseๅฏๅจ Flowise
bashnpx flowise startๆๅผhttp://localhost:3000
๐ฑ ็ฏๅขๅ้
Flowise ๆฏๆไธๅ็็ฏๅขๅ้ๆฅ้
็ฝฎๆจ็ๅฎไพใๆจๅฏไปฅๅจpackages/serverๆไปถๅคนไธญ็.envๆไปถไธญๆๅฎไปฅไธๅ้ใ้
่ฏปๆดๅค
ๆจ่ฟๅฏไปฅๅจไฝฟ็จnpxๆถๆๅฎ็ฏๅขๅ้ใไพๅฆ๏ผ
npx flowise start --PORT=3000 --DEBUG=true๐ ๆๆกฃ
๐ ่ชๆ็ฎก
ๅจๆจ็ฐๆ็ๅบ็ก่ฎพๆฝไธญ้จ็ฝฒ่ชๆ็ฎก็ Flowise๏ผๆไปฌๆฏๆๅ็ง้จ็ฝฒ
- text
ๅ ถไป
โ๏ธ ไบๆ็ฎก
๐ ๆฏๆ
ๅจ่ฎจ่ฎบๅบไธญ้ๆถๆๅบไปปไฝ้ฎ้ขใๆฅๅ้ฎ้ขๅ่ฏทๆฑๆฐๅ่ฝใ
๐ ่ดก็ฎ
่ฏทๅ้ ่ดก็ฎๆๅใๅฆๆๆจๆไปปไฝ้ฎ้ขๆ้ฎ้ข๏ผ่ฏทๅจDiscordไธไธๆไปฌ่็ณปใ
๐ ่ฎธๅฏ่ฏ
ๆฌไปๅบไธญ็ๆบไปฃ็ ๅจApache License Version 2.0 ่ฎธๅฏ่ฏไธๆไพใ
File: packages/components/nodes/recordmanager/PostgresRecordManager/README.md
Postgres Record Manager
Postgres Record Manager integration for Flowise
๐ฑ Env Variables
| Variable | Description | Type | Default |
|---|---|---|---|
| POSTGRES_RECORDMANAGER_HOST | Default host for Postgres Record Manager |
String | |
| POSTGRES_RECORDMANAGER_PORT | Default port for Postgres Record Manager |
Number | 5432 |
| POSTGRES_RECORDMANAGER_USER | Default user for Postgres Record Manager |
String | |
| POSTGRES_RECORDMANAGER_PASSWORD | Default password for Postgres Record Manager |
String | |
| POSTGRES_RECORDMANAGER_DATABASE | Default database for Postgres Record Manager |
String | |
| POSTGRES_RECORDMANAGER_TABLE_NAME | Default tableName for Postgres Record Manager |
String | upsertion_records |
| POSTGRES_RECORDMANAGER_SSL | Default ssl for Postgres Vector Store |
Boolean | false |
License
Source code in this repository is made available under the Apache License Version 2.0.
File: packages/components/nodes/llms/Azure OpenAI/README.md
Azure OpenAI LLM
Azure OpenAI LLM integration for Flowise
๐ฑ Env Variables
| Variable | Description | Type | Default |
|---|---|---|---|
| AZURE_OPENAI_API_KEY | Default credential.azureOpenAIApiKey for Azure OpenAI LLM |
String | |
| AZURE_OPENAI_API_INSTANCE_NAME | Default credential.azureOpenAIApiInstanceName for Azure OpenAI LLM |
String | |
| AZURE_OPENAI_API_DEPLOYMENT_NAME | Default credential.azureOpenAIApiDeploymentName for Azure OpenAI LLM |
String | |
| AZURE_OPENAI_API_VERSION | Default credential.azureOpenAIApiVersion for Azure OpenAI LLM |
String |
License
Source code in this repository is made available under the Apache License Version 2.0.