UJCMS 用户手册
本手册面向站点管理员、运维人员、内容运营人员、主题开发者和二次开发人员,按功能分别介绍配置方法、操作步骤和常见问题。 可根据下表选择需要阅读的指南。
下表“版本”列写的是所需的最低版本:商业版分为基础版、标准版、高级版、旗舰版,高版本包含低版本的全部功能;“全部”表示社区版也可使用。 每项商业版功能从哪个版本开始提供,见版本对比。
入门
| 手册 | 内容 | 版本 |
|---|---|---|
| 简介 | 系统组成与技术栈、模板 + 标签与 Vue + API 两种开发模式、运行环境、社区版与商业版各档的功能、演示站 | 全部 |
| 快速开始 | 四种部署方式的选择、用 Jar 安装包从零装出带演示数据的站点、War / Docker / 源码启动的要点、常见问题 | 全部 |
| 基本概念 | 站点、栏目、文章、区块、页面各是什么、相互关系、在后台哪里管理 | 全部(多站点需标准版,页面可视化设计需高级版) |
| 版本对比 | 社区版与商业版的授权方式、社区版包含的功能、商业版各项功能在基础版 / 标准版 / 高级版 / 旗舰版中的对照表、怎样查看某个功能所需的版本 | 全部 |
安装部署
| 手册 | 内容 | 版本 |
|---|---|---|
| JDK 选择与安装 | 选哪个版本和发行版,Windows、Linux 上的安装与环境变量,国产 CPU 平台 | 全部 |
| Jar 部署 | jar 安装包的目录结构、数据库连接、启动参数、systemd 服务、常见问题 | 全部 |
| Docker 部署 | 用 Compose 启动、以环境变量配置无人值守安装、Docker Secret、本地主题目录与主题随镜像更新、字体、数据库驱动 | 全部 |
| Tomcat 部署 | war 安装包部署到 Tomcat 10.1+、数据库连接、部署路径、常见问题 | 全部 |
| 东方通 TongWeb 部署 | TongWeb 8.0.9.13+ 上部署 war 安装包:JDK、放置程序、管理控制台部署、安装令牌、常用命令与日志 | 全部 |
| 安装向导与无人值守安装 | 首次启动的初始化与安装令牌、控制台安装向导、无人值守安装清单(ujcms.install.*)、中断后继续安装、常见问题 | 全部(多站点需标准版,演示审核流程需基础版) |
| 升级 | 升级前的检查,Jar / Tomcat / Docker 各自换哪些文件、留哪些文件,从 12.x、13.1.x 升级的注意事项 | 全部 |
运维
| 手册 | 内容 | 版本 |
|---|---|---|
| Nginx 反向代理 | 全部转发的基本配置、真实 IP(ujcms.)、由 Nginx 直接发送静态文件、常见问题 | 全部 |
| 存储点 | 附件 / 静态页 / 模板 / 主题包四个存储点、存储路径与访问路径、把附件存到程序目录之外、FTP 服务器、常见问题 | 全部(FTP 服务器 / 对象存储需标准版) |
| 页面静态化 | 开启静态化与自动生成、静态页的地址与存放位置、路径变量、生成管理手动生成与任务列表、由程序或 Nginx 发送、常见问题 | 全部(定时生成需标准版) |
| 定时任务 | 任务类型(定时采集、生成本站索引、更新全部静态页、四种备份)、新增任务与保留份数、执行计划与 Quartz Cron 表达式、时区、立即执行与执行状态、集群部署、权限、常见问题 | 标准版 |
| 备份管理 | 模板 / 上传 / 上传增量 / 数据库四种备份的内容与存放位置、数据库导出工具的配置、恢复会覆盖什么、手工恢复、增量与合并、定时备份与保留份数、安全与升级、权限、常见问题 | 标准版 |
| 前台页面缓存与 CDN | 前台页面、订阅源与静态资源的 Cache-Control 约定,CDN / 反向代理的缓存策略要求(腾讯云 EdgeOne 示例),登录后仍显示未登录状态的排查 | 全部 |
| LibreOffice 与文档转换 | 哪些功能需要 LibreOffice、Docker 与 Jar / Tomcat 下的配置、集群共用转换服务、PDF 缺字 | 基础版 |
| 集群部署 | 各节点一致的密钥、雪花算法节点编号、Redis 分布式缓存、Elasticsearch 全文检索、共享目录与对象存储、会话保持、Quartz 集群调度、上线检查清单、常见问题 | 全部(Redis / Elasticsearch 需高级版,对象存储 / FTP / 定时任务需标准版) |
| 验证码 | 滑块拼图与字符验证码、互动表单的免验证提交与工作量证明、登录验证码触发、极验 / 腾讯云 / 阿里云 / 网易易盾 / Cloudflare Turnstile 接入、主题开发接入方式 | 全部(第三方验证码需基础版) |
| 等保三级与密评三级合规配置 | 推荐安全策略、默认账号处理、密钥与密码胡椒值、审计完整性、三权分立、管理终端白名单、传输安全 | 全部(安全设置需基础版) |
| 用户个人信息盲索引重建 | 手机号、邮箱的加密与盲索引重建:适用场景、操作方法和结果校验 | 全部 |
| 找回管理员密码 | 由其他管理员重置、自助找回、在数据库中重置及其前提 | 全部 |
| 错误页面与错误信息 | 访客与后台操作员各自看到什么、错误编号、错误页面模板的位置、相关配置项 | 全部 |
| 访问统计与浏览量 | 统计菜单的七张报表与指标含义、数据的产生、延迟与保留时间、主题引入 visit.js 与征求访客同意、文章 / 栏目 / 站点浏览量接口、常见问题 | 全部(专题浏览量需标准版) |
| 站点地图与搜索引擎提交 | 地址与收录条件、lastmod 来源、hreflang / 图片扩展、缓存与响应头、Google / Bing / 百度提交(百度不接受索引型)、百度主动推送与 IndexNow 推送、静态化反向代理规则、常见问题 | 全部 |
| GEO 设置 | JSON-LD 结构化数据、llms.txt、robots.txt 与 AI 爬虫、生效时间与验证、搜索引擎推送、常见问题 | 全部 |
内容管理
| 手册 | 内容 | 版本 |
|---|---|---|
| 栏目管理 | 批量新增与清单写法、批量设置、导出、拖拽与批量移动、批量合并、删除、栏目权限、整理树形结构、常见问题 | 全部(栏目权限需基础版,批量新增译文需标准版) |
| 单页栏目 | 栏目类型设为单页栏目、录入正文、选用单页模板、四种栏目类型、自建单页模板 | 全部 |
| 文章管理 | 文章状态与回收站、批量操作、置顶、移动栏目、克隆、编辑与保存、导出列表、导入文章、权限、常见问题 | 全部(导入文章、Word 导入需基础版) |
| 一键排版 | 站点的排版规则(字体、字号、行高、空行、缩进、图片、表格、全角转半角)、编辑器按钮、排版做了什么、首行缩进的其它办法 | 标准版 |
| 相关文章 | 手选相关文章与排序、单向 / 互相关联、被关联列表、智能推荐、删除时的处理、模板标签与接口 | 全部(AI 挑选与理由需标准版) |
| 专题管理 | 专题树与界面、新增和编辑专题(别名生成、专题模型、专题模板)、在专题和文章编辑页关联文章与排序、删除规则、权限、前台页面与模板指令、公开接口、常见问题 | 标准版 |
| 区块管理 | 区块与区块项、新增与编辑区块、从文章推荐、排序与定时上下线、区块项模型、全局共享的区块、删除规则、权限、模板指令与接口、常见问题 | 全部(在构建器中给组件选择区块需高级版) |
| 文章审核流程 | 新建、设计、部署审核流程,在栏目上选用,审核文章 | 基础版 |
| 会员投稿 | 开启投稿(站点开关、栏目的允许投稿与投稿用户组)、会员投稿表单与自定义字段、待审核与退回、通知、权限、主题接口、常见问题 | 全部(栏目审核流程需基础版,AI 内容审核需标准版) |
| 采集管理 | 新增采集任务(基础信息、列表页数据、详细页数据)、规则写法与试匹配、启动与查看结果、定时采集、常见问题 | 标准版 |
| 数据迁移 | 开启数据迁移、源数据库与预览、迁移栏目和文章、重复执行与对应关系、迁移方案的导出导入、SQL 写法与状态换算、从 Jspxcms 和 JEECMS 迁移的示例、常见问题 | 基础版 |
| 全文检索 | 前台搜索页与匹配规则、栏目的允许搜索、重建索引(更新全部 / 本站索引)、索引位置与集群、搜索指令与接口、常见问题 | 全部(更新本站索引需基础版,定时重建需标准版,Elasticsearch 需高级版) |
| 模型管理 | 模型类型与共享范围、使用情况与删除规则、复制模型、系统字段开关、自定义字段设计器、常见问题 | 全部(专题模型、表单模型需标准版) |
| 字典管理 | 字典类型与条目、共享范围、绑定到选项类自定义字段、模板指令与接口、删除规则与系统字典 | 全部 |
| 站点自定义设置 | 在站点设置模型里定义设置项、在站点设置里填写、模板读取 site.customs、全局自定义设置 | 全部 |
| 多站点 | 新增与复制站点、域名与子目录、按组织决定谁能进入哪个站点、站点管理员与全局数据权限、常见问题 | 标准版 |
| 多语言站点 | 语言组与站点寻址、译文关联、新增 / 批量新增译文、AI 预翻译、主题与 API、常见问题 | 标准版 |
互动
| 手册 | 内容 | 版本 |
|---|---|---|
| 评论与留言 | 开启评论与留言(站点设置、登录、审核)、访客发表与评论图片、按状态审核、留言答复与公开、留言类型、敏感词与验证码、AI 审核、权限、模板指令与接口、常见问题 | 全部(AI 审核与 AI 拟稿需标准版) |
| 自定义表单 | 表单类型与表单模型、录入模式与前台可浏览、访客提交与人机验证、表单的状态与处理、表单审核、权限、模板标签与接口、常见问题 | 标准版(退回、委托、转办需高级版) |
用户与权限
| 手册 | 内容 | 版本 |
|---|---|---|
| 用户批量操作 | 批量录入(表格填写、从 Excel 粘贴)、导入用户(模板、预检、结果报告)、给选中的用户批量添加 / 移除角色、共同的规则、权限、常见问题 | 全部(导入用户需基础版) |
| 文章数据权限 | 文章权限(按栏目)、数据权限范围、全部状态权限,多个角色与组织的叠加,受限用户的各项操作,审核、表单管理与表单审核、推送、翻译与采集,常见问题 | 基础版 |
| 栏目浏览权限 | 用游客组 / 用户组限制栏目与文章的前台浏览(登录后可见、仅部分会员可见)、受保护范围与不受限制的地方、新建栏目的默认权限 | 全部 |
模板与主题
| 手册 | 内容 | 版本 |
|---|---|---|
| 应用市场 | 浏览 / 安装 / 更新官方主题、连接市场账号、购买付费主题、沙箱试装、离线部署 | 全部(沙箱试装需标准版) |
| 页面组件与内容编排 | 可视化构建器的区域、行、列和面板,内容存放方式,共享布局与栏目定制,草稿与发布 | 高级版 |
| 主题开发 | 主题的组成、开发前的页面规划与地址—模板对应表、开发目录与标准目录结构、theme.、静态资源制作、本地开发环境 | 全部 |
| 模板编写 | FreeMarker 语法与逐文件转义、主布局、全局变量、CMS 指令取数、固定链接、片段页、页面清单与页面设置、布局变体、主题设置、预览单个模板、模板错误与错误编号 | 全部 |
| 组件、区域与演示数据 | Shape 定义与面板模板、在页面渲染区域与共享区域、区域脚本刷新、区域种子与内容种子 | 全部(在构建器中编排区域需高级版) |
| 主题测试与发布 | 语法 / Schema 检查与页面验收、打包前清理与 ZIP 根目录、安装器约束、安装 / 预览 / 激活 / 更新与演示数据管理、安全边界、发布验收清单 | 全部 |
| 模板标签与 API 的通用参数 | limit / offset、page / pageSize 的默认值与上限,分页对象与翻页链接,orderBy 写法与限制,[@A] 标签,按自定义字段筛选文章 | 全部 |
| 前台表单与 AJAX 的 CSRF 令牌 | 哪些请求要带令牌、/frontend 与 /api 的区别、令牌的两种取法、表单与 AJAX 写法、静态页与缓存页面、常见 403 提示 | 全部 |
| 主题授权 | 官方演示主题(MIT)与付费主题(UJCMS 主题商业授权协议)的授权方式、清单 license 字段的写法、随包的许可证与来源说明文件、协议版本 | 全部 |
| UJCMS 主题商业授权协议 | 付费官方主题适用的协议 1.0 版全文:授权、限制、第三方组件、媒体与演示内容、知识产权、更新与支持、保证与责任、终止、法律适用 | 全部 |
| 主题安全与部署约束 | 主题代码的执行权限、模板可访问的数据、权限分配建议、多节点部署的操作要求、主题文件的对外访问范围 | 全部 |
集成
| 手册 | 内容 | 版本 |
|---|---|---|
| AI 功能 | AI 服务商与站点功能开关、编辑助手、内容审核、AIGC 标识、AI 日志、常见问题 | 标准版 |
| 微信公众号 | 公众号登记与服务器配置、文章推送与多图文、素材 / 菜单 / 粉丝、自动回复、模板消息、群发、数据统计 | 高级版 |
| 第三方登录 | 微信 / QQ / 微博登录:开放平台申请、后台开启、回调地址、会员注册的前提、前台入口 | 标准版 |
二次开发
| 手册 | 内容 | 版本 |
|---|---|---|
| 源码结构与分层 | 模块与包、后端三层、后台接口 / 公开接口 / 前台页面 / 模板标签四类入口、后台接口的登录与权限、后台界面的目录、开发时的运行方式 | 全部 |
| Node.js 与 pnpm 安装 | 源码构建所需的 Node.js 版本、npm 与 pnpm 的设置、后台管理界面和主题的构建命令 | 全部 |
| 后端功能开发 | 以示例功能为例:一个功能的全部文件、实体类与 Mapper、Service 与查询参数、后台接口与权限码、站点数据隔离、公开接口 / 模板标签 / 前台页面 | 全部 |
| 后台界面开发 | 接口函数、列表页与对话框表单、界面文字、路由与菜单、角色权限树、操作日志名称、启用示例功能与构建 | 全部 |
| 数据库设计规范与表结构变更 | 表名与字段名的命名规范、字段类型约定、Liquibase 变更日志的位置、新建表与修改表的写法、常见问题 | 全部 |
| 实体类与 Mapper | 一张表对应的四个文件、基类 GeneratedXxx 与实体类的分工、字段类型对应、Mapper XML 的六个字段元素与公用查询片段、改表结构时要改的地方 | 全部 |
| 查询解析器 QueryParser | 查询键的写法、操作符与类型、关联其它表、OR 分组、JSON 字段、排序与去重,后台接口、公开接口、模板标签三个入口的限制 | 全部 |
| 主键生成 | 雪花 ID 的取法与构成、节点编号、接口中 ID 为什么是字符串、固定 ID 与序列表 | 全部 |
| 密码加密 | 密码的存储算法与胡椒值、SM2 传输加密的客户端写法、在代码里校验和设置密码、创建用户、从其它系统迁移用户 | 全部 |
政务
| 手册 | 内容 | 版本 |
|---|---|---|
| 依申请公开 | 前台申请 / 查询 / 补正,后台受理 / 补正 / 延期 / 答复,办理天数提示,权限与常见问题 | 旗舰版 |
| 领导信箱 | 信箱类型、写信 / 查询 / 评价,后台受理 / 退回 / 延期 / 答复 / 选登,办理统计与通知 | 旗舰版 |
| 在线访谈 | 访谈新增与发布、直播控制与访谈实录、网友提问与审核、主题接入 | 旗舰版 |
| 网站普查 | 检查规则、普查运行、问题清单、44 项自查评分与普查报告 | 旗舰版 |
| 无障碍·适老化工具条(EaseBar) | 站点开关与入口、快捷键、主题接入、合规依据 | 旗舰版 |
约定
- 手册按读者要做的事分目录存放:
start/入门、install/安装部署、ops/运维、content/内容管理、interaction/互动、users/用户与权限、theme/模板与主题、integration/集成、develop/二次开发、gov/政务。目录不按版本划分,所需版本写在上表的“版本”列和每篇手册的开头。 - 手册的一级标题与上表第一列的名称相同,就是它在文档站侧边栏和浏览器标签上的名字:不加“UJCMS”前缀,不加“使用指南”“配置指南”一类后缀, 面向哪些读者写在开头的引用块里。侧边栏只取名称里第一个“:”或“(”之前的部分,这两个符号之前须是完整的名称。
- 开头的引用块第一句是校对日期和适用版本,如
> 校对日期:2026-11-16。适用于社区版及全部商业版。 - 二级标题按
一、二、编号,三级标题不编号或按2.1编号;常见问题一节叫“常见问题”,放在正文最后,其后只可再有“相关文档”。 - 引用其它章节时链接到它的锚点并写出节名,不写“第三节”,如
见[集群部署](.、. / ops/ cluster-deployment. zh. md#三、统一各节点的密钥)的“统一各节点的密钥”一节 见“[常见问题](#六、常见问题)”一节。锚点按文档站的规则由标题生成:保留汉字和“、”,空格和():.等符号变为-,数字开头的前面加_, 英文字母转为小写。改了标题或编号,链接检查会指出要改的引用。 - “版本”列以
全部、基础版、标准版、高级版、旗舰版之一开头,表示使用这篇手册所讲的功能最低需要的版本;其中部分内容需要更高版本时, 在后面用全角括号补充,如全部(导入文章需基础版)。文档站据此在侧边栏和标题下显示版本标记。 - 手册正文里,某一节或某一项功能需要更高版本时,在标题或名称后面写
(基础版)(标准版)(高级版)(旗舰版)(也可以写成(商业版标准版)),如## 七、导入文章(基础版)。文档站把它显示成版本标记;只写版本名称,不写 T1–T4。 - 版本对比里的对照表由
scripts/生成:新增商业版功能、修改功能说明或调整上表的“版本”列后重新运行,generate-edition-matrix. mjs --check用于检查是否过期。 - 目录名和文件名就是文档站(docs.ujcms.com)的地址:
ops/发布为captcha. zh.md /ops/,改名即改地址;移动或改名后,旧地址须在文档站登记跳转。captcha. html - 新增手册须在上表登记:文档站的侧边栏由本页的二级标题和表格第一列生成,没有登记的手册不会出现在侧边栏里。
install/下的 Jar 部署、Tomcat 部署和升级三篇同时是安装包内 README 的来源(由installs/拼入,手册之间的链接改指文档站上的同一页): 内容须适用于全部版本;改动其中的二级标题时同步修改该脚本。deploy/ render-readme.sh - 不设“常见问题”目录:一个问题写进它所属功能那篇手册的“常见问题”一节。
- 截图放在所在目录的
images/<手册文件名>/下(如content/),用相对路径引用。images/ article/ 01-list. png - 手册根据当前版本的实际功能维护,并在开头注明校对日期。如说明与界面不一致,请以控制台为准,并及时修正文档。
- 维护文档后,运行
node scripts/检查链接。本目录中存在失效链接时,检查会失败。check-doc-links. mjs