跳转到内容

环境配置

ShipSaaS 需要一些环境变量才能正常运行,本文档介绍如何逐步设置这些环境变量。

变量 描述
VITE_BASE_URL 网站的 URL,例如 http://localhost:3000 用于开发环境,https://your-domain.com 用于生产环境

Cloudflare 文档中学习如何获取和配置 Token。

变量 描述
CLOUDFLARE_ACCOUNT_ID Cloudflare 账户 ID(用于 Wrangler CLI 和 Cloudflare REST API)
CLOUDFLARE_API_TOKEN Cloudflare API 令牌(用于 Wrangler CLI 和 Cloudflare REST API)

数据库设置文档中学习如何设置数据库。

变量 描述
CLOUDFLARE_DATABASE_ID Cloudflare D1 数据库 ID(用于 Drizzle Kit 远程操作)

存储设置文档中学习如何设置存储。

ShipSaaS 使用 Cloudflare R2 binding 进行存储,无需配置额外的环境变量。

身份验证设置文档中学习如何设置身份验证。

变量 描述
BETTER_AUTH_SECRET 用于哈希令牌和签名 Cookie 的随机字符串
GOOGLE_CLIENT_ID Google OAuth 客户端 ID(可选)
GOOGLE_CLIENT_SECRET Google OAuth 客户端密钥(可选)

邮件设置 文档中学习如何设置邮件功能。

ShipSaaS 支持 ResendCloudflare Email Service 作为邮件服务提供商。

变量 描述
RESEND_API_KEY Resend 邮件服务的 API 密钥

注意: 使用 Resend 时,RESEND_API_KEY 可在邮件模块和邮件订阅模块之间共享。

变量 描述
CLOUDFLARE_ACCOUNT_ID Cloudflare 账户 ID
CLOUDFLARE_API_TOKEN Cloudflare API 令牌,需要具有 Email Sending Write 权限

支付设置文档中学习如何设置支付。

ShipSaaS 支持 StripeCreem 作为支付提供商。

Stripe 设置 文档中学习如何设置 Stripe。

变量 描述
VITE_PAYMENT_PROVIDER 设置为 stripe 以启用 Stripe 支付提供商
STRIPE_SECRET_KEY Stripe 密钥
STRIPE_WEBHOOK_SECRET Stripe Webhook 签名密钥
VITE_STRIPE_PRICE_PRO_MONTHLY 专业计划月度订阅的 Stripe 价格 ID
VITE_STRIPE_PRICE_PRO_YEARLY 专业计划年度订阅的 Stripe 价格 ID
VITE_STRIPE_PRICE_LIFETIME 终身计划的 Stripe 价格 ID

Creem 设置 文档中学习如何设置 Creem。

变量 描述
VITE_PAYMENT_PROVIDER 设置为 creem 以启用 Creem 支付提供商
CREEM_API_KEY Creem API 密钥
CREEM_WEBHOOK_SECRET Creem Webhook 签名密钥
CREEM_DEBUG 设置为 true 以使用 Creem 测试环境(可选)
VITE_CREEM_PRODUCT_PRO_MONTHLY 专业计划月度订阅的 Creem 产品 ID
VITE_CREEM_PRODUCT_PRO_YEARLY 专业计划年度订阅的 Creem 产品 ID
VITE_CREEM_PRODUCT_LIFETIME 终身计划的 Creem 产品 ID

AI 设置 文档中学习如何设置 AI 功能。

变量 描述
FAL_API_KEY fal.ai API 密钥,用于图像生成,请在 fal.ai Dashboard 创建

邮件订阅设置 文档中学习如何设置邮件订阅。

ShipSaaS 支持 ResendBeehiiv 作为邮件订阅服务提供商。

变量 描述
RESEND_API_KEY Resend 邮件订阅服务的 API 密钥(与邮件模块共享)

注意: 使用 Resend 时,RESEND_API_KEY 可在邮件模块和邮件订阅模块之间共享。

变量 描述
BEEHIIV_API_KEY Beehiiv 邮件订阅服务的 API 密钥
BEEHIIV_PUBLICATION_ID Beehiiv 邮件订阅服务的 Publication ID

通知设置文档中学习如何设置通知。

变量 描述
DISCORD_WEBHOOK_URL Discord Webhook URL,用于接收通知
FEISHU_WEBHOOK_URL 飞书 Webhook URL,用于接收通知

统计分析设置文档中学习如何设置统计分析。

变量 描述
VITE_GOOGLE_ANALYTICS_ID Google Analytics ID
VITE_UMAMI_WEBSITE_ID Umami Analytics 网站 ID
VITE_UMAMI_SCRIPT Umami Analytics 脚本 URL
VITE_PLAUSIBLE_SCRIPT Plausible Analytics 脚本 URL
VITE_CLARITY_PROJECT_ID Clarity Analytics 项目 ID

聊天框设置文档中学习如何设置聊天框。

变量 描述
VITE_CRISP_WEBSITE_ID Crisp Chat ID,用于网站在线客服功能

联盟营销设置文档中学习如何设置联盟营销。

变量 描述
VITE_AFFILIATE_AFFONSO_ID Affonso 联盟营销 ID
VITE_AFFILIATE_PROMOTEKIT_ID PromoteKit 联盟营销 ID

要验证环境变量是否正确设置,请运行:

bun run dev

如果一切配置正确,您的应用程序应该可以正常启动并运行,没有任何与环境相关的错误。

现在您的环境已经设置好了,探索这些相关主题: