English | 中文 | 日本語 | 한국어

Download and Install NodeJS >= 18.15.0

1. Install Flowise

   npm install -g flowise

2. Start Flowise

   npx flowise start

   With username & password

   npx flowise start --FLOWISE_USERNAME=user --FLOWISE_PASSWORD=1234

3. Open https://localhost:3000

1. Go to docker folder at the root of the project
2. Copy .env.example file, paste it into the same location, and rename to .env
3. docker compose up -d
4. Open https://localhost:3000
5. You can bring the containers down by docker compose stop

1. Build the image locally:

   docker build --no-cache -t flowise .

2. Run image:

   docker run -d --name flowise -p 3000:3000 flowise

3. Stop image:

   docker stop flowise

Flowise has 3 different modules in a single mono repository.

• server: Node backend to serve API logics
• ui: React frontend
• components: Third-party nodes integrations

• Install PNPM

  npm i -g pnpm

1. Clone the repository

   git clone https://github.com/FlowiseAI/Flowise.git

2. Go into repository folder

   cd Flowise

3. Install all dependencies of all modules:

   pnpm install

4. Build all the code:

   pnpm build

   Exit code 134 (JavaScript heap out of memory)

   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"
   pnpm build
   

5. Start the app:

   pnpm start

   You can now access the app on https://localhost:3000

6. For development build:

   • Create .env file and specify the VITE_PORT (refer to .env.example) in packages/ui

   • Create .env file and specify the PORT (refer to .env.example) in packages/server

   • Run

     pnpm dev

   Any code changes will reload the app automatically on https://localhost:8080

To enable app level authentication, add FLOWISE_USERNAME and FLOWISE_PASSWORD to the .env file in packages/server:

FLOWISE_USERNAME=user
FLOWISE_PASSWORD=1234

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

Flowise Docs

Deploy Flowise self-hosted in your existing infrastructure, we support various deployments

• AWS

• Azure

• Digital Ocean

• GCP

• Others

  • Railway

    

  • Render

    

  • HuggingFace Spaces

    

  • Elestio

    

  • Sealos

    

  • RepoCloud

    

Coming soon

Feel free to ask any questions, raise problems, and request new features in discussion

Thanks go to these awesome contributors

See contributing guide. Reach out to us at Discord if you have any questions or issues.

Source code in this repository is made available under the Apache License Version 2.0.