Scan to contactarticle
README
🚀 如何在本地和 Vercel 平台安装与部署 HiveChat 系统
本指南将详细介绍如何在本地环境安装 HiveChat 系统，以及如何将其部署到 Vercel 平台，同时包含第三方登录配置说明和注意事项。
🚀 快速开始
📦 本地安装步骤
1. 安装 PostgreSQL 数据库
- 下载并安装 PostgreSQL（推荐版本：12 或更高）。
- 创建一个新的数据库，例如
hivechat。 - 将以下环境变量填入
.env文件：
DATABASE_URL=postgres://username:password@localhost/hivechat
2. 配置环境变量
在项目根目录下创建一个 .env 文件，并添加以下内容（请根据实际值替换占位符）：
# 数据库连接 URL
DATABASE_URL=postgres://username:password@localhost/hivechat
# 加密密钥
AUTH_SECRET=hclqD3nBpMphLevxGWsUnGU6BaEa2TjrCQ77weOVpPg=
# 管理员授权码
ADMIN_CODE=22113344
# 生产环境域名（请根据实际域名填写）
NEXTAUTH_URL=http://localhost:3000
# 邮箱登录开关
EMAIL_AUTH_STATUS=ON
# 第三方登录配置（请根据实际情况填写）
FEISHU_AUTH_STATUS=OFF
FEISHU_CLIENT_ID=cli_xxxxxxxxxxxxxxxx
FEISHU_CLIENT_SECRET=xxxxxxxxHOEWIoE7eDc1Lhc0042OXXXX
WECOM_AUTH_STATUS=OFF
WECOM_CLIENT_ID=ww728c371c2fXXXXXX
WECOM_AGENT_ID=100XXXX
WECOM_CLIENT_SECRET=H-7J4jzG0m1axpXLGshaCDlMOZxdjvkX6bIVLuXXXXXX
DINGTALK_AUTH_STATUS=OFF
DINGTALK_CLIENT_ID=dingpcfi2kpuplXXXXXX
DINGTALK_CLIENT_SECRET=3vk9-VFCExNckqNUk_CL2F-HEgz7qGN-BimH0lZ1g_an2lnkk6XXXXXX
3. 启动系统
在终端中运行以下命令：
npm install
npm run dev
启动完成后，访问 http://localhost:3000/setup 进行管理员账号设置。
🚀 Vercel 平台部署步骤
1. 创建 Neon 数据库
- 登录 Vercel 控制台，在顶部导航栏选择「Storage」标签，点击「Create Database」。
- 选择「Neon (Serverless Postgres)」并完成创建。
2. 配置环境变量
在项目设置中填写以下环境变量（请根据实际情况填写）：
# 数据库连接 URL（从 Neon 控制台获取）
DATABASE_URL=postgres://postgres:password@localhost/hivechat
# 加密密钥
AUTH_SECRET=hclqD3nBpMphLevxGWsUnGU6BaEa2TjrCQ77weOVpPg=
# 管理员授权码
ADMIN_CODE=22113344
# 生产环境域名（请根据实际域名填写）
NEXTAUTH_URL=http://localhost:3000
# 邮箱登录开关
EMAIL_AUTH_STATUS=ON
# 第三方登录配置（请根据实际情况填写）
FEISHU_AUTH_STATUS=OFF
FEISHU_CLIENT_ID=cli_xxxxxxxxxxxxxxxx
FEISHU_CLIENT_SECRET=xxxxxxxxHOEWIoE7eDc1Lhc0042OXXXX
WECOM_AUTH_STATUS=OFF
WECOM_CLIENT_ID=ww728c371c2fXXXXXX
WECOM_AGENT_ID=100XXXX
WECOM_CLIENT_SECRET=H-7J4jzG0m1axpXLGshaCDlMOZxdjvkX6bIVLuXXXXXX
DINGTALK_AUTH_STATUS=OFF
DINGTALK_CLIENT_ID=dingpcfi2kpuplXXXXXX
DINGTALK_CLIENT_SECRET=3vk9-VFCExNckqNUk_CL2F-HEgz7qGN-BimH0lZ1g_an2lnkk6XXXXXX
3. 部署系统
完成上述配置后，推送到代码仓库并触发 Vercel 自动部署。
🔌 第三方登录配置说明
1. 微信企业版（WECOM）
- 登录微信企业版后台，创建应用并获取
Client ID和Client Secret。 - 将这些值填入环境变量中：
WECOM_AUTH_STATUS=ON
WECOM_CLIENT_ID=ww728c371c2fXXXXXX
WECOM_AGENT_ID=100XXXX
WECOM_CLIENT_SECRET=H-7J4jzG0m1axpXLGshaCDlMOZxdjvkX6bIVLuXXXXXX
2. 飞书（DINGTALK）
- 登录飞书开发者后台，创建应用并获取
Client ID和Client Secret。 - 将这些值填入环境变量中：
DINGTALK_AUTH_STATUS=ON
DINGTALK_CLIENT_ID=dingpcfi2kpuplXXXXXX
DINGTALK_CLIENT_SECRET=3vk9-VFCExNckqNUk_CL2F-HEgz7qGN-BimH0lZ1g_an2lnkk6XXXXXX
⚠️ 注意事项
⚠️ 重要提示
- 确保所有环境变量值正确无误。
- 定期备份数据库以防止数据丢失。
- 部署完成后，建议测试各项功能（例如：管理员登录、第三方登录等）。
如果有任何问题，请参考 官方文档 或联系技术支持。