Wiki.js安装部署实操手册

目录

• 前言
• 安装要求
  • 服务器
    • CPU
    • 内存
    • 存储
    • 网络
  • 域名
  • 数据库
  • Node.js
  • 浏览器
• 环境准备
  • Docker
  • PostgreSQL部署
  • Node.js安装
• Wiki.js
  • 部署
• 总结
  • COMING SOON
  • 文档搜索不支持中文
  • 不支持匿名用户访问
  • 开发人员数量可怜

前言

习惯的力量是很强大的。记得刚开始那会儿使用Markdown的时候各种变扭，可是输出的文档格式真心很整洁啊！时间一长，看着自己精心编写的文档复制粘贴到公司Wiki变成“扭曲”的形态，内心真是一忍再忍。最近几天一直在研究提升工作效率的事情，技术文档是其中很重要的一项，琢磨着自己动手吧，毕竟开源的力量也是很强大的。

通过Baidu、Google在各种项目之间徘徊，有的很长时间没有更新，有的功能太过简陋，纠结了很长时间，感兴趣的同学可以使用关键字“Wiki Markdown”自行搜索了解一下。无意间浏览到Wiki.js，打开官网的那一刻，瞬间被Wiki.js那华丽的页面吸引，如下图：

详细阅读文档后，觉得基本可以满足需求，应该可以部署实际感受一下。考虑到依赖组件过多，特别是涉及Node.js、PostgreSQL的部分自己并不熟悉，决定详细记录一下“踩坑”的过程，供大家参考。

安装要求

服务器

CPU

2核或以上。

内存

1 GB或以上。

存储

1 GB或以上。

网络

自动更新需要公网权限，也可以使用离线更新。

域名

专用域名。

数据库

PostgreSQL 9.5或以上（推荐）。

Node.js

Node.js 10.12或者以上。

浏览器

支持多数浏览器，如：Google Chrome、Mozilla Firefox、Microsoft Edge、Apple Safari；IE11会有兼容性问题，可正常查看内容，编辑等交互性操作会受限。

环境准备

Docker

1. 拉取CentOS 7基础镜像

docker pull centos:7.6.1810

2. 启动容器实例

docker run -dit --net=host centos:7.6.1810 /bin/bash

注意： 网络模式选取为“host”，后文叙述时空口实例ID为cf3f3c09a488。

3. 进入容器实例

docker exec -it cf3f3c09a488 /bin/bash

4. 安装命令行工具

yum install wget sudo which rsync vim

PostgreSQL部署

1. 安装

安装过程分为3步：安装Yum源、安装客户端，以及安装服务端。

yum install https://download.postgresql.org/pub/repos/yum/reporpms/EL-7-x86_64/pgdg-redhat-repo-latest.noarch.rpm

yum install postgresql12

yum install postgresql12-server

yum install postgresql12-contrib

2. 初始化

mkdir -p /data0/pgsql
chown -R postgres:postgres /data0/pgsql

sudo -u postgres /usr/pgsql-12/bin/initdb -D /data0/pgsql

3. 创建日志目录

mkdir -p /var/log/pgsql
chown -R postgres:postgres /var/log/pgsql

3. 启动/查看/停止

# 启动
sudo -u postgres /usr/pgsql-12/bin/pg_ctl -D /data0/pgsql -l /var/log/pgsql/server.log start

# 查看
sudo -u postgres /usr/pgsql-12/bin/pg_ctl -D /data0/pgsql status

# 停止
sudo -u postgres /usr/pgsql-12/bin/pg_ctl -D /data0/pgsql -m smart stop

4. 创建用户/数据库/授权

sudo -u postgres psql

# 创建用户
CREATE USER wikijs WITH PASSWORD 'wikijsrocks';

# 创建数据库
CREATE DATABASE wiki OWNER wikijs;

# 授权
GRANT ALL PRIVILEGES ON DATABASE wiki TO wikijs;

Node.js安装

1. 下载安装包

cd /tmp

wget https://nodejs.org/dist/v12.16.1/node-v12.16.1-linux-x64.tar.xz

2. 解压安装包

tar xvf node-v12.16.1-linux-x64.tar.xz

3. 安装

安装过程分为3步：移动安装包解压目录至/user/local、为node、npm建立软链接，以及删除安装包。

mv node-v12.16.1-linux-x64 /usr/local/

ln -s /usr/local/node-v12.16.1-linux-x64/bin/node /usr/bin/node
ln -s /usr/local/node-v12.16.1-linux-x64/bin/npm /usr/bin/npm

rm -rf rm -rf node-v12.16.1-linux-x64.tar.xz

Wiki.js

部署

1. 下载安装包

cd /tmp

wget https://github.com/Requarks/wiki/releases/download/2.1.113/wiki-js.tar.gz

2. 解压/移动/删除安装包

# 解压
mkdir wiki

tar xzf wiki-js.tar.gz -C ./wiki

# 移动
mv wiki /usr/local/

# 删除
rm -rf wiki-js.tar.gz

3. 配置

cd /usr/local/wiki

# 重命名配置文件
mv config.sample.yml config.yml

# 配置HTTP端口

port: 3000

# 配置数据库

db:
  type: postgres
  host: localhost
  port: 5432
  user: wikijs
  pass: wikijsrocks
  db: wiki

# 配置存储目录

dataPath: /data0/wiki

4. 启动

cd /usr/local/wiki

node server

等待，直至看到如下信息：

    Browse to http://localhost:3000/ to complete setup!

通过浏览器打开上述地址，按照提示输入以下信息：

    Administrator Email: ***
    Password: ***
    Confirm Passowrd: ***
    Site URL: ***

点击“INSTALL”，等待安装完成即可。

总结

Wiki.js整体功能还是很不错的，可定制的地方很多，除支持Markdow的在线编辑器之外，还提供丰富的后台管理功能，详细的内容可以参考官方文件，描述的还是比较清楚的。这里仅罗列几项我自己觉得不是很好的地方：

COMING SOON

“COMING SOON”，中文意思：“很快到来”。整体系统很多地方都有这个字眼，标识即将开放的功能，看着不是很舒服。

文档搜索不支持中文

即使使用官方推荐的数据库“PostgreSQL”，中文也是无法被支持的。这对于国内的用户来说几乎是灾难性的。Wiki.js本身还支持扩展连接多种搜索引擎，如：ElasticSearch，具体效果没有验证。

不支持匿名用户访问

用户必须登录系统才可以访问文档。

开发人员数量可怜

看Github项目统计，目前应该只有一人提供代码。