Documentation

环境变量配置

通过环境变量配置项目,即可启用所有必需的第三方集成服务

环境变量系统介绍

VibeAny 配置环境变量有两种方式:

  1. 通过环境变量文件配置,对于一些不常变化的环境变量,可以配置在环境变量文件中,比如数据库连接URL、鉴权密钥等。
  2. 通过后台配置面板配置,对于一些常变化的环境变量,VibeAny 为你提供动态配置面板,你可以在后台配置面板中随时修改环境变量,比如支付密钥、邮件服务器配置等。

通过环境变量文件配置

站点链接配置

变量描述
VITE_APP_URL站点URL

数据库

在数据库设置文档中查看更加详细的配置说明

变量描述
DATABASE_URL数据库连接 URL

身份鉴权

在身份鉴权设置文档中查看更加详细的配置说明

变量描述
ADMIN_EMAILS管理员邮箱
BETTER_AUTH_SECRET鉴权密钥
BETTER_AUTH_URL鉴权URL

BETTER_AUTH_SECRET 可以在 better-auth 官网生成,或者点击下方按钮生成:

如果你想使用OAuth(支持github或者谷歌登入),可以继续配置如下内容

变量描述
GITHUB_CLIENT_IDGitHub OAuth 客户端 ID
GITHUB_CLIENT_SECRETGitHub OAuth 客户端密钥
GOOGLE_CLIENT_IDGoogle OAuth 客户端 ID
GOOGLE_CLIENT_SECRETGoogle OAuth 客户端密钥

TURNSTILE

VibeAny 使用 TURNSTILE 作为验证码服务,为你的网站启用验证码保护,你需要在 TURNSTILE 官网注册一个账号,并创建一个站点,获取到站点密钥。在验证码设置文档中查看更加详细的配置说明

变量描述
TURNSTILE_SECRET_KEYTURNSTILE 密钥,可以在 Cloudflare 仪表盘生成
VITE_TURNSTILE_SITE_KEYTURNSTILE 站点密钥,可以在 Cloudflare 仪表盘获取
VITE_TURNSTILE_CAPTCHA_ENABLEDTURNSTILE 验证码是否启用,true 时启用,false 时禁用

邮件

你可以使用Resend服务,也可以使用自定义邮件服务器,VibeAny 推荐您使用 resend 服务,在邮件设置文档中查看更加详细的配置说明。

邮箱验证默认关闭,需要配置邮件服务以便用户完成账号验证:

EMAIL_VERIFICATION_ENABLED=false

对于 Resend 服务,你需要在 Resend 创建一个 API 密钥。

变量描述
EMAIL_PROVIDER邮件服务商,resendcustom
EMAIL_FROM发件人邮箱,例如:VibeAny <[email protected]>
RESEND_API_KEYresend 服务 API 密钥

对于自定义邮件服务器,你需要配置以下环境变量,具体请查阅对应邮箱服务商的文档:

变量描述
EMAIL_HOST邮件服务器主机
EMAIL_ADDRESS发件人邮箱
EMAIL_USER发件人用户名
EMAIL_PASSWORD发件人密码

支付

在支付设置文档中查看更加详细的配置说明

Stripe 服务

变量描述
VITE_STRIPE_PUBLISHABLE_KEYStripe 服务 publishable 密钥
STRIPE_SECRET_KEYStripe 服务 API 密钥
STRIPE_WEBHOOK_SECRETStripe 服务 webhook 密钥
VITE_STRIPE_PRO_MONTHLY_PRICE_IDStripe 服务 pro 每月价格 ID
VITE_STRIPE_PRO_YEARLY_PRICE_IDStripe 服务 pro 每年价格 ID
VITE_STRIPE_LIFETIME_PRICE_IDStripe 服务 lifetime 价格 ID

Creem 服务

变量描述
CREEM_X_API_KEYCreem 服务 API 密钥
CREEM_TEST_MODECreem 服务测试模式,true 时启用,false 时禁用
CREEM_WEBHOOK_SECRETCreem 服务 webhook 密钥
VITE_CREEM_PRO_MONTHLY_PRODUCT_IDCreem 服务 pro 每月产品 ID
VITE_CREEM_LIFETIME_PRODUCT_IDCreem 服务 lifetime 产品 ID

