|
2 | 2 |
|
3 | 3 | # Contributing to Flowise
|
4 | 4 |
|
5 |
| -English | [中文](./CONTRIBUTING-ZH.md) |
| 5 | +English | [中文](./i18n/CONTRIBUTING-ZH.md) |
6 | 6 |
|
7 | 7 | We appreciate any form of contributions.
|
8 | 8 |
|
@@ -120,39 +120,41 @@ Flowise has 3 different modules in a single mono repository.
|
120 | 120 |
|
121 | 121 | 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](https://docs.flowiseai.com/environment-variables)
|
122 | 122 |
|
123 |
| -| Variable | Description | Type | Default | |
124 |
| -| ---------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------ | ----------------------------------- | |
125 |
| -| PORT | The HTTP port Flowise runs on | Number | 3000 | |
126 |
| -| CORS_ORIGINS | The allowed origins for all cross-origin HTTP calls | String | | |
127 |
| -| IFRAME_ORIGINS | The allowed origins for iframe src embedding | String | | |
128 |
| -| FLOWISE_USERNAME | Username to login | String | | |
129 |
| -| FLOWISE_PASSWORD | Password to login | String | | |
130 |
| -| FLOWISE_FILE_SIZE_LIMIT | Upload File Size Limit | String | 50mb | |
131 |
| -| DEBUG | Print logs from components | Boolean | | |
132 |
| -| LOG_PATH | Location where log files are stored | String | `your-path/Flowise/logs` | |
133 |
| -| LOG_LEVEL | Different levels of logs | Enum String: `error`, `info`, `verbose`, `debug` | `info` | |
134 |
| -| APIKEY_PATH | Location where api keys are saved | String | `your-path/Flowise/packages/server` | |
135 |
| -| TOOL_FUNCTION_BUILTIN_DEP | NodeJS built-in modules to be used for Tool Function | String | | |
136 |
| -| TOOL_FUNCTION_EXTERNAL_DEP | External modules to be used for Tool Function | String | | |
137 |
| -| DATABASE_TYPE | Type of database to store the flowise data | Enum String: `sqlite`, `mysql`, `postgres` | `sqlite` | |
138 |
| -| DATABASE_PATH | Location where database is saved (When DATABASE_TYPE is sqlite) | String | `your-home-dir/.flowise` | |
139 |
| -| DATABASE_HOST | Host URL or IP address (When DATABASE_TYPE is not sqlite) | String | | |
140 |
| -| DATABASE_PORT | Database port (When DATABASE_TYPE is not sqlite) | String | | |
141 |
| -| DATABASE_USER | Database username (When DATABASE_TYPE is not sqlite) | String | | |
142 |
| -| DATABASE_PASSWORD | Database password (When DATABASE_TYPE is not sqlite) | String | | |
143 |
| -| DATABASE_NAME | Database name (When DATABASE_TYPE is not sqlite) | String | | |
144 |
| -| DATABASE_SSL_KEY_BASE64 | Database SSL client cert in base64 (takes priority over DATABASE_SSL) | Boolean | false | |
145 |
| -| DATABASE_SSL | Database connection overssl (When DATABASE_TYPE is postgre) | Boolean | false | |
146 |
| -| SECRETKEY_PATH | Location where encryption key (used to encrypt/decrypt credentials) is saved | String | `your-path/Flowise/packages/server` | |
147 |
| -| FLOWISE_SECRETKEY_OVERWRITE | Encryption key to be used instead of the key stored in SECRETKEY_PATH | String | |
148 |
| -| DISABLE_FLOWISE_TELEMETRY | Turn off telemetry | Boolean | |
149 |
| -| MODEL_LIST_CONFIG_JSON | File path to load list of models from your local config file | String | `/your_model_list_config_file_path` | |
150 |
| -| STORAGE_TYPE | Type of storage for uploaded files. default is `local` | Enum String: `s3`, `local` | `local` | |
151 |
| -| BLOB_STORAGE_PATH | Local folder path where uploaded files are stored when `STORAGE_TYPE` is `local` | String | `your-home-dir/.flowise/storage` | |
152 |
| -| S3_STORAGE_BUCKET_NAME | Bucket name to hold the uploaded files when `STORAGE_TYPE` is `s3` | String | | |
153 |
| -| S3_STORAGE_ACCESS_KEY_ID | AWS Access Key | String | | |
154 |
| -| S3_STORAGE_SECRET_ACCESS_KEY | AWS Secret Key | String | | |
155 |
| -| S3_STORAGE_REGION | Region for S3 bucket | String | | |
| 123 | +| Variable | Description | Type | Default | |
| 124 | +| ---------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------------------------------- | |
| 125 | +| PORT | The HTTP port Flowise runs on | Number | 3000 | |
| 126 | +| CORS_ORIGINS | The allowed origins for all cross-origin HTTP calls | String | | |
| 127 | +| IFRAME_ORIGINS | The allowed origins for iframe src embedding | String | | |
| 128 | +| FLOWISE_USERNAME | Username to login | String | | |
| 129 | +| FLOWISE_PASSWORD | Password to login | String | | |
| 130 | +| FLOWISE_FILE_SIZE_LIMIT | Upload File Size Limit | String | 50mb | |
| 131 | +| DISABLE_CHATFLOW_REUSE | Forces the creation of a new ChatFlow for each call instead of reusing existing ones from cache | Boolean | | |
| 132 | +| DEBUG | Print logs from components | Boolean | | |
| 133 | +| LOG_PATH | Location where log files are stored | String | `your-path/Flowise/logs` | |
| 134 | +| LOG_LEVEL | Different levels of logs | Enum String: `error`, `info`, `verbose`, `debug` | `info` | |
| 135 | +| LOG_JSON_SPACES | Spaces to beautify JSON logs | | 2 | |
| 136 | +| APIKEY_PATH | Location where api keys are saved | String | `your-path/Flowise/packages/server` | |
| 137 | +| TOOL_FUNCTION_BUILTIN_DEP | NodeJS built-in modules to be used for Tool Function | String | | |
| 138 | +| TOOL_FUNCTION_EXTERNAL_DEP | External modules to be used for Tool Function | String | | |
| 139 | +| DATABASE_TYPE | Type of database to store the flowise data | Enum String: `sqlite`, `mysql`, `postgres` | `sqlite` | |
| 140 | +| DATABASE_PATH | Location where database is saved (When DATABASE_TYPE is sqlite) | String | `your-home-dir/.flowise` | |
| 141 | +| DATABASE_HOST | Host URL or IP address (When DATABASE_TYPE is not sqlite) | String | | |
| 142 | +| DATABASE_PORT | Database port (When DATABASE_TYPE is not sqlite) | String | | |
| 143 | +| DATABASE_USER | Database username (When DATABASE_TYPE is not sqlite) | String | | |
| 144 | +| DATABASE_PASSWORD | Database password (When DATABASE_TYPE is not sqlite) | String | | |
| 145 | +| DATABASE_NAME | Database name (When DATABASE_TYPE is not sqlite) | String | | |
| 146 | +| DATABASE_SSL_KEY_BASE64 | Database SSL client cert in base64 (takes priority over DATABASE_SSL) | Boolean | false | |
| 147 | +| DATABASE_SSL | Database connection overssl (When DATABASE_TYPE is postgre) | Boolean | false | |
| 148 | +| SECRETKEY_PATH | Location where encryption key (used to encrypt/decrypt credentials) is saved | String | `your-path/Flowise/packages/server` | |
| 149 | +| FLOWISE_SECRETKEY_OVERWRITE | Encryption key to be used instead of the key stored in SECRETKEY_PATH | String | |
| 150 | +| DISABLE_FLOWISE_TELEMETRY | Turn off telemetry | Boolean | |
| 151 | +| MODEL_LIST_CONFIG_JSON | File path to load list of models from your local config file | String | `/your_model_list_config_file_path` | |
| 152 | +| STORAGE_TYPE | Type of storage for uploaded files. default is `local` | Enum String: `s3`, `local` | `local` | |
| 153 | +| BLOB_STORAGE_PATH | Local folder path where uploaded files are stored when `STORAGE_TYPE` is `local` | String | `your-home-dir/.flowise/storage` | |
| 154 | +| S3_STORAGE_BUCKET_NAME | Bucket name to hold the uploaded files when `STORAGE_TYPE` is `s3` | String | | |
| 155 | +| S3_STORAGE_ACCESS_KEY_ID | AWS Access Key | String | | |
| 156 | +| S3_STORAGE_SECRET_ACCESS_KEY | AWS Secret Key | String | | |
| 157 | +| S3_STORAGE_REGION | Region for S3 bucket | String | | |
156 | 158 |
|
157 | 159 | You can also specify the env variables when using `npx`. For example:
|
158 | 160 |
|
|
0 commit comments