GitBook,GitLab实现5分钟搭建企业级Wiki

概述

本文主要介绍如何使用GitBook,GitLab,并集成GitLab CI实现一个企业级或个人的Wiki系统

环境准备

安装前,需要准备如下环境,主要包括:

  1. 一台Linux服务器,系统:Centos7
  2. 安装npm,node环境

安装Git

通过下列命令,在机器上安装git:

## 通过下列命令安装git
yum install git
## 查看当前git版本
git --version

安装GitLab

  1. 下载gitlab的rpm包
    地址:https://mirrors.tuna.tsinghua.edu.cn/gitlab-ce/yum/el7/gitlab-ce-9.5.9-ce.0.el7.x86_64.rpm
  2. 执行安装
## 安装rpm包
rpm -ivh gitlab-ce-9.5.9-ce.0.el7.x86_64.rpm
  1. 修改访问URL
vim /etc/gitlab/gitlab.rb
## 修改以下内容并保存
external_url "http://10.0.112.65"
  1. 重装配置
## 依次执行下面命令 
gitlab-ctl reconfigure
gitlab-ctl restart

安装GitBook

通过下列命令安装即可:

npm install gitbook-cli -g

安装GitLab Runner

  1. 下载GitLab Runner
    通过 uname --m 命令查看 Linux 系统的位数,然后下载对应的安装包
# x86-64
sudo wget -O /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-linux-amd64
# x86
sudo wget -O /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-linux-386
# arm
sudo wget -O /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-linux-arm
  1. 文件放置
    把文件放置于 /usr/local/bin/gitlab-runner,并配置相应权限
chmod +x /usr/local/bin/gitlab-runner
  1. 安装GitLab Runner
## 下载
npm install gitbook-cli -g
## 安装
gitlab-runner install --user=root --working-directory=/software/gitlab-runner
## 启动
gitlab-runner start

打通GitLab与GitBook

  1. 创建wiki的工程,如下所示:
    在这里插入图片描述
  2. 注册GitLab Runner
## 注册
gitlab-runner register
然后依次输入以下参数:
## 1. GitLab的url,参考下图
## 2. Token,参考下图
## 3. 描述,随便写一个
## 4. Runner描述,随便写一个
## 5. shell,意思是执行方式,这里用shell即可

在这里插入图片描述
配置完成后,可以在GitLab看到Runner已经注册上来了,如下所示:
在这里插入图片描述

  1. 项目配置CI
    在项目中新增.gitlab-ci.yml文件,内容如下:
stages:
  - build
jdh-wiki:
  stage: build
  script:
    - p=`pwd`
    - echo $p
    - gitbook install
    - gitbook build

提交到GitLab后,通过Pipelines菜单查看任务执行情况:
在这里插入图片描述
在这里插入图片描述
4. 启动GitBook
通过上面的日志,进入到对应的目录,然后执行启动,命令如下:

cd /software/gitlab-runner/builds/ff5949ca/0/xx/xx-wiki
nohup gitbook serve &

验证

修改Wiki内容,然后推送到GitLab,可以看到GitLab上的任务被执行:
在这里插入图片描述
访问http://IP:4000,可以看到对应的Wiki被更新,证明WiKi搭建完成,并能实时更新
在这里插入图片描述

遇到的问题

runner一直处于Pending状态

这是由于在注册gitlab runner完成后,有一个配置项需要修改,否则不会执行,详见以下链接:
https://www.daxiblog.com/gitlab-pages无法运行,一直处于pending状态的原因/

总结

最后的最后,做个小总结:

  1. 本文主要描述如何使用GitBook结合GitLab实现Wiki系统
  2. Wiki支持多人协作,支持自动更新
  3. 由于文档保存在GitLab上,因此不会丢失,适合团队协作或者个人博客

猜你喜欢

转载自blog.csdn.net/qq_15898739/article/details/106836887