一、前言
大家好,我是攻城狮阿程。由于最近接到很多客户搭建Mrdoc觅思文档,但大多数客户的需求是想拥有一个能够展示自己内容的Wiki,因此今天阿程就给大家再带来一款无数据库的开源Wiki容器应用 —— WikiDocs,这样自己通过内网穿透或极空间远程访问功能就可以在任何时间任何地点编辑自己喜欢的内容进行对外展示了。
码字不易,喜欢我的教程欢迎各位多提建议多评论,畅所欲言,涉及破解、打倒美帝走近科学和资源分享的教程容易被和谐,也欢迎各位关注我的公众号和博客,以防走丢。
公众号:攻城狮阿程
知乎:攻城狮阿程
小红书:果冻橙是橘子吗の快乐生活
个人博客:strider1230.cn
淘宝:阿程数码
抖音炉石传说:果冻橙是橘子吗
B站炉石传说:果冻橙是橘子吗
1.1 软件介绍
WikiDocs 是一个无数据库的开源 Markdown 文件平面 Wiki 引擎。它旨在提供一个简单、灵活且易于使用的 Wiki 解决方案,允许用户创建和管理文档而无需依赖传统数据库。
1.2 软件特点
WikiDocs 主要有以下 9
个特色:
-
无数据库:使用纯文本文件存储数据,简化了部署和维护过程。
-
Markdown 支持:支持 Markdown 语法,方便用户格式化文本。
-
所见即所得(WYSIWYG)编辑器:提供用户友好的编辑体验。
-
数学公式支持:集成 KaTeX,允许用户插入数学公式。
-
版本控制:支持无限的页面修订记录。
-
附件管理:允许上传和下载附件,包括图片。
-
内容分类:支持命名空间来组织内容。
-
自动生成索引和网站地图:便于内容的浏览和索引。
-
多语言和深色模式支持:满足不同用户的需求。
1.3 部署容器前你可能需要一块固态硬盘
我教程内展示的容器都是配置在固态硬盘上的,建议想多搭容器及虚拟机的朋友在执行教程前先准备一块固态硬盘,容器、虚拟机安装在固态硬盘的好处如下:
-
不会干扰机械硬盘的休眠,使得机械硬盘始终扮演数据保存的角色
-
部署在固态硬盘内的容器、虚拟机调用以及响应的速度都比机械硬盘好
-
容器若发生泄露,不会污染、破坏你的机械硬盘内的数据
1.4 M.2接口 SSD 固态硬盘的适配
Z4系列的M.2接口支持高速存储
、只读缓存
等功能,如果是要在固态硬盘内部署虚拟机、容器服务等,需要选择高速存储
功能;
-
仅支持M.2接口 NVMe 2280 的SSD固态硬盘,其中2280指的是长度;
-
官方说由于PCIe4.0自身的兼容性问题,极空间暂时不支持PCIe4.0的SSD,但是实验下来是支持PCIe4.0的固态的,只是安装上去以后该固态硬盘的温度会比PCIe3.0的固态硬盘高10℃左右,因此买的时候要还是建议选择PCIe3.0的SSD;
-
设置只读缓存时,Z4系列8G-16G内存的产品建议选购256G容量;16G及以上内存的产品建议选购512G容量;(PS:极空间Z4Pro 是支持DDR5 32G 4800MHz的笔记本电脑内存哦)
-
设置高速存储时,SSD不得小于32GB,最大支持4T;
-
建议选购大品牌的SSD,这里推荐一个我用了两年的:致钛tiplus5000 1TB/2TB,京东和淘宝上都有货源;
* 请选择耐用 SSD。由于 SSD 的寿命受限于有限的写入次数,请确保使用耐用性更高的 SSD,以防止潜在风险。
1.5 应用截图
1.6 在线演示
官方提供了在线演示:https://demo.wikidocs.it
验证码为:demo
二、部署 Wikidocs 容器
2.1 下载 Wikidocs 官方镜像
2.1.1 通过极空间的 Docker 管理页面拉取(确保镜像源的选择:Docker Hub)
在左侧边栏选择“镜像”,然后点击“仓库”,接着再点击“自定义拉取”按钮后,点击“自定义拉取”按钮,在弹出的对话框中输入zavy86/wikidocs
拉取镜像,点击拉取,等待拉取完成。
2.1.2 导入其他来源获取的镜像(如极空间用户之间的闪电传)
部分用户可能没有科学上网环境,也不会按上述步骤配置镜像站,导致镜像无法远程拉取,可以通过其他下载途径进行下载,或使用极空间本身提供的闪电传、文件分享功能获取链接下载。
2.2 配置 WikiDocs 容器
第一步:在本地镜像找到拉取到的镜像,点击添加到容器;
第二步:为了防止极空间突然因停电或升级等原因重启,因此需要勾选上极空间开机后自动启动此容器
选项,这里建议勾选调用核心显卡
,对页面展示会有聊胜于无的帮助,最后把特权模式
勾选上,该项是开启极空间SSH功能后才会出现,开启有助于容器不会因为奇怪的权限问题反复重启;
第三步:容器需要配置本地文件夹路径以便基础数据存放,可按下图配置路径,这里需要说明的是如果没有固态硬盘而配置在机械盘里面的话,那么你的机械硬盘可能无法休眠,将会一直工作,因此建议是配置在固态硬盘中。
第四步:如下图所示配置网络和端口号即可,其中端口号:25600 是我设置的页面端口号,如果遇到端口冲突的情况,请自行设置其他高位端口;
第五步:如下图所示设置环境变量,并点击应用
完成所有配置。
第六步:完成以上之后看到容器显示“运行中”,就说明可以使用了。
三、 程序测试
3.1 测试登录程序前端页面
使用浏览器打开你极空间的“IP : Wikidocs 端口号:25600
(容器端口默认为80
),能够看到下图所示初始化配置界面说明 Wikidocs 已经部署成功。
3.2 测试通过极空间自带的远程登录功能进行访问
第一步:先点击极空间的“远程访问”图标;
第二步:在弹出的对话框中点击“添加新的链接“按钮;
第三步:在弹出的”编辑远程访问“对话框中,备注栏填写:Wikidocs
,地址栏填写:"你极空间容器的IP地址:25600",点击“保存”按钮。
四、Wikidocs 的初始化配置&演示(搭配内网穿透使用效果最佳)
4.1 初始化配置
① 第一次打开会看到如下图所示界面,清晰列出了容器服务运行的各项依赖都已是否具备,点击Continue
即可。
② 这里大家根据需要填写信息,各参数解释如下:
-
Owner
:内容的所有者 -
Notice
:内容版权声明,例如:Copyright © All rights reserved
-
Edit authentication code
:验证码,也就是密码 -
Repeat edit authentication code
:重复验证码
③ 出现下述页面确认信息,确认无误直接点击Continue
即可。
④ 弹出以下页面表示设置完成,点击绿色字体的Continue
。
4.2 调整页面语言为中文
① 点击右上角🔐图标,输入之前配置的密码,进入Setting
设置界面。
② 在 Language
中选择 中文(简体)
,建议 Timezone
时区也可以顺手改为 Asia/Shanghai
,点击Save
保存。
③ 保存之后,可以看到主页界面上已经有部分显示内容转换为中文了。
4.3 编辑文章
① 在主页点 + 号添加新文档。
② 设置路径,这里需要注意的是,虽然输入有大写,但程序会自动全部改为小写,这里我们新建一个aipan网盘聚合搜项目的路径,可以看到WikiDocs已经自动跳转到文章编辑页面了。
③ 文章编辑好以后就可以点击右上角的💾按钮进行保存。
④ 切换到主页后就可以直接看到刚才编辑的文章了。
⑤ 点击文章后即可进入阅读界面,可以看到排版还是很好的。
4.4 修改文章路径
① 在极空间的个人空间中进行查看,是可以看到刚刚编辑保存的aipan文章的路径的。
② 如果你要在极空间的个人空间内直接修改刚才的文章路径,记得只能用小写字母,否则Wikidocs
会报错。
4.5 左侧导航栏
① 如果大家想让左侧的导航栏显示内容,需要将文章路径调整的与homepage文件夹并列才可以显示,如下图所示:
② 最后放一下自用的Z4Pro性能版的信息,CPU为英特尔的i3-N305,8核心8线程,3.8GHz最大频率,核显为UHD,跑该Wiki容器很轻松啦。
4.6 一些常见问题的解答
Q1:可以用这个容器来做个人内容展示吗?
A:可以,其实在写这篇文章之前,就已经有很多用户这样使用了。
Q2:我的固态硬盘容量小,可以把这个容器的录制内容存放路径改到机械硬盘上吗?
A:可以,只要你能忍受机械硬盘不休眠。
Q3:我可以在极空间的虚拟机上布置该项目吗?
A:可以,但是没有必要。因为极空间的虚拟机目前仍未开放显卡直通功能,你部署上去就无法享受极空间CPU上微博的显卡加速功效了。
Q4:这个容器比 Mrdoc 强在哪里?
A:相较于Mrdoc,首先Wikidocs强在轻量化,麻雀虽小但五脏俱全,其次是有很多能够自定义的属性,比如版权说明,谷歌标签等内容。
Q5:这个容器可以在通过极空间远程访问功能进行初始化和编辑吗?
A:目前测试下来,远程访问功能进入该容器后存在无法跳转密码输入界面的问题,建议有条件的同学还是上内网穿透比较好。
五、结语
Wikidocs 这个轻量化的Wiki容器应用能够方便快捷地帮助很多人建立自己的内容展示页,有了它你可以在Mrdoc之外多出一种选择,如果你想要展示的内容不需要用户去输入访问验证进行访问,那么强烈推荐此容器应用。虽然项目使用时的CPU占用不高,但是个人建议搭建该容器的话NAS处理器至少得是N97这个级别往上,内存至少有16G以上,所以如果是长期用的话,我个人比较推荐用Z4Pro性能版及更高配置的设备部署。
如果你看完教程还是觉得部署很困难,也可以扫描下方二维码进入我的淘宝小店——阿程数码,直接购买对应的极空间 Docker 服务,我会远程帮你有偿部署。