积分

VibeAny 为了简化开发者的配置,将积分系统优先集成到了后台中,开发者可以在后台配置面板中随时修改积分系统配置,比如积分赠送数量、积分有效期等,在积分设置文档中查看更加详细的配置说明,

存储

在存储设置文档中查看更加详细的配置说明

变量描述
STORAGE_PROVIDER存储服务商,s3custom
S3_ACCESS_KEYS3 服务 access key
S3_SECRET_KEYS3 服务 secret key
S3_REGIONS3 服务 region
S3_BUCKETS3 服务 bucket

通过后台配置面板配置

VibeAny 提供了动态配置面板,你可以在后台随时修改以下配置,无需重启服务。

优先级说明

环境变量文件中的配置优先级高于后台配置面板:

  • 服务端配置:如果 .env 中配置了 STRIPE_SECRET_KEY=sk_xxx,后台面板中的 payment_stripe_secret_key 将被忽略
  • 客户端配置(public_ 前缀):如果 .env 中配置了 VITE_CREDIT_ENABLE=true,后台面板中的 public_credit_enable 将被忽略

Environment Variables

支付

在后台可以选择使用的支付服务商:stripecreempaypalwechatalipay

Stripe

配置项环境变量
Stripe Secret KeySTRIPE_SECRET_KEY
Stripe Webhook SecretSTRIPE_WEBHOOK_SECRET

Creem

配置项环境变量
Creem X API KeyCREEM_X_API_KEY
Creem Test ModeCREEM_TEST_MODE
Creem Webhook SecretCREEM_WEBHOOK_SECRET

PayPal

配置项环境变量
PayPal Client IDPAYPAL_CLIENT_ID
PayPal Client SecretPAYPAL_CLIENT_SECRET
PayPal Webhook IDPAYPAL_WEBHOOK_ID
PayPal 沙盒模式PAYPAL_SANDBOX

微信支付

配置项环境变量
微信 App IDWECHAT_APP_ID
微信商户号WECHAT_MCH_ID
微信 API 密钥WECHAT_API_KEY
微信 API v3 密钥WECHAT_API_V3_KEY
微信证书序列号WECHAT_SERIAL_NO
微信私钥WECHAT_PRIVATE_KEY

支付宝

配置项环境变量
支付宝 App IDALIPAY_APP_ID
支付宝应用私钥ALIPAY_PRIVATE_KEY
支付宝公钥ALIPAY_PUBLIC_KEY
支付宝沙盒模式ALIPAY_SANDBOX

积分

基础配置

配置项环境变量默认值
启用积分系统VITE_CREDIT_ENABLEfalse
允许免费用户购买VITE_CREDIT_ALLOW_FREE_USER_PURCHASEfalse

注册赠送

配置项环境变量默认值
启用注册赠送VITE_CREDIT_SIGNUP_BONUS_ENABLEDfalse
注册赠送数量VITE_CREDIT_SIGNUP_BONUS_AMOUNT0
赠送积分有效期(天)VITE_CREDIT_SIGNUP_BONUS_EXPIRE_DAYS30

每日赠送

配置项环境变量默认值
启用每日赠送VITE_CREDIT_DAILY_ENABLEDfalse
每日赠送积分数量VITE_CREDIT_DAILY_AMOUNT0

邮件

配置项环境变量默认值
邮件服务商EMAIL_PROVIDERresend
发件邮箱EMAIL_FROM-
Resend API KeyRESEND_API_KEY-

存储

VibeAny 支持 S3 兼容的存储服务(如 AWS S3、Cloudflare R2、MinIO 等)。

配置项环境变量默认值
存储区域STORAGE_REGIONauto
存储桶名称STORAGE_BUCKET_NAME-
Access Key IDSTORAGE_ACCESS_KEY_ID-
Secret Access KeySTORAGE_SECRET_ACCESS_KEY-
存储端点STORAGE_ENDPOINT-
公开访问 URLSTORAGE_PUBLIC_URL-

目录