SeaCMS 产品文档

版本：1.0.0
更新日期：2026-04-17
官方网站：SeaCMS

目录

• 第一部分：技术文档

  • 1. 产品概述

  • 2. 技术架构

  • 3. 项目结构

  • 4. 数据库设计

  • 5. API 接口文档

  • 6. 安全机制

  • 7. 部署指南

  • 8. 配置参考

• 第二部分：操作手册

  • 1. 快速开始

  • 2. 后台管理

  • 3. 内容管理

  • 4. 媒体管理

  • 5. 用户与权限

  • 6. 系统设置

  • 7. 前端展示

• 第三部分：授权许可

第一部分：技术文档

1. 产品概述

SeaCMS 是一个基于 Python Flask 框架和 SQLite 数据库构建的轻量级内容管理系统（CMS），专为个人博客、企业官网、技术文档站点等场景设计。系统采用前后端一体化架构，提供完整的后台管理界面和响应式前端展示。

1.1 核心特性

1.2 技术栈

2. 技术架构

2.1 系统架构图

┌─────────────────────────────────────────────────┐
│                   Nginx (反向代理)                │
│            静态文件缓存 / SSL终止 / 负载均衡        │
└──────────────────────┬──────────────────────────┘
                       │
┌──────────────────────▼──────────────────────────┐
│              Gunicorn (WSGI服务器)                │
│              4 Workers / 120s超时                 │
└──────────────────────┬──────────────────────────┘
                       │
┌──────────────────────▼──────────────────────────┐
│                 Flask 应用                        │
│  ┌──────────┐ ┌──────────┐ ┌──────────┐         │
│  │ Auth BP  │ │ Admin BP │ │ Main BP  │         │
│  │  /auth   │ │  /admin  │ │    /     │         │
│  └──────────┘ └──────────┘ └──────────┘         │
│  ┌──────────┐ ┌──────────┐ ┌──────────┐         │
│  │  API BP  │ │   WAF    │ │ Scheduler│         │
│  │   /api   │ │ 中间件   │ │ 定时任务  │         │
│  └──────────┘ └──────────┘ └──────────┘         │
│  ┌──────────────────────────────────────┐        │
│  │         Extensions Layer             │        │
│  │  DB | Login | CSRF | Cache | Mail   │        │
│  │  Migrate | Principal | Limiter      │        │
│  └──────────────────────────────────────┘        │
└──────────────────────┬──────────────────────────┘
                       │
┌──────────────────────▼──────────────────────────┐
│              SQLite 数据库                        │
│           (instance/seacms.db)                   │
└─────────────────────────────────────────────────┘

2.2 请求处理流程

客户端请求
    │
    ▼
Nginx (静态文件直接返回，其他转发)
    │
    ▼
Gunicorn
    │
    ▼
