Update .env.example

Signed-off-by: 熊鑫伟 Xinwei Xiong <[email protected]>
telepace · Jan 7, 2025 · 3294798 · 3294798
1 parent 7ddb0f2
commit 3294798
Showing 1 changed file with 52 additions and 39 deletions.
diff --git a/.env.example b/.env.example
@@ -1,43 +1,56 @@
-# MinIO 配置
-VOICEFLOW_MINIO_ENDPOINT='s3.api..cc'      # MinIO 服务地址
-VOICEFLOW_MINIO_ACCESS_KEY=''        # MinIO 访问密钥
-VOICEFLOW_MINIO_SECRET_KEY=''        # MinIO 密钥
-
-# Azure 配置
-VOICEFLOW_AZURE_STT_KEY=''          # Azure STT 密钥
-VOICEFLOW_AZURE_TTS_KEY=''          # Azure TTS 密钥
-VOICEFLOW_AZURE_SPEECH_KEY=''                        # Azure 语音密钥
-VOICEFLOW_AZURE_REGION='japaneast'  # Azure 区域
-
-# AWS 配置
-VOICEFLOW_AWS_SECRET_ACCESS_KEY=''   # AWS 秘密访问密钥
-VOICEFLOW_AWS_ACCESS_KEY_ID=''       # AWS 访问密钥 ID
-
-# Google 配置
-VOICEFLOW_GOOGLE_STT_KEY=''          # Google STT 密钥
-VOICEFLOW_GOOGLE_TTS_KEY=''          # Google TTS 密钥
-
-# OpenAI 配置
-VOICEFLOW_OPENAI_API_KEY=''          # OpenAI API 密钥
-VOICEFLOW_OPENAI_BASE_URL=''         # OpenAI 基础 URL
-
-# AssemblyAI 配置
-VOICEFLOW_ASSEMBLYAI_API_KEY=''      # AssemblyAI API 密钥
-
-# VOLCENGINE STT 配置
+# ========================================
+# Configuration File for VOICEFLOW Services
+# ========================================
+# This configuration file includes setup parameters for various cloud services. 
+# Ensure that sensitive keys are stored securely and avoid committing them to public repositories.
+
+# MinIO Configuration
+# Documentation: https://min.io/docs/
+VOICEFLOW_MINIO_ENDPOINT='s3.api..cc'        # MinIO server address
+VOICEFLOW_MINIO_ACCESS_KEY=''                # MinIO access key
+VOICEFLOW_MINIO_SECRET_KEY=''                # MinIO secret key
+
+# Azure Configuration
+# Documentation: https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/
+VOICEFLOW_AZURE_STT_KEY=''                   # Azure Speech-to-Text (STT) key
+VOICEFLOW_AZURE_TTS_KEY=''                   # Azure Text-to-Speech (TTS) key
+VOICEFLOW_AZURE_SPEECH_KEY=''                # Azure Speech Service key
+VOICEFLOW_AZURE_REGION='japaneast'           # Azure region (e.g., 'japaneast', 'westus')
+
+# AWS Configuration
+# Documentation: https://docs.aws.amazon.com/iam/latest/UserGuide/id_credentials_access-keys.html
+VOICEFLOW_AWS_ACCESS_KEY_ID=''               # AWS access key ID
+VOICEFLOW_AWS_SECRET_ACCESS_KEY=''           # AWS secret access key
+
+# Google Cloud Configuration
+# Documentation: https://cloud.google.com/speech-to-text/docs/
+VOICEFLOW_GOOGLE_STT_KEY=''                  # Google STT key
+VOICEFLOW_GOOGLE_TTS_KEY=''                  # Google TTS key
+
+# OpenAI Configuration
+# Documentation: https://platform.openai.com/docs/
+VOICEFLOW_OPENAI_API_KEY=''                  # OpenAI API key
+VOICEFLOW_OPENAI_BASE_URL=''                 # OpenAI base URL (if custom endpoint is used)
+
+# AssemblyAI Configuration
+# Documentation: https://www.assemblyai.com/docs/
+VOICEFLOW_ASSEMBLYAI_API_KEY=''              # AssemblyAI API key
+
+# VOLCENGINE Configuration for Speech Services
+# Documentation: https://www.volcengine.com/docs/6358/70338
 VOICEFLOW_VOLCENGINE_STT_WS_URL='wss://openspeech.bytedance.com/api/v3/sauc/bigmodel'  # STT WebSocket URL
-VOICEFLOW_VOLCENGINE_STT_ACCESS_KEY=''                                                   # STT 访问密钥
-VOICEFLOW_VOLCENGINE_STT_APP_KEY=''                                                      # STT 应用密钥
+VOICEFLOW_VOLCENGINE_STT_ACCESS_KEY=''                                               # STT access key
+VOICEFLOW_VOLCENGINE_STT_APP_KEY=''                                                  # STT application key
 
-# VOLCENGINE TTS 配置
-VOICEFLOW_VOLCENGINE_TTS_WS_URL='wss://openspeech.bytedance.com/api/v1/tts/ws_binary'   # TTS WebSocket URL
-VOICEFLOW_VOLCENGINE_TTS_APP_ID=''                                                       # TTS 应用ID
-VOICEFLOW_VOLCENGINE_TTS_TOKEN=''                                                        # TTS 令牌
+VOICEFLOW_VOLCENGINE_TTS_WS_URL='wss://openspeech.bytedance.com/api/v1/tts/ws_binary' # TTS WebSocket URL
+VOICEFLOW_VOLCENGINE_TTS_APP_ID=''                                                   # TTS application ID
+VOICEFLOW_VOLCENGINE_TTS_TOKEN=''                                                    # TTS token
 
-# 语音服务端口配置
-VOICEFLOW_SERVER_PORT=18080           # 语音服务端口
+# Server Configuration
+# Ensure the server port does not conflict with other services.
+VOICEFLOW_SERVER_PORT=18080                   # Voice service server port
 
-# Whisper 配置
-# https://fireworks.ai/dashboard/models/getting-started
-VOICEFLOW_WHISPER_API_KEY=''
-VOICEFLOW_WHISPER_ENDPOINT="https://audio-turbo.us-virginia-1.direct.fireworks.ai/v1/audio/transcriptions"
+# Whisper API Configuration
+# Documentation: https://fireworks.ai/dashboard/models/getting-started
+VOICEFLOW_WHISPER_API_KEY=''                  # Whisper API key
+VOICEFLOW_WHISPER_ENDPOINT='https://audio-turbo.us-virginia-1.direct.fireworks.ai/v1/audio/transcriptions'  # API endpoint