Flowise/packages/server/README.md

3.9 KiB

Flowise - Low-Code LLM apps builder

Flowise

Drag & drop UI to build your customized LLM flow

Quick Start

  1. Install Flowise

    npm install -g flowise
    
  2. Start Flowise

    npx flowise start
    
  3. Open http://localhost:3000

🔒 Authentication

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

FLOWISE_USERNAME=user
FLOWISE_PASSWORD=1234

🌱 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

Variable Description Type Default
PORT The HTTP port Flowise runs on Number 3000
FLOWISE_USERNAME Username to login String
FLOWISE_PASSWORD Password to login String
DEBUG Print logs onto terminal/console Boolean
LOG_PATH Location where log files are stored String your-path/Flowise/packages/server
LOG_LEVEL Different log levels for loggers to be saved Enum String: error, info, verbose, debug info
DATABASE_PATH Location where database is saved String your-home-dir/.flowise
APIKEY_PATH Location where api keys are saved String your-path/Flowise/packages/server
EXECUTION_MODE Whether predictions run in their own process or the main process Enum String: child, main main

You can also specify the env variables when using npx. For example:

npx flowise start --PORT=3000 --DEBUG=true

📖 Documentation

Flowise Docs

🌐 Self Host

Railway

Deploy on Railway

Render

Deploy to Render

AWS

Azure

DigitalOcean

GCP

💻 Cloud Hosted

Coming Soon

🙋 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 MIT License.