1 什么是wiki
wiki.js是一个开源Wiki应用程序,官网介绍为: A modern, lightweight and powerful wiki app built on NodeJS
访问Github:github 访问Wike:js.wiki
省流总结
- 开源知识库平台,和语雀有一样的功能,独立部署;
- wiki支持权限管理、用户管理,可使用markdown格式编辑;
- wiki的部署推荐使用postgres9.5以上版本作为存储;
2 wiki的部署要求
省流:采用linux pg,注意版本依赖是否兼容。
访问requirements:requirements
2.1 requirements总结
Node.js:wiki.js需要Node.js版本16.0.0或更高。 Web服务器:wiki.js需要一个Web服务器来托管wiki页面。常用的Web服务器包括Apache、Nginx和IIS。 数据库:wiki.js支持多种数据库,包括PostgreSQL、MySQL、MariaDB和SQLite。
- 操作系统:wiki.js支持Linux、macOS和Windows。
- Node.js:wiki.js需要Node.js版本16.0.0或更高。
- 数据库:wiki.js支持多种数据库,包括PostgreSQL、MySQL、MariaDB和SQLite。
如果使用Docker来部署wiki.js,则不需要满足这些最低要求。
2.2 详细说明
- 操作系统:wiki.js支持Linux、macOS和Windows。Linux 是wiki.js的推荐平台。
- Node.js:wiki.js需要Node.js版本16.0.0或更高。使用以下命令来检查Node.js的版本:
node -v
如果Node.js的版本低于16.0.0,则需要升级Node.js。
- 数据库:wiki.js支持多种数据库,包括PostgreSQL、MySQL、MariaDB和SQLite。PostgreSQL是wiki.js的推荐数据库。
如果选择使用PostgreSQL作为数据库,则需要安装PostgreSQL。可以使用以下命令来安装PostgreSQL:
代码语言:javascript复制sudo apt install postgresql
3 wiki的部署方式
省流:官方有5种,要用linux。
3.1 5种部署方式
- Docker部署:使用Docker可以快速在任何平台上部署wiki.js。只需运行一个命令即可创建一个wiki.js容器,然后就可以通过浏览器访问。
- Kubernetes部署:使用Kubernetes可以将wiki.js部署到多个节点上。只需创建一个Deployment对象即可。
- Linux部署:在Linux上,可以使用Node.js和Web服务器来部署wiki.js。首先需要安装Node.js和Web服务器,然后下载wiki.js源代码,配置wiki.js,最后启动wiki.js。
- macOS和Windows部署:可以按照Linux部署的步骤来部署wiki.js。
4 关于wiki.js配置文件
wiki.js的配置文件是config.yaml
文件。这个文件包含wiki.js的所有配置选项,包括:
- 数据库配置:指定数据库的类型、主机、端口、数据库名称、用户名和密码。
- 应用程序配置:指定应用程序的名称和版本。
- 安全配置:指定登录方式、用户名和密码。
4.1 这是一个在pg库部署wiki的config.yaml
文件的示例:
代码语言:javascript复制database:
type: postgresql
host: localhost
port: 5432
database: wiki
username: postgres
password: 1qaz2wsx3edc
app:
name: My Wiki
version: 1.0.0
security:
enabled: true
login:
username: admin
password: P@$$w0rd
4.2 配置文件解释
4.2.1 数据库配置
database
部分指定了wiki.js的数据库信息。
type
:数据库的类型。支持PostgreSQL、MySQL、MariaDB和SQLite。host
:数据库主机的地址。port
:数据库的端口号。database
:数据库的名称。username
:数据库的用户名。password
:数据库的密码。
4.2.2 应用程序配置
app
部分指定了wiki.js的应用程序信息。
name
:应用程序的名称。version
:应用程序的版本。
4.2.3 安全配置
security
部分指定了wiki.js的安全配置。
-
enabled
:是否启用登录。 -
login
:登录配置。username
:登录用户名。password
:登录密码。
5 用户指南
5.1 wiki的结构
代码语言:javascript复制根目录:包含wiki的所有文件和目录。
数据库:存储wiki的数据。
配置文件:指定wiki的配置。
模板:用于渲染wiki页面。
插件:用于扩展wiki的功能。
5.2 如何创建页面?
代码语言:javascript复制在Wiki网站上创建页面:在Wiki网站上点击“创建页面”按钮。
使用API创建页面:使用wiki的API来创建页面。
5.3 管理wiki
代码语言:javascript复制用户管理:添加、修改和删除用户。
权限管理:为用户分配权限。
备份和恢复:备份和恢复wiki的数据。
5.4 功能及扩展wiki
可以使用Markdown语法来编辑wiki页面。
wiki提供了多种模板来渲染wiki页面。
可以使用wiki的插件管理器来安装和管理插件。
主题用于更改wiki外观的程序。使用wiki的主题管理器来安装和管理主题。
wiki提供了一个API,可以使用API来访问和管理wiki的数据。