Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 32 additions & 30 deletions apps/coze/.env
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
W9_REPO="cozedev/coze-studio-web"
W9_DIST=community
W9_VERSION="latest"

W9_POWER_PASSWORD="1PrMxExC45LsCT"
W9_DIST='community'
W9_VERSION='latest'
W9_POWER_PASSWORD='o91DD8ys!I7p10ZQ'

# Environments which for user settings when create application
# Named expression: W9_xxx_xxx_SET, xxx refer to file fields
W9_HTTP_PORT_SET=9001
W9_HTTP_PORT_SET='9001'

# Model Configuration - Users can configure their AI model provider
W9_MODEL_PROTOCOL_SET="ark"
W9_MODEL_NAME_SET=""
W9_MODEL_ID_SET=""
W9_MODEL_API_KEY_SET=""
W9_MODEL_BASE_URL_SET=""
W9_MODEL_PROTOCOL_SET='ark'
W9_MODEL_NAME_SET='deepseek-reasoner'
W9_MODEL_ID_SET='deepseek-reasoner'
W9_MODEL_API_KEY_SET='sk-be9b46a22a19470681173e9417676b2d'
W9_MODEL_BASE_URL_SET='https://api.deepseek.com'

#### -- Not allowed to edit below environments when recreate app based on existing data -- ####

W9_ID=coze
W9_ID='coze'

# W9_HTTP_PORT or W9_HTTPS_PORT is need at leaset and used for proxy for web application
W9_HTTP_PORT=80
Expand All @@ -29,7 +27,7 @@ W9_LOGIN_PASSWORD=$W9_POWER_PASSWORD
W9_DB_EXPOSE="mysql,redis,elasticsearch,minio,etcd,milvus"

# It is used when the application APP needs to set an external URL, which can be IP(or domain), IP:PORT
W9_URL=internet_ip:$W9_HTTP_PORT_SET
W9_URL='internet_ip:$W9_HTTP_PORT_SET'

W9_NETWORK=websoft9

Expand All @@ -46,44 +44,48 @@ SERVER_HOST="http://$W9_ID-server:8888"
MYSQL_DATABASE="opencoze"
MYSQL_USER="coze"
MYSQL_PASSWORD=$W9_POWER_PASSWORD
MYSQL_ROOT_PASSWORD=$W9_POWER_PASSWORD
MYSQL_HOST="$W9_ID-mysql"
MYSQL_PORT="3306"
MYSQL_DSN="${MYSQL_USER}:${MYSQL_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/${MYSQL_DATABASE}?charset=utf8mb4&parseTime=True"
ATLAS_URL="mysql://${MYSQL_USER}:${MYSQL_PASSWORD}@${MYSQL_HOST}:${MYSQL_PORT}/${MYSQL_DATABASE}?charset=utf8mb4&parseTime=True"

# Redis
REDIS_ADDR="$W9_ID-redis:6379"
REDIS_PASSWORD=""
REDIS_ADDR="redis:6379"

# Elasticsearch
ES_ADDR="http://$W9_ID-elasticsearch:9200"
ES_ADDR="http://elasticsearch:9200"
ES_VERSION="v8"
ES_USERNAME=""
ES_PASSWORD=""

# Storage - MinIO
FILE_UPLOAD_COMPONENT_TYPE="storage"
STORAGE_TYPE="minio"
STORAGE_UPLOAD_HTTP_SCHEME="http"
STORAGE_BUCKET="opencoze"
MINIO_ROOT_USER="minioadmin"
MINIO_ROOT_PASSWORD=$W9_POWER_PASSWORD
MINIO_DEFAULT_BUCKETS="milvus"
MINIO_ENDPOINT="$W9_ID-minio:9000"
MINIO_AK=$MINIO_ROOT_USER
MINIO_SK=$MINIO_ROOT_PASSWORD
MINIO_ENDPOINT="minio:9000"
MINIO_API_HOST="http://${MINIO_ENDPOINT}"
export MINIO_USE_SSL=false

