本篇文章记录如何在 CentOS 系统上部署 ShowDoc 文档管理系统。我们将使用 Docker 安装。
ShowDoc 介绍
ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。
它可以用来做什么
-
API文档( 查看Demo)
- 随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。
-
数据字典( 查看Demo)
- 一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
-
说明文档 ( 查看Demo)
- 你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅
Docker 安装
登 录 本 地 服 务 器, 切 换 到 root 用 户, 使 用 以 下 命 令 进 行 安 装。
yum install docker
启 动 Docker 服 务 启 动 命 令 如 下 所 示。
service docker start
设 置 Docker 服 务 为 开 机 启 动 设 置 命 令 如 下 所 示。
chkconfig docker on
安装 Git
借 助 yum 命 令, 安 装 git 安 装 命 令 如 下 所 示。
yum install git
安 装 ShowDoc 从 GitHub 上 复 制 代 码 到 本 地 某 个 目 录, 这 里 进 入 根 目 录 下 的 test 文 件 夹。
cd /test
git clone -o gitbug https://github.com/star7th/showdoc
进 入 ShowDoc 目 录 开 始 安 装
cd showdoc/
docker build -t showdoc ./
docker run -d --name showdoc -p 4999: 80 showdoc
访 问 ShowDoc
在 浏 览 器 中 输 入 网 址 http://192.168.132.132:4999/install/, 打 开 页 面,进入安装步骤。
注 意 将 IP 地 址 及 端 口 号 替 换 成 用 户 自 己 服 务 器 的 IP 地 址
选 择 语 言( 默 认 为 中 文), 单 击“ OK” 按 钮, 弹 出 安 装 成 功 提 示 框。
其他
备 份 API 文 档 是 非 常 重 要 的 文 档, 需 定 期 备 份。
/XXX/showdoc/Sqlite
下 面 有 个 showdoc.db.php 文 件, 定 期 备 份 该 文 件 即 可。 用 户 可 以 采 用 手 动 命 令 备 份, 使 用 如 下 mv 命 令。
mv /XXX/ showdoc/ Sqlite/ showdoc.db.php
如果你觉得本篇文章对你有帮助,欢迎点赞分享~
推荐阅读: