Environment Variables

Learn how to configure environment variables for Flowise

Flowise support different environment variables to configure your instance. You can specify the following variables in the .env file inside packages/server folder. Refer to .env.example file.

Variable Description Type Default

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
FLOWISE_FILE_SIZE_LIMIT	Maximum file size when uploading	String	`50mb`
NUMBER_OF_PROXIES	Rate Limit Proxy	Number
CORS_ORIGINS	The allowed origins for all cross-origin HTTP calls	String
IFRAME_ORIGINS	The allowed origins for iframe src embedding	String
DISABLE_CHATFLOW_REUSE	Disable caching the flow, allowing every interaction of the chatflow will be executed from scratch	Boolean: `true` or `false`
SHOW_COMMUNITY_NODES	Display nodes that are created by community	Boolean: `true` or `false`

PORT

The HTTP port Flowise runs on

Number

3000

FLOWISE_USERNAME

Username to login

String

FLOWISE_PASSWORD

Password to login

String

FLOWISE_FILE_SIZE_LIMIT

Maximum file size when uploading

String

50mb

NUMBER_OF_PROXIES

Rate Limit Proxy

Number

CORS_ORIGINS

The allowed origins for all cross-origin HTTP calls

String

IFRAME_ORIGINS

The allowed origins for iframe src embedding

String

DISABLE_CHATFLOW_REUSE

Disable caching the flow, allowing every interaction of the chatflow will be executed from scratch

Boolean: true or false

SHOW_COMMUNITY_NODES

Display nodes that are created by community

Boolean: true or false

For Database

Variable Description Type Default

Variable	Description	Type	Default
DATABASE_TYPE	Type of database to store the flowise data	Enum String: `sqlite`, `mysql`, `postgres`	`sqlite`
DATABASE_PATH	Location where database is saved (When DATABASE_TYPE is sqlite)	String	`your-home-dir/.flowise`
DATABASE_HOST	Host URL or IP address (When DATABASE_TYPE is not sqlite)	String
DATABASE_PORT	Database port (When DATABASE_TYPE is not sqlite)	String
DATABASE_USER	Database username (When DATABASE_TYPE is not sqlite)	String
DATABASE_PASSWORD	Database password (When DATABASE_TYPE is not sqlite)	String
DATABASE_NAME	Database name (When DATABASE_TYPE is not sqlite)	String
DATABASE_SSL	Database SSL is required (When DATABASE_TYPE is not sqlite)	Boolean: `true` or `false`	`false`

DATABASE_TYPE

Type of database to store the flowise data

Enum String: sqlite, mysql, postgres

sqlite

DATABASE_PATH

Location where database is saved (When DATABASE_TYPE is sqlite)

String

your-home-dir/.flowise

DATABASE_HOST

Host URL or IP address (When DATABASE_TYPE is not sqlite)

String

DATABASE_PORT

Database port (When DATABASE_TYPE is not sqlite)

String

DATABASE_USER

Database username (When DATABASE_TYPE is not sqlite)

String

DATABASE_PASSWORD

Database password (When DATABASE_TYPE is not sqlite)

String

DATABASE_NAME

Database name (When DATABASE_TYPE is not sqlite)

String

DATABASE_SSL

Database SSL is required (When DATABASE_TYPE is not sqlite)

Boolean: true or false

false

For LangSmith Tracing

Flowise supports LangSmith tracing with the following env variables:

Variable Description Type

Variable	Description	Type
LANGCHAIN_TRACING_V2	Turn LangSmith tracing ON or OFF	Enum String: `true`, `false`
LANGCHAIN_ENDPOINT	LangSmith endpoint	String
LANGCHAIN_API_KEY	LangSmith API Key	String
LANGCHAIN_PROJECT	Project to trace on LangSmith	String

LANGCHAIN_TRACING_V2

Turn LangSmith tracing ON or OFF

Enum String: true, false

LANGCHAIN_ENDPOINT

LangSmith endpoint

String

LANGCHAIN_API_KEY

LangSmith API Key

String

LANGCHAIN_PROJECT

Project to trace on LangSmith

String

Watch how connect Flowise and LangSmith

For Built-In and External Dependencies

For security reasons, by default Tool Function only allow certain dependencies. It's possible to lift that restriction for built-in and external modules by setting the following environment variables:

Variable	Description
TOOL_FUNCTION_BUILTIN_DEP	NodeJS built-in modules to be used for Tool Function	String
TOOL_FUNCTION_EXTERNAL_DEP	External modules to be used for Tool Function	String

Variable

Description

TOOL_FUNCTION_BUILTIN_DEP

NodeJS built-in modules to be used for Tool Function

String

TOOL_FUNCTION_EXTERNAL_DEP

External modules to be used for Tool Function

String

.env

# Allows usage of all builtin modules
TOOL_FUNCTION_BUILTIN_DEP=*

# Allows usage of only fs
TOOL_FUNCTION_BUILTIN_DEP=fs

# Allows usage of only crypto and fs
TOOL_FUNCTION_BUILTIN_DEP=crypto,fs

# Allow usage of external npm modules.
TOOL_FUNCTION_EXTERNAL_DEP=axios,moment

For Debugging and Logs

Variable Description Type

Variable	Description	Type
DEBUG	Print logs from components	Boolean
LOG_PATH	Location where log files are stored	String	`Flowise/packages/server/logs`
LOG_LEVEL	Different levels of logs	Enum String: `error`, `info`, `verbose`, `debug`	`info`

DEBUG

Print logs from components

Boolean

LOG_PATH

Location where log files are stored

String

Flowise/packages/server/logs

LOG_LEVEL

Different levels of logs

Enum String: error, info, verbose, debug

info

DEBUG: if set to true, will print logs to terminal/console:

LOG_LEVEL: Different log levels for loggers to be saved. Can be error, info, verbose, or debug. By default it is set to info, only logger.info will be saved to the log files. If you want to have complete details, set to debug.

For Credentials

Flowise store your third party API keys as encrypted credentials using an encryption key.

By default, a random encryption key will be generated when starting up the application and stored under a file path. This encryption key is then retrieved everytime to decrypt the credentials used within a chatflow. For example, your OpenAI API key, Pinecone API key, etc.

Variable Description Type

Variable	Description	Type
SECRETKEY_PATH	Location where encryption key (used to encrypt/decrypt credentials) is saved	String	`Flowise/packages/server`
FLOWISE_SECRETKEY_OVERWRITE	Encryption key to be used instead of the key stored in SECRETKEY_PATH	String

SECRETKEY_PATH

Location where encryption key (used to encrypt/decrypt credentials) is saved

String

Flowise/packages/server

FLOWISE_SECRETKEY_OVERWRITE

Encryption key to be used instead of the key stored in SECRETKEY_PATH

String

For some reasons, sometimes encryption key might be re-generated or the stored path was changed, this will cause errors like - Credentials could not be decrypted.

To avoid this, you can set your own encryption key as FLOWISE_SECRETKEY_OVERWRITE, so that the same encryption key will be used everytime. There is no restriction on the format, you can set it as any text that you want, or the same as your FLOWISE_PASSWORD.

Credential API Key returned from the UI is not the same length as your original Api Key that you have set. This is a fake prefix string that prevents network spoofing, that's why we are not returning the Api Key back to UI. However, the correct Api Key will be retrieved and used during your interaction with the chatflow.

For Models

In some cases, you might want to use custom model on the existing Chat Model and LLM nodes, or restrict access to only certain models.

By default, Flowise pulls the model list from here. However user can create their own models.json file and specify the file path:

Variable Description Type Default

Variable	Description	Type	Default
MODEL_LIST_CONFIG_JSON	Link to load list of models from your `models.json` config file	String

MODEL_LIST_CONFIG_JSON

Link to load list of models from your models.json config file

String

For Flowise API Keys

By default, Flowise stores your API keys (not Credentials) that can be used to interact with API Reference to a local file path. User can change the behavior by using the below env variable.

Variable Description Type Default

Variable	Description	Type	Default
APIKEY_STORAGE_TYPE	Method to store API keys	Enum string: `json`, `db`	`json`
APIKEY_PATH	Location where the API keys are stored when `APIKEY_STORAGE_TYPE` is unspecified or `json`	String	`Flowise/packages/server`

APIKEY_STORAGE_TYPE

Method to store API keys

Enum string: json, db

json

APIKEY_PATH

Location where the API keys are stored when APIKEY_STORAGE_TYPE is unspecified or json

String

Flowise/packages/server

Using db as storage type will store the API keys to database instead of a local JSON file.

For Storage

Flowise store the following files under a local path folder by default.

Files uploaded on Document Loaders/Document Store
Image/Audio uploads from chat
Images/Files from Assistant
Files from Vector Upsert API

User can specify STORAGE_TYPE to use AWS S3 or local path

Variable Description Type Default

Variable	Description	Type	Default
STORAGE_TYPE	Type of storage for uploaded files. default is `local`	Enum String: `s3`, `local`	`local`
BLOB_STORAGE_PATH	Local folder path where uploaded files are stored when `STORAGE_TYPE` is `local`	String	`your-home-dir/.flowise/storage`
S3_STORAGE_BUCKET_NAME	Bucket name to hold the uploaded files when `STORAGE_TYPE` is `s3`	String
S3_STORAGE_ACCESS_KEY_ID	AWS Access Key	String
S3_STORAGE_SECRET_ACCESS_KEY	AWS Secret Key	String
S3_STORAGE_REGION	Region for S3 bucket	String

STORAGE_TYPE

Type of storage for uploaded files. default is local

Enum String: s3, local

local

BLOB_STORAGE_PATH

Local folder path where uploaded files are stored when STORAGE_TYPE is local

String

your-home-dir/.flowise/storage

S3_STORAGE_BUCKET_NAME

Bucket name to hold the uploaded files when STORAGE_TYPE is s3

String

S3_STORAGE_ACCESS_KEY_ID

AWS Access Key

String

S3_STORAGE_SECRET_ACCESS_KEY

AWS Secret Key

String

S3_STORAGE_REGION

Region for S3 bucket

String

Examples of how to set environment variables:

NPM

You can set all these variables when running Flowise using npx. For example:

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

Docker

docker run -d -p 5678:5678 flowise \
 -e DATABASE_TYPE=postgresdb \
 -e DATABASE_PORT=<POSTGRES_PORT> \
 -e DATABASE_HOST=<POSTGRES_HOST> \
 -e DATABASE_NAME=<POSTGRES_DATABASE_NAME> \
 -e DATABASE_USER=<POSTGRES_USER> \
 -e DATABASE_PASSWORD=<POSTGRES_PASSWORD> \

Docker Compose

You can set all these variables in the .env file inside docker folder. Refer to .env.example file.

PreviousZeabur NextRate Limit

Last updated 26 days ago