SSCMS *** Docker 镜像文档

1. 镜像概述与主要用途

1.1 概述

SSCMS *** Docker 镜像是由 SSCMS 团队提供的容器化部署方案，镜像版本与 SSCMS 系统版本同步更新，确保用户能够便捷获取最新功能与安全补丁。

1.2 主要用途

用于快速部署 SSCMS 内容管理系统（CMS），简化传统部署中的环境配置流程，支持跨平台运行，适用于各类内容管理场景的容器化部署需求。

2. 核心功能与特性

• 版本同步更新：与 SSCMS ***版本实时同步，确保功能与安全性。
• 多数据库支持：兼容 SQLite、MySQL、SQL Server、PostgreSQL 等主流数据库类型。
• 数据持久化：支持通过本地目录挂载或 Docker Volume 存储站点数据，保障容器重启后数据不丢失。
• 自动重启保障：需配置 always 重启策略，确保插件安装、升级等依赖容器持续运行的操作正常执行。
• 环境变量配置：通过环境变量灵活设置系统参数（如安全密钥、数据库连接），无需手动修改配置文件。

3. 使用场景与适用范围

• 个人博客/小型网站：快速搭建个人内容发布平台，无需复杂环境配置。
• 企业官网：部署企业信息展示站点，支持动态内容管理与更新。
• 开发测试环境：隔离式部署 SSCMS 实例，用于功能测试、插件开发或版本兼容性验证。
• 中小规模内容平台：适合对部署效率敏感，需要快速上线且维护成本低的场景。

4. 使用方法

4.1 获取镜像

4.1.1 拉取最新版本

bash
docker pull sscms/core:latest

4.1.2 拉取指定版本

替换 <版本号> 为具体版本（如 7.0.0）：

bash
docker pull sscms/core:<版本号>

4.2 运行容器

4.2.1 通过本地目录挂载持久化数据

步骤 1：创建本地数据目录
在宿主机当前目录下创建 wwwroot 目录，用于存储站点数据：

bash
mkdir wwwroot

步骤 2：启动容器

bash
docker run -d \
    --name my-sscms \
    -p 80:80 \
    --restart=always \
    -v "$(pwd)"/wwwroot:/app/wwwroot \
    -e SSCMS_SECURITY_KEY=e2a3d303-ac9b-41ff-9154-930710af0845 \
    -e SSCMS_DATABASE_TYPE=SQLite \
    sscms/core:latest

参数说明：

• -d：后台运行容器（守护进程模式）。
• --name my-sscms：自定义容器名称（可替换为其他名称）。
• -p 80:80：端口映射，格式为 宿主机端口:容器端口（如需用 8080 端口访问，可改为 -p 8080:80）。
• --restart=always：容器自动重启策略，必须设置为 always，否则插件安装/升级等操作可能失败。
• -v "$(pwd)"/wwwroot:/app/wwwroot：挂载宿主机当前目录下的 wwwroot 目录至容器内网站根目录，$(pwd) 表示宿主机当前工作目录。
• -e：设置环境变量（详见第 5 节）。

4.2.2 通过 Docker Volume 持久化数据

使用 Docker Volume 存储数据（自动创建 Volume，适合无本地目录管理需求的场景）：

bash
docker run -d \
    --name my-sscms \
    -p 80:80 \
    --restart=always \
    -v volume-sscms:/app/wwwroot \
    -e SSCMS_SECURITY_KEY=e2a3d303-ac9b-41ff-9154-930710af0845 \
    -e SSCMS_DATABASE_TYPE=SQLite \
    sscms/core:latest

说明：命令将自动创建名为 volume-sscms 的 Docker Volume，用于持久化站点数据。

4.3 访问系统

容器启动后，通过 http://localhost 或 [***] 访问 SSCMS 系统（端口需与 -p 参数映射的宿主机端口一致）。

5. 配置说明（环境变量）

SSCMS 通过环境变量读取运行参数，以下为关键配置项说明：

5.1 必选环境变量

SSCMS_SECURITY_KEY

• 描述：客户端与服务器加密通讯的密钥，需为随机 GUID 字符串。
• 示例：e2a3d303-ac9b-41ff-9154-930710af0845
• 备注：必填，建议使用在线 GUID 生成工具生成唯一值。

SSCMS_DATABASE_TYPE

• 描述：指定数据库类型。
• 取值：SQLite、MySQL、SQLServer、PostgreSQL
• 示例：SQLite
• 备注：必填，根据实际使用的数据库类型选择。

5.2 数据库连接配置（非 SQLite 时需设置）

当 SSCMS_DATABASE_TYPE 为 MySQL、SQLServer 或 PostgreSQL 时，需通过以下方式之一配置数据库连接（二选一）：

方式一：分参数配置

• SSCMS_DATABASE_HOST：数据库主机地址（如 localhost、192.168.1.100）。
• SSCMS_DATABASE_PORT：数据库端口（如 MySQL 默认 3306）。
• SSCMS_DATABASE_USER：数据库用户名。
• SSCMS_DATABASE_PASSWORD：数据库用户密码。
• SSCMS_DATABASE_NAME：数据库名称。

方式二：直接配置连接字符串

• SSCMS_DATABASE_CONNECTION_STRING：数据库连接字符串，优先级高于分参数配置。
  示例（MySQL）：Server=localhost;Port=3306;Database=sscms;Uid=root;Pwd=***;

5.3 可选环境变量

SSCMS_REDIS_CONNECTION_STRING

• 描述：Redis 缓存连接字符串（如需使用 Redis 缓存时配置）。
• 示例：localhost:6379,password=***,defaultDatabase=0

5.4 注意事项

• 使用 SQLite 时，数据库文件默认存储于 wwwroot/sitefiles/database.sqlite（通过挂载目录或 Volume 持久化）。
• 环境变量配置后，SSCMS 系统将自动读取并应用，无需额外修改配置文件。