Skip to content

配置说明

API 服务器

以下是 API 服务器的详细配置说明。你可以将这些环境变量注入到 refly_api 容器中。

基本配置

环境变量说明默认值
NODE_ENVNode 运行环境development
PORTHTTP API 服务端口,用于常规 API 请求5800
WS_PORTWebSocket 服务器端口,用于画布和文档的实时同步5801
ORIGIN客户端来源(即访问 Refly 应用的地址),用于 CORS 检查http://localhost:5700
STATIC_ENDPOINT静态文件端点,用于提供静态文件服务http://localhost:5800/v1/misc/

凭证配置

环境变量说明默认值
OPENAI_API_KEYOpenAI API 密钥,用于 LLM 推理和嵌入(未设置)
OPENROUTER_API_KEYOpenRouter API 密钥,用于 LLM 推理(未设置)
JINA_API_KEYJina API 密钥,用于嵌入(未设置)
FIREWORKS_API_KEYFireworks API 密钥,用于嵌入(未设置)
SERPER_API_KEYSerper API 密钥,用于在线搜索(未设置)

中间件

Refly 依赖以下中间件来正常运行:

  • Postgres:用于基本数据持久化
  • Redis:用于缓存、异步任务队列和分布式环境中的协调
  • Qdrant:用于通过嵌入进行语义搜索
  • Elasticsearch:用于工作区内的全文搜索
  • MinIO:用于画布、文档和资源数据的对象存储

Postgres

环境变量说明默认值
DATABASE_URLPostgreSQL 连接 URLpostgresql://refly:test@localhost:5432/refly?schema=refly

INFO

参考 Prisma 文档 了解连接 URL 的详细定义。

Redis

环境变量说明默认值
REDIS_HOSTRedis 主机地址localhost
REDIS_PORTRedis 端口6379
REDIS_PASSWORDRedis 密码test

Qdrant (向量存储)

环境变量说明默认值
QDRANT_HOSTQdrant 主机地址localhost
QDRANT_PORTQdrant 端口6333
QDRANT_API_KEYQdrant API 密钥(未设置)
REFLY_VEC_DIM向量维度大小768

Elasticsearch

环境变量说明默认值
ELASTICSEARCH_URLElasticsearch URLhttp://localhost:9200
ELASTICSEARCH_USERNAMEElasticsearch 用户名(未设置)
ELASTICSEARCH_PASSWORDElasticsearch 密码(未设置)

MinIO

Refly 需要两个 MinIO 实例:

  • 内部:用于存储画布、资源和文档数据,通常设置为私有可见性。
  • 外部:用于存储上传的文件,通常设置为公开可见性。
环境变量说明默认值
MINIO_INTERNAL_ENDPOINT内部数据使用的 MinIO 主机localhost
MINIO_INTERNAL_PORT内部数据使用的 MinIO 端口9000
MINIO_INTERNAL_USE_SSL是否使用 HTTPS 传输false
MINIO_INTERNAL_ACCESS_KEY内部 MinIO 访问密钥minioadmin
MINIO_INTERNAL_SECRET_KEY内部 MinIO 密钥minioadmin
MINIO_INTERNAL_BUCKET内部存储桶名称refly-weblink
MINIO_EXTERNAL_ENDPOINT外部数据使用的 MinIO 主机localhost
MINIO_EXTERNAL_PORT外部数据使用的 MinIO 端口9000
MINIO_EXTERNAL_USE_SSL是否使用 HTTPS 传输false
MINIO_EXTERNAL_ACCESS_KEY外部 MinIO 访问密钥minioadmin
MINIO_EXTERNAL_SECRET_KEY外部 MinIO 密钥minioadmin
MINIO_EXTERNAL_BUCKET外部存储桶名称refly-weblink

认证配置

环境变量说明默认值
AUTH_SKIP_VERIFICATION是否跳过邮箱验证false
REFLY_COOKIE_DOMAIN用于签署认证令牌的 Cookie 域名localhost
LOGIN_REDIRECT_URLOAuth 登录后的重定向 URL(未设置)
JWT_SECRETJWT 签名密钥test
JWT_EXPIRATION_TIMEJWT 访问令牌过期时间1h
JWT_REFRESH_EXPIRATION_TIMEJWT 刷新令牌过期时间7d
COLLAB_TOKEN_EXPIRY协作令牌过期时间1h

