轻量级自托管维基百科OtterWiki

这是老苏最后一篇存稿,未来的更新将转为不定期形式。

简介

什么是 OtterWiki ?

OtterWiki 是一个基于 PythonMarkdownGit 的极简主义 Wiki。它使用 Flask 微框架作为后端,内容存储在一个 Git 仓库中,这使得所有变更都能被追踪。其目标是提供一个界面简洁、功能实用的 Wiki 解决方案。

主要特点

  • 简约界面:提供极简的用户界面,支持黑暗模式。
  • Markdown 编辑器:内置方便的 Markdown 编辑工具,支持表格、脚注、图表等扩展功能。
  • 文件上传与附件:用户可以将文件上传至页面,或直接在编辑器中粘贴图像。
  • 版本跟踪:允许比较修订版本并恢复更改。
  • 用户身份验证:支持自注册和密码恢复功能,确保安全性。
  • 自定义侧边栏:用户可以创建菜单和/或页面索引以便于导航。
  • 实验性 Git HTTP 服务器:允许用户克隆、拉取和推送维基内容。
  • 可扩展性:支持通过 Git 进行内容管理,使其适合团队协作。

应用场景

  • 个人知识管理:用户可以使用 OtterWiki 管理个人笔记、学习材料和其他信息。
  • 团队协作:团队可以利用此平台来共享项目文档、会议记录和知识库。
  • 文档管理:适合用于技术文档、用户手册和其他需要版本控制的文档。
  • 教育用途:教师和学生可以使用 OtterWiki 创建学习资源和共享知识。

OtterWiki 通过其简洁的设计和强大的功能,成为了一个理想的内容管理工具,适合各种规模的用户和团队。

安装

在群晖上以 Docker 方式安装。

在注册表中搜索 otterwiki ,选择 redimp/otterwiki,版本选择 latest

本文写作时, latest 对应的版本是 2.14.0

docker 文件夹中,创建一个新文件夹 otterwiki,并在其中建一个子文件夹 data

文件夹 装载路径 说明
docker/otterwiki/data /app-data 存放 Wiki 的所有数据,包括页面、附件和配置文件

端口

本地端口不冲突就行

本地端口 容器端口
3422 80

默认没有对外暴露端口

需要点 + 号自己添加

命令行安装

如果你熟悉命令行,可能用 docker cli 更快捷

1
2
3
4
5
6
7
8
9
10
11
12
13
# 新建文件夹 otterwiki 和 子目录
mkdir -p /volume1/docker/otterwiki/data

# 进入 otterwiki 目录
cd /volume1/docker/otterwiki

# 运行容器
docker run -d \
--restart unless-stopped \
--name otterwiki \
-p 3422:80 \
-v $(pwd)/data:/app-data \
redimp/otterwiki:latest

也可以用 docker-compose 安装,将下面的内容保存为 docker-compose.yml 文件

1
2
3
4
5
6
7
8
9
10
11
version: '3.8'

services:
otterwiki:
image: redimp/otterwiki:latest
container_name: otterwiki
restart: unless-stopped
ports:
- 3422:80
volumes:
- ./data:/app-data

然后执行下面的命令

1
2
3
4
5
6
7
8
9
10
# 新建文件夹 otterwiki 和 子目录
mkdir -p /volume1/docker/otterwiki/data

# 进入 otterwiki 目录
cd /volume1/docker/otterwiki

# 将 docker-compose.yml 放入当前目录

# 一键启动
docker-compose up -d

运行

在浏览器中输入 http://群晖IP:3422 就能看到主界面

需要注册一个用户。第一个帐户是管理员帐户,允许您访问设置选项卡

登录成功后

现在可以根据自己的喜好自定义设置

写了第一篇,也就是本文的前半部分

参考文档

redimp/otterwiki: A minimalistic wiki powered by python, markdown and git.
地址:https://github.com/redimp/otterwiki

Home – An Otter Wiki
地址:https://otterwiki.com/