odyseeteam/commentron

Commentron 评论系统镜像

概述

Commentron 是一个轻量级评论系统 Docker 镜像，旨在为各类网站或应用提供快速部署的评论功能解决方案。通过容器化部署，用户可避免复杂的后端环境配置，仅需简单几步即可为目标平台集成评论模块，适用于对评论功能需求简洁、追求部署效率的场景。

核心功能与特性

• 快速集成：无需独立搭建后端服务，通过 Docker 容器一键部署，分钟级完成评论功能接入。
• 基础评论交互：支持用户提交评论、查看评论列表，支持评论分页展示。
• 灵活用户模式：兼容***评论与基础注册用户评论（需配合简单用户认证配置）。
• 轻量级存储：默认集成嵌入式数据库（如 SQLite），无需额外配置外部数据库，降低部署复杂度。
• 可配置参数：支持通过环境变量自定义端口、评论显示条数、审核开关等基础功能。
• API 支持：提供简单 RESTful API，便于与前端框架（如 React、Vue）或静态站点生成器集成。

使用场景

• 个人博客系统（如 WordPress、Typecho、Hexo、Jekyll）的评论模块替代或补充。
• 静态站点（如通过 GitHub Pages 托管的站点）需要添加动态评论功能的场景。
• 小型网站或应用内轻量级评论模块（如产品反馈、文章讨论区）。
• 开发环境中快速验证评论功能原型。

使用方法与配置说明

基本部署（Docker Run）

通过以下命令快速启动 Commentron 容器：

bash
docker run -d \
  --name commentron \
  -p 8080:8080 \
  -v ./commentron-data:/app/data \
  -e PORT=8080 \
  -e ADMIN_EMAIL=admin@example.com \
  commentron/commentron:latest

参数说明：

• -p 8080:8080：端口映射，将容器内 8080 端口映射到主机 8080 端口（可根据需求修改主机端口）。
• -v ./commentron-data:/app/data：数据卷挂载，持久化存储评论数据（避免容器重启后数据丢失）。
• -e PORT=8080：指定容器内服务运行端口（需与容器内暴露端口一致）。
• -e ADMIN_EMAIL=admin@example.com：管理员***，用于接收评论审核通知（若启用审核功能）。

Docker Compose 配置

创建 docker-compose.yml 文件，简化多容器环境下的部署与管理：

yaml
version: '3'
services:
  commentron:
    image: commentron/commentron:latest
    container_name: commentron
    ports:
      - "8080:8080"
    volumes:
      - ./commentron-data:/app/data
    environment:
      - PORT=8080
      - ADMIN_EMAIL=admin@example.com
      - COMMENT_PER_PAGE=10  # 每页显示评论数，默认 10
      - ENABLE_MODERATION=true  # 是否启用评论审核，默认 false
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

环境变量配置

访问与集成

服务启动后，可通过 http://<主机IP>:8080 访问评论系统管理界面（默认路径 /admin），通过 /api/comments 接口获取/提交评论数据。前端集成时，可参考官方文档（若有）或通过以下示例代码嵌入评论框：

html
<!-- 评论框嵌入示例 -->
<div id="commentron-container"></div>
<script src="http://<主机IP>:8080/static/commentron.js"></script>
<script>
  Commentron.init({
    container: '#commentron-container',
    pageId: 'unique-page-identifier'  // 用于区分不同页面的评论
  });
</script>

注意事项

• 数据持久化：建议通过 -v 参数挂载数据卷，避免容器删除后评论数据丢失。
• 生产环境：若用于生产环境，建议配置 API_KEY 并启用 ENABLE_MODERATION，同时通过反向代理（如 Nginx）配置 HTTPS。
• 扩展性：该镜像为轻量级设计，不适用于高并发或大规模评论场景，复杂需求建议结合外部数据库（如 MySQL）及负载均衡方案。