INFO

时间格式与 Vercel MS 兼容。

邮箱认证

环境变量说明默认值
EMAIL_AUTH_ENABLED是否启用邮箱认证true
EMAIL_SENDER邮件发送者Refly <[email protected]>
RESEND_API_KEYResend API 密钥,用于发送邮件re_123

WARNING

默认的 RESEND_API_KEY 是无效的(仅作为占位符)。如果需要,请设置你自己的 API 密钥。

GitHub 认证

环境变量说明默认值
GITHUB_AUTH_ENABLED是否启用 GitHub 认证false
GITHUB_CLIENT_IDGitHub OAuth 客户端 IDtest
GITHUB_CLIENT_SECRETGitHub OAuth 客户端密钥test
GITHUB_CALLBACK_URLGitHub OAuth 回调 URLtest

WARNING

默认的 OAuth 凭证是无效的(仅作为占位符)。如果需要,请设置你自己的 GitHub OAuth 凭证。

INFO

你可以在 GitHub Developer 了解更多关于 GitHub OAuth 的信息。

Google 认证

环境变量说明默认值
GOOGLE_AUTH_ENABLED是否启用 Google 认证false
GOOGLE_CLIENT_IDGoogle OAuth 客户端 IDtest
GOOGLE_CLIENT_SECRETGoogle OAuth 客户端密钥test
GOOGLE_CALLBACK_URLGoogle OAuth 回调 URLtest

WARNING

默认的 OAuth 凭证是无效的(仅作为占位符)。如果需要,请设置你自己的 Google OAuth 凭证。

INFO

你可以在 Google Developer 了解更多关于 Google OAuth 的信息。

嵌入配置

环境变量说明默认值
EMBEDDINGS_PROVIDER嵌入提供者(可选 jinafireworksopenaijina
EMBEDDINGS_MODEL_NAME嵌入模型名称jina-embeddings-v3
EMBEDDINGS_DIMENSIONS嵌入向量维度768
EMBEDDINGS_BATCH_SIZE嵌入处理批次大小512

WARNING

默认的 EMBEDDINGS_PROVIDERjina。如果你想使用其他嵌入提供者,请设置相应的环境变量。

WARNING

EMBEDDINGS_DIMENSIONS 必须与 Qdrant 中的 REFLY_VEC_DIM 设置为相同的值。

重排序器

环境变量说明默认值
RERANKER_TOP_N需要重排序的顶部结果数量10
RERANKER_MODEL重排序模型名称jina-reranker-v2-base-multilingual
RERANKER_RELEVANCE_THRESHOLD重排序相关性阈值0.5

WARNING

目前仅支持 Jina 重排序器。你需要设置 JINA_API_KEY 环境变量。

技能执行

环境变量说明默认值
REFLY_DEFAULT_MODEL默认 AI 模型openai/gpt-4o-mini
SKILL_IDLE_TIMEOUT技能空闲超时时间(毫秒)60000
SKILL_EXECUTION_TIMEOUT技能执行超时时间(毫秒)180000

Stripe

环境变量说明默认值
STRIPE_API_KEYStripe API 密钥(未设置)
STRIPE_ACCOUNT_WEBHOOK_SECRETStripe 账户 webhook 密钥test
STRIPE_ACCOUNT_TEST_WEBHOOK_SECRETStripe 测试账户 webhook 密钥test
STRIPE_SESSION_SUCCESS_URLStripe 成功重定向 URL(未设置)
STRIPE_SESSION_CANCEL_URLStripe 取消重定向 URL(未设置)
STRIPE_PORTAL_RETURN_URLStripe 客户门户返回 URL(未设置)

配额

请求配额

环境变量说明默认值
QUOTA_T1_REQUEST一级请求配额-1
QUOTA_T2_REQUEST二级请求配额-1

存储配额

环境变量说明默认值
QUOTA_STORAGE_FILE文件存储配额-1
QUOTA_STORAGE_OBJECT对象存储配额-1
QUOTA_STORAGE_VECTOR向量存储配额-1

Web 前端

以下是 Web 前端的详细配置说明。你可以将这些环境变量注入到 refly_web 容器中。

基本配置

环境变量说明默认值
REFLY_API_URLRefly API 服务器 URLhttp://localhost:5800
COLLAB_URL协作端点 URLhttp://localhost:5801