介绍

  • Wiki.js是一个开源项目，基于 NodeJS 构建的现代、轻量级且功能强大的 wiki 应用程序。

  • 旨在提供用户友好的界面和功能，以便个人用户或团队轻松创建和管理自己的知识库和文档。它支持跨平台运行，提供一套强大的功能和工具来帮助用户组织和共享信息。

  • Wiki.js 几乎可以在任何支持 Node.js 的系统上运行。它可以在Linux、macOS、Windows以及Docker/Kubernetes和Heroku等容器解决方案上运行。

安装要求

硬件需求：

  • CPU：2核

  • 内存：Linux最低1GB RAM，Windows 和 macOS 系统需要更多的 RAM，本身程序运行大概用掉70MB 的 RAM。

  • 存储：至少1GB的专用存储空间

  • 网络：正常网络连接。

数据库：

  • 搭配一个简单的 RDBMS 数据库，为了获得最佳性能、功能和未来兼容性，强烈建议使用PostgreSQL。也可以试用MySQLSQL Server等。

  • Wiki.js还与以下数据库系统兼容：

  • MySQL 8.0 或更高版本（部分支持 MySQL 5.7.8，阅读更多）

  • MariaDB 10.2.7 或更高版本

  • MS SQL Server 2012 或更高版本

  • SQLite 3.9 或更高版本

  • 这些引擎（MySQL、MariaDB、MS SQL Server 和 SQLite）在 Wiki.js 的下一个主要版本中将不受支持。如果您计划在未来几年升级到 3.x+，请确保您了解将数据库迁移到 PostgreSQL 的含义。导出 + 导入工具将在发布时/发布后不久提供。

  • 不建议将 SQLite 用于生产部署。

  • 你应已安装这些数据库引擎之一（本地、另一台服务器或使用云服务）。Wiki.js需要一个空数据库，最好是一个唯一的用户/通行证来连接到数据库。

Nodejs：

  • 如果想通过源码来运行，需要Nodejs 12以上的偶数版本，注意是偶数，奇数版本不支持。

  • Node.js 22：版本 22.0 或更高版本。（自 v2.5.302 起）

部署方式

  • 如果是使用Docker方式部署，无需在计算机上安装Node.js！它已包含在 Docker 映像中。

支持的浏览器

  • 支持以下浏览器：

  • Google Chrome（包括 Android 版本）

  • Mozilla Firefox浏览器

  • Microsoft边缘

  • Apple Safari（包括 iOS 版本）

  • 请注意，仅支持这些浏览器的最新稳定版本。默认情况下，所有浏览器都会在后台自动更新。

  • 与 IE11 的兼容性有限。用户将能够阅读内容，但不能执行任何编辑操作或使用交互功能。

安装教程

docker-compose方式安装

  1. 演示以在群晖NAS系统上安装为例
    （其他系统请自行安装好最新版本Docker、docker-compose）

  2. 打开群晖的SSH功能，使用终端软件进行连接，并切换到root状态下。

  3. 进入群晖的docker文件夹（你想将容器数据存储到哪就进哪个文件夹）

    cd /volume1/docker

  4. 创建项目文件夹及子文件夹
    （如果部署后提示无访问权限的话就将wiki项目文件夹的权限设置为777，任何人都可以读写。）

    #db-data是数据库文件夹
#home是存储文章页面的文件夹，会自动在里面创建wiki子文件夹。

mkdir -p wiki/{db-data,home}

  5. 进入项目文件夹

    cd wiki

  6. 编辑docker-compose.yml文件

    vi docker-compose.yml

  7. 按字母 i 键进入编辑模式，复制并修改下面的配置文件，粘贴到终端，按Esc键退出编辑模式，输入 :wq 退出并保存。