介绍
Wizard是一款开源文档管理系统,支持三种格式类型的文档管理,分别是Markdown、Swagger和Table,以便于满足不同场景和不同需求下的文档管理,Markdown类型是当下比较常用的文档类型,虽然已经满足大多数需求,但是当需求变得复杂,那么使用起来就相对不太够了!
开源地址
码云:https://gitee.com/orionis/wizard Github:https://github.com/mylxsw/wizard
功能清单
目前Wizard已经包含了以下功能,相对于很多单调的文档管理系统,Wizard显得就要丰富的多了
- Swagger,Markdown,Table 类型的文档管理
- 文档修改历史管理
- 文档修改差异对比
- 用户权限管理
- 项目分组管理
- LDAP 统一身份认证
- 文档搜索,标签搜索
- 阅读模式
- 文档评论
- 消息通知
- 文档分享
- 统计功能
- 流程图,序列图,饼图,Tex LaTex 科学公式支持
- 多主题切换
页面截图
部署方式
目前支持两种方式部署,分别是Docker部署和普通手动部署,如果了解一点Docker建议使用Docker部署,相对手动部署要简单不少,一下就是Docker部署方式,手动部署可以参考码云或者Github上详细的介绍
- 方法一
首先对于新安装用户,需要执行数据库的初始化
docker run -it --rm --name wizard \
-e DB_HOST=host.docker.internal \
-e DB_PORT=3306 \
-e DB_DATABASE=wizard \
-e DB_USERNAME=wizard \
-e DB_PASSWORD=wizard \
mylxsw/wizard 初始化命令
这里的 初始化命令 包含两个,依次执行即可
- php artisan migrate:install
- php artisan migrate
最后,直接运行下面的 Docker 命令即可
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 /Users/mylxsw/Downloads:/webroot/storage/app/public \
mylxsw/wizard
- 方法二
我们需要创建一个Dockerfile,在Dockerfile中添加环境配置,比如我采用了宿主机上安装的MySQL服务器,就有了下面的这段Dockerfile配置
FROM mylxsw/wizard:latest
# 数据库连接配置
# 这里可以根据需要添加其它的Env配置,可用选项参考项目的.env.example文件
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
# 访问地址,只有正确配置后,导出的 markdown 文档图片才能正常展示
ENV APP_URL=http://localhost:8080
# 文件上传存储目录
VOLUME /webroot/storage/app/public