使用Docker部署WikiDocs文档管理工具详解
<div id="navCategory"><h5 class="catalogue">目录</h5><ul class="first_class_ul"><li><a href="#_label0">一、WikiDocs介绍</a></li><ul class="second_class_ul"><li><a href="#_lab2_0_0">1.1 WikiDocs 简介</a></li><li><a href="#_lab2_0_1">1.2 WikiDocs 主要特点</a></li></ul><li><a href="#_label1">二、本次实践规划</a></li><ul class="second_class_ul"><li><a href="#_lab2_1_2">2.1 本地环境规划</a></li><li><a href="#_lab2_1_3">2.2 本次实践介绍</a></li></ul><li><a href="#_label2">三、本地环境检查</a></li><ul class="second_class_ul"><li><a href="#_lab2_2_4">3.1 检查Docker服务状态</a></li><li><a href="#_lab2_2_5">3.2 检查Docker版本</a></li><li><a href="#_lab2_2_6">3.3 检查docker compose 版本</a></li></ul><li><a href="#_label3">四、拉取WikiDocs镜像</a></li><ul class="second_class_ul"></ul><li><a href="#_label4">五、部署WikiDocs服务</a></li><ul class="second_class_ul"><li><a href="#_lab2_4_7">5.1 创建部署目录</a></li><li><a href="#_lab2_4_8">5.2 编辑部署文件</a></li><li><a href="#_lab2_4_9">5.3 创建WikiDocs容器</a></li><li><a href="#_lab2_4_10">5.4 查看WikiDocs容器状态</a></li></ul><li><a href="#_label5">六、访问WikiDocs服务</a></li><ul class="second_class_ul"><li><a href="#_lab2_5_11">6.1 初始化安装</a></li><li><a href="#_lab2_5_12">6.2 访问WikiDocs</a></li></ul><li><a href="#_label6">七、WikiDocs基本使用</a></li><ul class="second_class_ul"><li><a href="#_lab2_6_13">7.1 设置中文</a></li><li><a href="#_lab2_6_14">7.2 编辑文档</a></li><li><a href="#_lab2_6_15">7.3 查看文章效果</a></li></ul><li><a href="#_label7">八、总结</a></li><ul class="second_class_ul"></ul></ul></div><p class="maodian"><a name="_label0"></a></p><h2>一、WikiDocs介绍</h2><p class="maodian"><a name="_lab2_0_0"></a></p><h3>1.1 WikiDocs 简介</h3>
<p><code>WikiDocs</code> 是一款开源的、无需数据库的 Markdown 静态文件 Wiki 引擎，以纯文本文件为基础存储内容，轻量高效，适合个人知识管理与团队文档协作。</p>
<p class="maodian"><a name="_lab2_0_1"></a></p><h3>1.2 WikiDocs 主要特点</h3>
<ul><li><strong>开源</strong>：代码完全开放，便于审查、定制和自由使用。</li><li><strong>纯文本文件</strong>：所有内容以普通文件形式保存，便于版本控制和备份。</li><li><strong>无需数据库</strong>：直接读写文件系统，部署简单，维护成本低。</li><li><strong>Markdown 语法</strong>：使用标准 Markdown 编写内容，简洁易读易写。</li><li><strong>编辑器全功能所见即所得（WYSIWYG）</strong>：实时预览编辑效果，提升写作体验。</li><li><strong>支持数学公式 KaTeX</strong>：轻松渲染复杂的数学表达式，适合技术与学术文档。</li><li><strong>无限页面版本记录</strong>：自动保存每次修改，可随时回溯历史内容。</li><li><strong>支持附件上传与下载</strong>：方便附加文档、资料等文件资源。</li><li><strong>支持图片上传（包括剪贴板粘贴）</strong>：可直接粘贴截图或上传图片，图文并茂更直观。</li><li><strong>支持命名空间分类内容</strong>：通过命名空间组织页面，结构清晰易于管理。</li><li><strong>自动生成索引和站点地图</strong>：自动整理页面结构，便于导航与搜索引擎发现。</li><li><strong>支持公开与私有浏览模式</strong>：可灵活控制页面访问权限，保护敏感信息。</li><li><strong>语法高亮</strong>：代码块自动高亮显示，提升技术文档可读性。</li><li><strong>多语言支持</strong>：适配多种语言界面，满足国际化使用需求。</li><li><strong>暗色模式</strong>：提供护眼暗色主题，适应不同环境下的阅读习惯。</li><li><strong>站点地图（Sitemap）</strong>：生成标准 Sitemap 文件，有利于 SEO 优化。</li><li><strong>更多功能</strong>：持续更新，集成实用特性，满足多样化文档需求。</li></ul>
<p class="maodian"><a name="_label1"></a></p><h2>二、本次实践规划</h2>
<p class="maodian"><a name="_lab2_1_2"></a></p><h3>2.1 本地环境规划</h3>
<p>本次实践为个人测试环境，操作系统版本为 Ubuntu 24.04.2 LTS。</p>
<table><thead><tr><th>hostname</th><th>IP地址</th><th>操作系统版本</th><th>Docker版本</th><th>部署项目</th></tr></thead><tbody><tr><td>jeven01</td><td>192.168.3.88</td><td>Ubuntu 24.04.2 LTS</td><td>28.3.3</td><td>WikiDocs</td></tr></tbody></table>
<p class="maodian"><a name="_lab2_1_3"></a></p><h3>2.2 本次实践介绍</h3>
<p>1.本次实践部署环境为个人测试环境，生产环境请谨慎；</p>
<p>2.在Docker环境下部署WikiDocs文档管理工具。</p>
<p class="maodian"><a name="_label2"></a></p><h2>三、本地环境检查</h2>
<p class="maodian"><a name="_lab2_2_4"></a></p><h3>3.1 检查Docker服务状态</h3>
<p>检查Docker服务是否正常运行，确保Docker正常运行。</p>
<div class="jb51code"><pre class="brush:bash;">root@jeven:~# systemctl status docker
● docker.service - Docker Application Container Engine
Loaded: loaded (/usr/lib/systemd/system/docker.service; enabled; preset: enabled)
Active: active (running) since Mon 2025-08-04 10:10:52 UTC; 30min ago
TriggeredBy: ● docker.socket
Docs: https://docs.docker.com
Main PID: 860 (dockerd)
Tasks: 10
Memory: 97.2M (peak: 98.4M)
CPU: 606ms
CGroup: /system.slice/docker.service
</pre></div>
<p class="maodian"><a name="_lab2_2_5"></a></p><h3>3.2 检查Docker版本</h3>
<p>检查Docker版本</p>
<div class="jb51code"><pre class="brush:bash;">root@jeven:~# docker -v
Docker version 28.3.3, build 980b856
</pre></div>
<p class="maodian"><a name="_lab2_2_6"></a></p><h3>3.3 检查docker compose 版本</h3>
<p>检查Docker compose版本，确保2.0以上版本。</p>
<div class="jb51code"><pre class="brush:bash;">root@jeven:~# docker -v
Docker version 28.3.3, build 980b856
</pre></div>
<p class="maodian"><a name="_label3"></a></p><h2>四、拉取WikiDocs镜像</h2>
<p>拉取WikiDocs容器镜像，当前最新版本为<code>zavy86/wikidocs:1</code>.</p>
<div class="jb51code"><pre class="brush:bash;">docker pull zavy86/wikidocs:1
</pre></div>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362497.png" /></p>
<p class="maodian"><a name="_label4"></a></p><h2>五、部署WikiDocs服务</h2>
<p class="maodian"><a name="_lab2_4_7"></a></p><h3>5.1 创建部署目录</h3>
<ul><li>创建部署目录</li></ul>
<div class="jb51code"><pre class="brush:bash;">mkdir -p /data/wikidocs/data &&cd /data/wikidocs
</pre></div>
<ul><li>目录授权</li></ul>
<div class="jb51code"><pre class="brush:bash;">chmod -R 755 /data/wikidocs/
</pre></div>
<p class="maodian"><a name="_lab2_4_8"></a></p><h3>5.2 编辑部署文件</h3>
<p>在部署目录下，创建docker-compose.yaml文件，内容如下所示：</p>
<div class="jb51code"><pre class="brush:bash;">vim docker-compose.yaml
</pre></div>
<div class="jb51code"><pre class="brush:yaml;">version: '3'
services:
wikidocs:
image: zavy86/wikidocs:1
container_name: wikidocs
restart: always
ports:
- 5200:80
volumes:
- /data/wikidocs/data:/datasets
environment:
- PUID=1000
- PGID=1000
</pre></div>
<p class="maodian"><a name="_lab2_4_9"></a></p><h3>5.3 创建WikiDocs容器</h3>
<p>执行以下命令，创建WikiDocs容器。</p>
<div class="jb51code"><pre class="brush:bash;">docker compose up -d
</pre></div>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362442.png" /></p>
<p class="maodian"><a name="_lab2_4_10"></a></p><h3>5.4 查看WikiDocs容器状态</h3>
<p>检查WikiDocs容器运行状态，确保WikiDocs容器正常启动。</p>
<div class="jb51code"><pre class="brush:bash;">root@jeven:/data/wikidocs# docker compose ps
WARN /data/wikidocs/docker-compose.yaml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion
NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
wikidocs zavy86/wikidocs:1 "/start.sh" wikidocs 28 seconds ago Up 28 seconds 0.0.0.0:5200->80/tcp, [::]:5200->80/tcp
</pre></div>
<p class="maodian"><a name="_label5"></a></p><h2>六、访问WikiDocs服务</h2>
<p class="maodian"><a name="_lab2_5_11"></a></p><h3>6.1 初始化安装</h3>
<p>浏览器地址： <code>http://<个人的服务器IP>:5200</code>，访问WikiDocs的初始页。如果无法访问，请确保宿主机的防火墙已关闭或已放行相关端口，对于云服务器还需配置相应的安全组规则。</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362513.png" /></p>
<p><code>环境检查</code>：系统将自动检测当前安装环境，当所有检测项均显示为绿色对勾时，表示环境正常，可点击“继续”进入下一步。</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362596.png" /></p>
<p>填写相关配置信息，可参考如下：</p>
<ul><li><code>Owner</code>：内容的所有者</li><li>-<code> Notice</code>：内容版权声明</li><li><code>Edit authentication code</code>：自定义填写密码</li><li><code>Repeat edit authentication code</code>：确认密码</li></ul>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362543.png" /></p>
<p>确认配置信息，点击继续下一步。</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362566.png" /></p>
<p>出现以下提示，则表示安装完成。</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362524.png" /></p>
<p class="maodian"><a name="_lab2_5_12"></a></p><h3>6.2 访问WikiDocs</h3>
<p>点击按照你完成界面的“continue”，则进入到WikiDocs首页。</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362564.png" /></p>
<p class="maodian"><a name="_label6"></a></p><h2>七、WikiDocs基本使用</h2>
<p class="maodian"><a name="_lab2_6_13"></a></p><h3>7.1 设置中文</h3>
<p>在WikiDocs首页，我们点击右上角的“小锁”图标。</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362549.png" /></p>
<p>输入之前我们设置的访问密码后，如下所示：</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362536.png" /></p>
<p>点击右上角的“齿轮”图标，进入WikiDocs系统设置界面。</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362532.png" /></p>
<p>将系统语言设置为简体中文后，点击“save”保存即可。</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362516.png" /></p>
<p class="maodian"><a name="_lab2_6_14"></a></p><h3>7.2 编辑文档</h3>
<p>点击新增文档选项，操作如下所示：</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362574.png" /></p>
<p>设置路径：我们需要输入新文档路径，例如参数/章节/标题这种，如下所示：</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362532.png" /></p>
<p>编辑文档后，点击保存即可。</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362553.png" /></p>
<p class="maodian"><a name="_lab2_6_15"></a></p><h3>7.3 查看文章效果</h3>
<p>文章保存后，可识别markdown语法，效果如下所示：</p>
<p style="text-align:center"><img alt="" src="https://img.jbzj.com/file_images/article/202512/2025121908362541.png" /></p>
<p class="maodian"><a name="_label7"></a></p><h2>八、总结</h2>
<p>本次实践通过Docker成功部署了WikiDocs文档管理工具，整个过程简洁高效，体现了容器化部署的优势。</p>
<p>WikiDocs基于Markdown的轻量设计和丰富的功能特性，非常适合用于个人或团队的知识管理。通过简单的目录映射和配置，实现了数据的持久化与服务的稳定运行。未来可进一步探索其权限管理、多用户协作等高级功能，提升文档管理效率。</p>
<p>以上为个人经验，希望能给大家一个参考，也希望大家多多支持琼殿技术社区。</p>
頁:
[1]