PHP 8.1 – 8.3
扩展:sodium · redis · pdo_mysql
MySQL 5.7 / 8.0+
utf8mb4 · 双版本内核级兼容
Redis ≥ 5
缓存 · 队列 · 事件异步分发
Linux / 宝塔 / Docker
systemd 守护模板 · Compose 参考
快速开始
三步上线
安装完成即得:平台后台可登录、健康探针全绿、一个可删的示例站点。
01安装
一键脚本拉取程序与依赖。vendor 随包分发,服务器上无需 composer、无需 Node。
$ curl -fsSL https://get.tenraft.dev | bash
✓ 程序就绪 → /www/tenraft
02向导
浏览器打开安装向导:环境检测、数据库与 Redis 配置、平台管理员创建,一路绿灯。
https://your-domain.com/install
✓ 环境检测 6/6 通过 · install.lock 已生成
03启动
一条命令拉起 HTTP、队列、定时任务全部进程。登录平台后台,示例站点已备好。
$ php start.php start -d
✓ 平台后台 → /admin/platform · health 探针全绿
章节目录
文档地图
七个分组、二十五章,按读者的时间线编排:部署方从装完到接第一个客户,店主从进后台到顾客能下单,开发者看扩展开发。知道名字要查,直接翻最后的菜单速查表。
入门
这套框架是什么
一套装在你自己服务器上的小程序 SaaS 框架。本章讲清部署方、租户、站点、顾客这四层怎么套起来,三个后台分别归谁用,以及你该从哪几章读起。
先搞懂五个概念
租户、站点、应用、名额、套餐——Tenraft 的所有操作都围着这五个词转。本章用一家连锁奶茶店开两个门店站点的例子,把它们的关系和流转顺序讲透,尤其是「为什么解绑后名额要冷却」。
安装与部署
按真实的部署顺序走一遍:先备好 PHP、MySQL、Redis,再把服务跑起来,然后用浏览器完成安装向导,最后重启服务并自检。服务器上不需要 Node、npm 或 composer。
第一次使用
装完之后到「第一个客户的小程序能下单」,中间要跨三个后台。本章按时间顺序把这条链路走完:平台方装应用、定卖法、建租户、划名额、建站点;租户方接手账号、加员工;店主完成开店四步,最后把小程序发上线。
平台后台
站点后台
开店:先做这四件事
第一次进站点后台,概览页顶部会给你一张「开始使用」清单:完善站点资料、配置收款方式、装修并发布首页、迎来第一个会员。本章逐步讲清每一步在哪、要填什么、系统凭什么判定你完成了,以及清单消失之后概览页上那些数字该怎么读。
装修、内容与上线
站点后台「内容」组的五个页面怎么配合:先把页面搭出来、再调整整站外观、备好图文素材,最后把小程序提交审核发出去。
会员与营销
顾客怎么变成会员、怎么按等级和标签分层、怎么用会员卡、积分、核销券和分享海报把人留下来——站点后台「会员」组五页与「营销」组三页的完整用法。
收钱:支付、流水与提现
顾客的钱怎么进来、怎么退回去,会员的钱怎么打出去。支付设置开店前配一次,交易流水与会员提现是每天要看的两页——本章按这三件事发生的顺序,把每个按钮的后果讲清楚。
触达顾客
发给顾客的消息分两路:系统按场景自动发的(验证码、支付成功、退款结果),和你主动发的(公众号菜单、自动回复、群发、推广二维码)。这一章把「触达」组的两个页面从接入配到发出去。
用应用与 AI 扩展能力
会员、交易、内容是站点自带的底座,商城、表单这类完整业务由应用提供,AI 生成、云打印、开放 API 则是按需开通的增强能力——本章讲清它们分别在哪里打开、怎么绑定、没开通时该找谁。
官方应用
商城(shop)与创意工坊(ai_studio)是随框架提供的官方应用,也是应用体系的标准范本——每一个内核横向能力(搜索、导出、海报、装修、待办)它们都真实消费。
开发指南
应用开发规范
应用是四端齐备的独立业务系统:后端模块、站点后台页面、C 端分包、DIY 装修组件。本章定义应用包结构、生命周期钩子与四端约定——照此开发的应用可以被商店分发、免编译安装、无残留卸载。
插件开发规范
插件是功能增强单元:支付通道、短信通道、商城秒杀都以插件形态存在。本章定义插件分类、包规范、依赖解析与注册物清单。
扩展点手册
扩展点(Hook)是 Tenraft 的一等公民:内核与应用在关键流程发布事件,插件订阅介入——二开不改源码,升级不冲突。本章讲机制与事件目录。
Admin SDK
管理端扩展页面是免编译 ESM:宿主经原生 import map 共享 React 单例,扩展页动态 import 即挂载。本章讲加载机制、routes.json 声明与 SDK 接口面。
API 与数据规范
四个 API 入口、统一响应结构、错误码分段,以及 MySQL 5.7 / 8.0 双兼容红线——应用与插件开发都必须遵守的地基约定。
运维与授权