mylxsw/wizard

Wizard 文档管理系统 Docker 镜像

镜像概述和主要用途

Wizard 是一款开源文档管理系统，专注于团队文档协作与管理。它支持 Markdown、Swagger（OpenAPI 3.0）和 Table（类 Excel 表格）三种文档类型，提供文档全生命周期管理功能，包括修改历史追踪、差异对比、权限控制、LDAP 统一身份认证等，适用于研发团队日常文档交流、API 文档管理及表格数据协作。

核心功能和特性

支持的文档类型

• Markdown：核心文档类型，基于 Editor.md 扩展，支持文档模板、Json 转表格、图片粘贴上传等增强功能。
• Swagger：支持 OpenAPI 3.0 规范，集成 Swagger 官方编辑器，提供文档模板、全屏编辑及自动同步功能。
• Table：类 Excel 电子表格，基于 x-spreadsheet 实现，目前处于完善阶段。

主要功能

• 多类型文档（Swagger、Markdown、Table）统一管理
• 文档修改历史记录与版本回溯
• 文档修改内容差异对比
• 细粒度用户权限管理
• 项目分组与组织
• LDAP 统一身份认证集成
• 文档全文搜索与标签搜索
• 阅读模式优化
• 文档评论与讨论功能
• 消息通知机制
• 文档分享功能
• 系统使用统计分析

使用场景和适用范围

• 研发团队文档协作：管理需求文档、设计文档、技术方案等 Markdown 文档。
• API 文档管理：编写、维护符合 OpenAPI 3.0 规范的 Swagger 文档，支持自动同步。
• 表格数据协作：创建和管理类 Excel 表格，用于数据收集、统计等场景。
• 团队知识库建设：集中存储和管理团队知识资产，支持权限控制和搜索。

使用方法和配置说明

方法一：直接运行 Docker 命令

通过以下命令快速启动 Wizard 服务，需提前准备 MySQL 数据库。

bash
docker run -d --name wizard \
    -e DB_HOST=host.docker.internal \
    -e DB_PORT=3306  \
    -e DB_DATABASE=wizard  \
    -e DB_USERNAME=wizard  \
    -e DB_PASSWORD=wizard  \
    -p 8080:80 \
    -v /本地目录:/webroot/storage/app/public   \
    mylxsw/wizard

参数说明：

• -d：后台模式运行容器。
• -e：设置环境变量，覆盖默认配置（如数据库连接信息）。
  • DB_HOST：MySQL 数据库主机地址（如使用本地数据库，可设为 host.docker.internal）。
  • DB_PORT：MySQL 端口，默认 3306。
  • DB_DATABASE：数据库名称，建议设为 wizard。
  • DB_USERNAME：数据库用户名。
  • DB_PASSWORD：数据库密码。
• -p 8080:80：端口映射，将容器内 80 端口映射到宿主机 8080 端口，通过 http://localhost:8080 访问。
• -v /本地目录:/webroot/storage/app/public：挂载文件存储目录，避免容器重启导致上传的图片等数据丢失，需将 /本地目录 替换为实际本地路径。

方法二：通过 Dockerfile 构建

1. 创建 Dockerfile

dockerfile
FROM mylxsw/wizard

# 数据库连接配置
ENV DB_CONNECTION=mysql
ENV DB_HOST=host.docker.internal
ENV DB_PORT=3306
ENV DB_DATABASE=wizard_2
ENV DB_USERNAME=wizard
ENV DB_PASSWORD=wizard
ENV WIZARD_NEED_ACTIVATE=false
# 文件上传存储目录
VOLUME /webroot/storage/app/public
# 应用访问地址
APP_URL=http://localhost:8080

RUN php artisan config:cache

2. 构建镜像

bash
docker build -t my-wizard .

3. 数据库初始化

执行数据库迁移命令初始化表结构：

bash
docker run -it --rm --name my-wizard my-wizard php artisan migrate:install
docker run -it --rm --name my-wizard my-wizard php artisan migrate

4. 运行容器

bash
docker run -it --rm --name my-wizard -p 8080:80  my-wizard

镜像更新

获取最新版本镜像：

bash
docker pull mylxsw/wizard:latest

项目地址

https://github.com/mylxsw/wizard