更新 README 文档,替换为 GeneAgro CMS 使用说明

This commit is contained in:
2025-10-19 12:26:01 +08:00
parent b8286157ac
commit a9bcfce8d8
7 changed files with 398 additions and 90 deletions

170
README.md
View File

@@ -1,103 +1,93 @@
# PbootCMS
# GeneAgro CMS 使用说明(基于 PbootCMS 3.2.5
### PbootCMS是全新内核且永久开源免费的PHP企业网站开发建设管理系统是一套高效、简洁、 强悍的可免费商用的PHP CMS源码能够满足各类企业网站开发建设的需要。系统采用简单到想哭的模板标签只要懂HTML就可快速开发企业网站。官方提供了大量网站模板免费下载和使用将致力于为广大开发者和企业提供最佳的网站开发建设解决方案。
* 系统采用高效、简洁、强悍的模板标签只要懂HTML就可快速开发企业网站
* 系统采用PHP语言开发使用自主研发的高速多层开发框架及缓存技术
* 系统默认采用sqlite轻型数据库放入PHP空间即可直接使用可选mysql等数据库满足各类存储需求
* 系统采用响应式管理后台,满足各类设备随时管理的需要;
* 系统支持后台在线升级,满足系统及时升级更新的需要;
* 系统支持内容模型、多语言、自定义表单、筛选、多条件搜索、小程序、APP等功能
* 系统支持多种URL模式及模型、栏目、内容自定义地址名称满足各类网站推广优化的需要。
项目简介
- 本项目为 GeneAgro CMS基于 PbootCMS核心版本 3.2.5release 20230421revise 4
- 适用于企业官网、资讯展示与接口输出,包含前台、后台与 API 三部分。
## 简单到想哭的模板标签:
```
1、全局标签示意
{pboot:sitetitle} 站点标题
{pboot:sitelogo} 站点logo
技术栈与主要组件
- 后端PHP 7.x建议 7.17.4MySQLmysqli 驱动)。
- 前端Bootstrap、jQuery见 template/default 目录)。
- 其它:可选 Memcache缓存与会话日志支持数据库与文本两种。
2、列表页标签示意
{pboot:list num=10 order=date}
<p><a href="[list:link]">[list:title]</a></p>
{/pboot:list}
环境要求与依赖
- PHP 版本:代码中强制校验 7.0+Check::checkPHP。不建议在 PHP 8.0 上运行。
- 必需扩展gd、mbstring、curl数据库驱动mysqli可选扩展memcache用于缓存/会话)。
- Web 服务器:需开启伪静态/URL 重写rewrite 目录提供 Nginx/Apache/IIS 参考)。
- 时区与编码:默认设置为 Asia/Shanghai输出 UTF-8。
- Composer仓库已包含 vendor。若 vendor 缺失,可执行 composer install 以补齐依赖。
3、内容页标签示意
{content:title} 标题
{content:subtitle}副标题
{content:author} 作者
{content:source} 来源
入口与模块职责
- 前台入口index.php网站首页与内容展示
- 后台入口iotadmin.php系统管理后台
- API 入口api.php接口输出含认证校验
- 路由配置:
- apps/common/route.php定义系统内置的路由分发admin 系统/内容/会员,前台 sitemapAPI list/content/about/search 等)。
- config/route.php可进行项目级路由扩展或覆盖。
更多简单到想哭的标签请参考开发手册...
快速开始
1) 部署代码到 Web 根目录(确保 PHP 与扩展满足要求)。
2) 配置数据库连接:编辑 config/database.phptype=\"mysqli\"host/user/passwd/port/dbname
3) 配置站点与系统参数:编辑 config/config.php或通过后台配置页
4) 配置伪静态/重写:参考 rewrite/.htaccess、nginx.txt、web.config。
5) 访问后台:浏览器打开 http(s)://<域名或IP>/iotadmin.php首次登录后完善站点信息。
6) 前台访问:浏览器打开 http(s)://<域名或IP>/。
7) API 配置与使用:在后台“系统配置”页开启 WebAPI 并设置认证参数详见下文“API 认证与示例”)。
```
常用配置说明(核心项)
- WebAPI后台系统配置页
- api_open开启/关闭接口能力。
- api_auth开启/关闭接口签名认证(建议开启)。
- api_appid接口用户名调用方标识
- api_secret接口密钥调用方密钥
- 日志
- 记录方式core/convention.php 中 log_record_type可配置为 \"db\" 或 \"text\"。
- 数据库日志:写入 ay_syslog 表(字段含 level、event、ip、os、bs、user、time
- 文本日志:写至 log/ 目录按日归档YYYYMMDD.log
- 会话与缓存
- 会话存储:默认文件;如需 Memcache请在 core/convention.php 配置 session.handler=\"memcache\" 并正确设置地址。
- 缓存cache.handler 可选 \"memcache\",需安装 PHP memcache 扩展。
- 上传与水印
- 上传格式与尺寸:在 core/convention.php 中 upload.* 与 ico.* 配置。
- 水印:可在后台配置中开启/设置水印参数。
- 模板与主题
- 模板目录template/default可通过 setTheme/assign 方法进行变量注入与主题切换。
## 主要功能:
* 支持自定义模板
* 支持站点信息后台配置
* 支持无限极栏目
* 支持自定义内容模型
* 支持自定义内容字段
* 支持专题单页内容
* 支持列表内容管理
* 支持内容复制移动
* 支持自定义栏目地址
* 支持自定义内容地址
* 支持多语言区域建站
* 支持手机独立模板
* 支持手机版域名绑定
* 支持首页分页
* 支持页面SEO优化
* 支持在线留言
* 支持幻N组灯片轮播
* 支持友情链接
* 支持自定义表单
* 支持多条件筛选
* 支持多条件搜索
* 支持验证码开关
* 支持留言发送到多邮箱
* 支持API对接
* 支持小程序/APP开发
* 支持Ajax远程获取数据
* 支持自定义标签
* 支持全站伪静态
* 支持前端动态缓存
* 支持系统角色管理
* 支持完整角色权限管理
* 支持多用户在线管理
* 支持系统日志功能
* 支持数据库在线管理
* 支持后台在线升级
* 支持自定义URL模式
API 认证与示例
- 开启 api_open 后,若 api_auth=1则每次请求必须带上时间戳与签名。
- 签名生成sign = md5( md5( api_appid + api_secret + timestamp ) )。
- 时间戳有效期15 秒内有效,过期拒绝。
- 示例GET/api/list?appid=YOUR_APPID&timestamp=UNIX_TS&sign=YOUR_SIGN
- 主要接口apps/common/route.phplist、content、about、search 等。
## 系统安装:
目录结构速览
- apps/admin后台控制器、模型与视图。
- apps/home前台控制器与模型。
- apps/api接口层可扩展
- apps/common公共控制器与路由、版本信息。
- core/basic核心基础类Controller/Model/Db/Cache/Log 等)。
- core/function常用函数库helper/handle/file
- core/log日志实现数据库与文本
- config项目配置config.php、database.php、route.php
- rewrite不同服务器的伪静态规则示例。
- template/default前端模板与静态资源。
发布的源码默认采用sqlite数据库放入PHP7.0+)空间即可直接使用(不支持php8.0)。
部署与运维建议
- 开启伪静态:根据服务器类型使用 rewrite 目录对应示例。
- 生产模式关闭调试:在 core/convention.php 中设置 debug=false。
- 数据库备份static/backup/sql 目录可用于备份脚本/数据。
- 日志与监控:建议使用数据库日志并对 ay_syslog 做索引与归档。
如果需要启用Mysql版本请导入目录下数据库文件/static/backup/sql/xxx.sql同时请注意使用最新日期名字的脚本文件并修改config/database数据库连接文件信息。
常见问题
- 访问出现 404检查伪静态是否生效确认入口文件路径正确。
- API 调用失败(签名错误或超时):核对 appid/secret 与签名算法,确保服务器与调用方时间同步。
- 图片上传失败:检查 upload.format 与尺寸限制,确认 GD 扩展已启用。
- 登录或会话异常:若使用 Memcache确认扩展与地址配置正确否则使用默认文件存储。
系统后台默认访问路径http://ip/admin.php 账号admin 密码123456
许可协议
- 本项目采用 Apache License 2.0。详见仓库 LICENSE 文件。
版本信息
- Core/App 版本apps/common/version.php 中 app_version=3.2.5release_time=20230421revise_version=4。
## 升级说明:
* 使用后台在线升级(推荐):
支持跨版本升级,会自动升级数据库及代码文件。
* 使用全包升级:
支持跨版本升级保留config、data、static、template目录其余全部用新版替换 同时如果涉及到的中间版本有升级数据库,需要使用群文件数据库脚本升级数据库。
## 授权声明:
1、PbootCMS是免费可商用的建站系统用户通过官网获取免费域名授权码即算授权成功并且永久有效。对于已经授权的域名也不存在未来收费的说法大家可以放心使用。
2、PbootCMS系统允许个人或公司进行任意二开及商用但是不允许任何形式的破解或绕过系统授权的行为包括但不限于通过PbootCMS系统建设网站、二次开发、发布衍生版本等情况对于任何破解或绕过PbootCMS官网授权的行为我们将保留依法追究法律责任的权力。
3、PbootCMS除了一个授权文件代码外其它代码全部开源并使用Apache2开源协议。对于任何基于PbootCMS进行二开的系统应该遵守Apache2开源协议的有关要求。
4、PbootCMS官方不对使用本软件所构建网站中的文章、商品和其它任何信息承担责任不管您通过任何渠道下载本软件您一旦开始安装PbootCMS即被视为完全理解并接受PbootCMS授权声明的各项条款。
## 联系我们:
官方网站https://www.pbootcms.com/
Giteehttps://gitee.com/hnaoyun/PbootCMS
致谢
- 基于 PbootCMS 的二次开发与定制改造,感谢原项目与社区贡献。