add flag

xiamiy · Jan 19, 2024 · b5de887 · b5de887
1 parent 953e146
commit b5de887
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 2 deletions.
diff --git a/CONTRIBUTING-ZH.md b/CONTRIBUTING-ZH.md
@@ -138,6 +138,7 @@ Flowise 支持不同的环境变量来配置您的实例。您可以在 `package
 | DATABASE_NAME               | 数据库名称（当 DATABASE_TYPE 不是 sqlite 时）          | 字符串                                          |                                     |
 | SECRETKEY_PATH              | 保存加密密钥（用于加密/解密凭据）的位置                | 字符串                                          | `your-path/Flowise/packages/server` |
 | FLOWISE_SECRETKEY_OVERWRITE | 加密密钥用于替代存储在 SECRETKEY_PATH 中的密钥         | 字符串                                          |
+| DISABLE_FLOWISE_TELEMETRY   | 关闭遥测                                               | 字符串                                          |
 
 您也可以在使用 `npx` 时指定环境变量。例如：
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -141,6 +141,7 @@ Flowise support different environment variables to configure your instance. You
 | DATABASE_SSL                | Database connection overssl (When DATABASE_TYPE is postgre)                  | Boolean                                          | false                               |
 | SECRETKEY_PATH              | Location where encryption key (used to encrypt/decrypt credentials) is saved | String                                           | `your-path/Flowise/packages/server` |
 | FLOWISE_SECRETKEY_OVERWRITE | Encryption key to be used instead of the key stored in SECRETKEY_PATH        | String                                           |
+| DISABLE_FLOWISE_TELEMETRY   | Turn off telemetry                                                           | Boolean                                          |
 
 You can also specify the env variables when using `npx`. For example:
 

diff --git a/docker/.env.example b/docker/.env.example
@@ -25,4 +25,6 @@ LOG_PATH=/root/.flowise/logs
 # LANGCHAIN_TRACING_V2=true
 # LANGCHAIN_ENDPOINT=https://api.smith.langchain.com
 # LANGCHAIN_API_KEY=your_api_key
-# LANGCHAIN_PROJECT=your_project
+# LANGCHAIN_PROJECT=your_project
+
+# DISABLE_FLOWISE_TELEMETRY=true
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
@@ -22,6 +22,7 @@ services:
             - FLOWISE_SECRETKEY_OVERWRITE=${FLOWISE_SECRETKEY_OVERWRITE}
             - LOG_LEVEL=${LOG_LEVEL}
             - LOG_PATH=${LOG_PATH}
+            - DISABLE_FLOWISE_TELEMETRY=${DISABLE_FLOWISE_TELEMETRY}
         ports:
             - '${PORT}:${PORT}'
         volumes:

diff --git a/packages/server/.env.example b/packages/server/.env.example
@@ -26,3 +26,5 @@ PORT=3000
 # LANGCHAIN_ENDPOINT=https://api.smith.langchain.com
 # LANGCHAIN_API_KEY=your_api_key
 # LANGCHAIN_PROJECT=your_project
+
+# DISABLE_FLOWISE_TELEMETRY=true
diff --git a/packages/server/src/commands/start.ts b/packages/server/src/commands/start.ts
@@ -39,7 +39,8 @@ export default class Start extends Command {
         LANGCHAIN_TRACING_V2: Flags.string(),
         LANGCHAIN_ENDPOINT: Flags.string(),
         LANGCHAIN_API_KEY: Flags.string(),
-        LANGCHAIN_PROJECT: Flags.string()
+        LANGCHAIN_PROJECT: Flags.string(),
+        DISABLE_FLOWISE_TELEMETRY: Flags.string()
     }
 
     async stopProcess() {
@@ -113,6 +114,9 @@ export default class Start extends Command {
         if (flags.LANGCHAIN_API_KEY) process.env.LANGCHAIN_API_KEY = flags.LANGCHAIN_API_KEY
         if (flags.LANGCHAIN_PROJECT) process.env.LANGCHAIN_PROJECT = flags.LANGCHAIN_PROJECT
 
+        // Telemetry
+        if (flags.DISABLE_FLOWISE_TELEMETRY) process.env.DISABLE_FLOWISE_TELEMETRY = flags.DISABLE_FLOWISE_TELEMETRY
+
         await (async () => {
             try {
                 logger.info('Starting Flowise...')