跳到主要内容

快速开始

前置依赖

  • Nodejs 20^
  • MySQL 8.0^
  • Redis

安装

1.全局安装 Treadstone CLI 命令行工具:

npm install -g treadstone-cli

2. 将 Treadstone 安装到当前文件夹:

stone install --verison standard

3. 安装依赖:

cd treadstone-standard && npm install

4. 配置全局变量文件:

  • 将 DATABASE_URL、REDIS_URL 分别改为你的 MySQL、Redis 数据库链接地址;
  • JWT_SECRET 是 JWT 密钥,安装时会随机初始化一个,建议自行更换。如果使用 Treadstone 提供的单点登录、统一鉴权,请保证其他需要鉴权的后端应用 JWT 密钥与 Treadstone 的 JWT 密钥一致。
  • 组织密钥获取方式参考获取组织密钥
.env
# MySQL
DATABASE_URL="mysql://USERNAME:PASSWORD@HOST:PORT/DATABASE"
# Redis
REDIS_URL="redis://USERNAME:PASSWORD@HOST:PORT"

PORT=9000

# JWT配置
JWT_EXPIRED="7 days"
JWT_SECRET="<YOUR_JWT_SECRET>"

# 组织ID及组织密钥可在Treadstone官网生成
TREADSTONE_ORG_ID="YOUR_TREADSTONE_ORG_ID"
TREADSTONE_ORG_SECRET="YOUR_TREADSTONE_ORG_SECRET"

# 如需接入钉钉同步组织架构/钉钉扫码登录,请添加以下配置:
# ASSOCIATION_PLATFORM="DINGTALK"
# DINGTALK_APP_KEY="YOUR_DINGTALK_APP_KEY"
# DINGTALK_APP_SECRET="YOUR_DINGTALK_APP_SECRET"

# 如需接入企业微信同步组织架构/企业微信扫码登录,请添加以下配置:
# ASSOCIATION_PLATFORM="WEWORK"
# WEWORK_CORP_ID="YOUR_WEWORK_CORP_ID"
# WEWORK_CORP_SECRET="YOUR_WEWORK_CORP_SECRET"

5. 配置完全局变量之后,执行数据库初始化:

npx prisma migrate deploy

6. 全局安装 PM2:

npm i -g pm2

7. 运行 Treadstone:

pm2 start ecosystem.config.js --env=production

8. 运行后,修改 treadstone-cli 服务指向:

# <YOUR_TREADSTONE_URL>改为你的私有化Treadstone服务运行地址。如:http://localhost:9000
stone config set --registry <YOUR_TREADSTONE_URL>

9. 初始化组织名称及管理员账号:

stone createsuperuser

10. 浏览器打开私有化部署后的 treadstone,使用刚才初始化的管理员账号登录即可。默认:http://localhost:9000