Wiki.js安装部署实操手册

前言

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

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

avatar

详细阅读文档后,觉得基本可以满足需求,应该可以部署实际感受一下。考虑到依赖组件过多,特别是涉及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
  1. 启动容器实例
docker run -dit --net=host centos:7.6.1810 /bin/bash

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

  1. 进入容器实例
docker exec -it cf3f3c09a488 /bin/bash
  1. 安装命令行工具
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

  1. 初始化
mkdir -p /data0/pgsql
chown -R postgres:postgres /data0/pgsql

sudo -u postgres /usr/pgsql-12/bin/initdb -D /data0/pgsql
  1. 创建日志目录
mkdir -p /var/log/pgsql
chown -R postgres:postgres /var/log/pgsql
  1. 启动/查看/停止
# 启动
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
  1. 创建用户/数据库/授权
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
  1. 解压安装包
tar xvf node-v12.16.1-linux-x64.tar.xz
  1. 安装

安装过程分为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
  1. 解压/移动/删除安装包
# 解压
mkdir wiki

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

# 移动
mv wiki /usr/local/

# 删除
rm -rf wiki-js.tar.gz
  1. 配置
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
  1. 启动
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项目统计,目前应该只有一人提供代码。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,658评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,482评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,213评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,395评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,487评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,523评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,525评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,300评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,753评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,048评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,223评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,905评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,541评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,168评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,417评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,094评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,088评论 2 352

推荐阅读更多精彩内容