# Vector Store - Milvus
VECTOR_STORE_TYPE="milvus"
MILVUS_ADDR="$W9_ID-milvus:19530"
MILVUS_ADDR="milvus:19530"

# Message Queue - NSQ
COZE_MQ_TYPE="nsq"
MQ_NAME_SERVER="$W9_ID-nsqd:4150"
MQ_NAME_SERVER="nsqd:4150"

# Embedding Configuration (required for knowledge base)
# Users need to configure at least one embedding provider
EMBEDDING_TYPE="ark"
ARK_EMBEDDING_BASE_URL="${W9_ARK_EMBEDDING_BASE_URL:-}"
ARK_EMBEDDING_MODEL="${W9_ARK_EMBEDDING_MODEL:-}"
ARK_EMBEDDING_API_KEY="${W9_ARK_EMBEDDING_API_KEY:-}"
ARK_EMBEDDING_DIMS="${W9_ARK_EMBEDDING_DIMS:-2048}"
ARK_EMBEDDING_BASE_URL="" # (string, required) Ark embedding base_url
ARK_EMBEDDING_MODEL="" # (string, required) Ark embedding model
ARK_EMBEDDING_API_KEY="" # (string, required) Ark embedding api_key
ARK_EMBEDDING_DIMS="2048" # (int, required) Ark embedding dimensions
ARK_EMBEDDING_API_TYPE="" # (string, optional) Ark embedding api type, should be "text_api" / "multi_modal_api". Default "text_api".

# Model Configuration for Agent & Workflow
MODEL_PROTOCOL_0="${W9_MODEL_PROTOCOL_SET:-ark}"
Expand All @@ -95,9 +97,9 @@ MODEL_BASE_URL_0="${W9_MODEL_BASE_URL_SET:-}"

# Built-in Chat Model for Knowledge Base
BUILTIN_CM_TYPE="ark"
BUILTIN_CM_ARK_API_KEY="${W9_MODEL_API_KEY_SET:-}"
BUILTIN_CM_ARK_MODEL="${W9_MODEL_ID_SET:-}"
BUILTIN_CM_ARK_BASE_URL="${W9_MODEL_BASE_URL_SET:-}"
BUILTIN_CM_ARK_API_KEY=""
BUILTIN_CM_ARK_MODEL=""
BUILTIN_CM_ARK_BASE_URL=""

# Code Runner
CODE_RUNNER_TYPE="sandbox"
Expand All @@ -106,4 +108,4 @@ CODE_RUNNER_ALLOW_NET="cdn.jsdelivr.net"
# Plugin Security
PLUGIN_AES_AUTH_SECRET='^*6x3hdu2nc%-p38'
PLUGIN_AES_STATE_SECRET='osj^kfhsd*(z!sno'
PLUGIN_AES_OAUTH_TOKEN_SECRET='cn+$PJ(HhJ[5d*z9'
PLUGIN_AES_OAUTH_TOKEN_SECRET='cn+$PJ(HhJ[5d*z9'
111 changes: 49 additions & 62 deletions apps/coze/Notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,74 +4,61 @@

### Required Configuration

Before using Coze Studio, you **must** configure at least one AI model provider:

1. **For Agent & Workflow**: Configure the model settings via environment variables:
- `W9_MODEL_PROTOCOL_SET`: Model protocol (e.g., "ark", "openai", "ollama")
- `W9_MODEL_NAME_SET`: Display name for the model
- `W9_MODEL_ID_SET`: Model ID for API calls
- `W9_MODEL_API_KEY_SET`: API key for authentication
- `W9_MODEL_BASE_URL_SET`: Base URL for the model API

2. **For Knowledge Base (Embedding)**: Configure embedding settings:
- `EMBEDDING_TYPE`: Type of embedding provider (ark/openai/ollama/gemini)
- Provider-specific settings (API key, base URL, model name, dimensions)

### Supported Model Providers

- **Ark (ByteDance/Volcengine)**: Recommended for best compatibility
- **OpenAI**: Including Azure OpenAI
- **Ollama**: For local model deployment
- **Gemini**: Google's AI models
- **DeepSeek**: Alternative AI provider
- **Qwen**: Alibaba's AI models
在使用coze之前,你需要提供至少一个AI模型供应商:

1. **适用于代理和工作流**:通过环境变量配置模型设置:
- `W9_MODEL_PROTOCOL_SET`: 模型协议 (如: "ark", "openai", "ollama")
- `W9_MODEL_NAME_SET`: 模型显示名称
- `W9_MODEL_ID_SET`: 用于 API 调用的模型 ID
- `W9_MODEL_API_KEY_SET`: 用于认证的 API 密钥
- `W9_MODEL_BASE_URL_SET`: 模型 API 的基础 URL
(以上配置在安装前会被要求输入,并且代入到以下配置:)
```
MODEL_PROTOCOL_0="${W9_MODEL_PROTOCOL_SET:-ark}"
MODEL_OPENCOZE_ID_0="100001"
MODEL_NAME_0="${W9_MODEL_NAME_SET:-}"
MODEL_ID_0="${W9_MODEL_ID_SET:-}"
MODEL_API_KEY_0="${W9_MODEL_API_KEY_SET:-}"
MODEL_BASE_URL_0="${W9_MODEL_BASE_URL_SET:-}"
```
(你可以通过复制并修改后面的数字以及内容来配置多个模型)


2. **用于知识库(嵌入)**:配置嵌入设置:
- `EMBEDDING_TYPE`: 嵌入提供商类型 (ark/openai/ollama/gemini)
- 特定于提供商的设置 (API key, base URL, model name, dimensions)

### 支持的模型提供商

- **Ark (ByteDance/Volcengine)**: 推荐以获得最佳兼容性
- **OpenAI**: 包括 Azure OpenAI
- **Ollama**: 用于本地模型部署
- **Gemini**: 谷歌的人工智能模型
- **DeepSeek**
- **Qwen**: 阿里巴巴的AI模型

## FAQ

### How to access Coze Studio?

After deployment, access the web interface at: `http://your-server-ip:9001`

### How to configure models?

1. Go to the application environment variables
2. Update the model configuration variables (W9_MODEL_*)
3. Restart the application

### What are the minimum system requirements?

- CPU: 4 cores
- Memory: 8 GB
- Disk: 20 GB
- Recommended: 8 cores, 16 GB memory for production use

### How to enable SSL/HTTPS?

Configure through Websoft9's proxy manager (Nginx Proxy Manager).

### How to backup data?
### 怎么配置模型?

Backup the following Docker volumes:
- mysql_data
- redis_data
- elasticsearch_data
- minio_data
- etcd_data
- milvus_data
1. 在应用页面点击编排-马上修改,进入.env文件
2. 修改模型配置相关变量 (W9_MODEL_*)
3. 重建应用

### Troubleshooting
### 故障排查

**Service not starting:**
- Check if all required environment variables are configured
- Verify Docker has enough resources allocated
- Check logs: `docker logs coze-server`
**服务没有启动:**
- 检查所有必需的环境变量是否已配置
- 验证 Docker 是否分配了足够的资源
- 检查日志: `docker logs coze_{ID}-server`

**Knowledge base not working:**
- Ensure embedding configuration is properly set
- Verify the embedding API key is valid
- Check Milvus and Elasticsearch are running
**知识库无法使用:**
- 确保嵌入配置设置正确
- 验证嵌入式 API 密钥是否有效
- 检查 Milvus Elasticsearch 是否正在运行

**Model not responding:**
- Verify model API key and base URL
- Check network connectivity to model provider
- Review server logs for error messages
**模型无响应:**
- 验证模型 API 密钥和基础 URL
- 检查与模型提供商的网络连接
- 查看服务器日志中的错误信息
Loading