Flask App
    │
    ├── WAF中间件检查 (SQL注入/XSS/路径遍历检测)
    │
    ├── CSRF验证 (POST/PUT/DELETE请求)
    │
    ├── 限流检查 (Flask-Limiter)
    │
    ├── 路由分发 (Blueprint)
    │   ├── /auth/*    → 认证模块
    │   ├── /admin/*   → 后台管理模块
    │   ├── /          → 前台展示模块
    │   └── /api/*     → API模块
    │
    ├── 业务逻辑处理
    │
    ├── 模板渲染 (Jinja2)
    │
    └── 返回响应

2.3 蓝图注册

3. 项目结构

seacms/
├── app/                          # 应用主目录
│   ├── __init__.py               # 应用工厂函数 create_app()
│   ├── extensions.py             # Flask扩展初始化
│   ├── middleware.py             # WAF中间件
│   ├── models.py                 # 数据模型定义
│   ├── tasks.py                  # 定时任务（定时发布）
│   ├── admin/                    # 后台管理模块
│   │   ├── __init__.py
│   │   ├── forms.py              # WTForms表单定义
│   │   └── routes.py             # 后台路由（50+接口）
│   ├── api/                      # API模块
│   │   ├── __init__.py
│   │   └── routes.py             # RESTful API路由
│   ├── auth/                     # 认证模块
│   │   ├── __init__.py
│   │   ├── forms.py              # 登录/注册/资料表单
│   │   └── routes.py             # 认证路由
│   ├── main/                     # 前台模块
│   │   ├── __init__.py
│   │   └── routes.py             # 前台路由
│   ├── static/                   # 静态资源
│   │   ├── css/
│   │   │   └── sea-editor.css    # 富文本编辑器样式
│   │   ├── js/
│   │   │   └── sea-editor.js     # 富文本编辑器脚本
│   │   └── uploads/              # 上传文件目录
│   └── templates/                # Jinja2模板
│       ├── admin/                # 后台模板（25个）
│       ├── auth/                 # 认证模板（6个）
│       └── main/                 # 前台模板（7个）
├── instance/                     # 实例目录
│   └── seacms.db                 # SQLite数据库文件
├── backups/                      # 数据库备份目录
├── scripts/
│   └── init_db.py                # 数据库初始化脚本
├── config.py                     # 配置类
├── run.py                        # 应用入口
├── Dockerfile                    # Docker镜像构建
├── docker-compose.yml            # Docker编排
├── nginx.conf                    # Nginx配置
├── requirements.txt              # Python依赖
├── .env.example                  # 环境变量示例
└── start.sh                      # 启动脚本

4. 数据库设计

4.1 ER关系图

┌──────────┐     ┌──────────────┐     ┌──────────┐
│   User   │────<│  user_roles  │>────│   Role   │
└────┬─────┘     └──────────────┘     └──────────┘
     │
     │ 1:N
     │
┌────▼─────┐     ┌──────────┐     ┌──────────┐
│   Post   │>────│ post_tags │<────│   Tag    │
└────┬─────┘     └──────────┘     └──────────┘
     │
     │ N:1          ┌──────────┐
     ├──────────────>│ Category │
     │              └──────────┘
     │ N:1
     ├──────────────>│   User   │ (author)
     │
     │ 1:N
     ├──────────────>│ Comment  │
     │
     │ 1:N
     └──────────────>│PostVersion│

┌──────────┐  ┌──────────────┐  ┌──────────────┐
│   Page   │  │    Media     │  │   Setting    │
└──────────┘  └──────────────┘  └──────────────┘

┌──────────────┐  ┌──────────────┐  ┌──────────────┐
│ OperationLog │  │   APIToken   │  │ContactMessage│
└──────────────┘  └──────────────┘  └──────────────┘

┌──────────────┐  ┌──────────────┐
│  VisitLog    │  │ContentTemplate│
└──────────────┘  └──────────────┘

4.2 数据表详细设计

users - 用户表

roles - 角色表

预置角色：

posts - 文章表

categories - 分类表

tags - 标签表

pages - 页面表

comments - 评论表

media - 媒体文件表

post_versions - 文章版本表

settings - 系统设置表

visit_logs - 访问日志表

operation_logs - 操作日志表

api_tokens - API令牌表

contact_messages - 联系消息表

content_templates - 内容模板表

关联表

user_roles - 用户角色关联

post_tags - 文章标签关联

5. API 接口文档

5.1 公开接口

获取文章列表

GET /api/public/posts

参数：

响应字段：

获取文章详情

GET /api/public/posts/<slug>

获取分类列表

GET /api/public/categories

获取页面列表

GET /api/public/pages

获取页面详情

GET /api/public/pages/<slug>

获取站点信息

GET /api/public/site-info

响应示例：

{
    "site_name": "SeaCMS",
    "site_description": "一个基于Flask的内容管理系统",
    "site_keywords": "CMS,Flask,内容管理",
    "total_posts": 42,
    "total_categories": 5,
    "total_tags": 18
}

提交评论

POST /api/comments

请求体：

{
    "post_id": 1,
    "content": "评论内容",
    "author_name": "访客",
    "author_email": "visitor@example.com"
}

用户认证

POST /api/auth

请求体：

{
    "username": "admin",
    "password": "password"
}

5.2 管理接口（需Token认证）

所有管理接口需在请求头中携带API Token：

Authorization: Bearer <your-api-token>

管理文章列表

GET /api/manage/posts?page=1&per_page=20

创建文章

POST /api/manage/posts

请求体：

{
    "title": "文章标题",
    "content": "文章内容",
    "summary": "文章摘要",
    "status": "draft"
}

获取/更新/删除文章

GET    /api/manage/posts/<id>
PUT    /api/manage/posts/<id>
DELETE /api/manage/posts/<id>

PUT请求体（部分更新）：

{
    "title": "新标题",
    "content": "新内容",
    "status": "published"
}

DELETE操作： 将文章状态设为 trash，不物理删除。