GitBook,GitLab实现5分钟搭建企业级Wiki ⽂章⽬录
⼀. 概述
本⽂主要介绍如何使⽤GitBook,GitLab,并集成GitLab CI实现⼀个企业级或个⼈的Wiki系统
这⾥简单介绍下GitBook:GitBook是⼀款⽂档编辑⼯具,⽀持多⼈协作,同时⽀持Git
下⾯从0到1开始搭建基于GitBook,GitLab的企业级Wiki
⼆. 环境准备
安装前,需要准备如下环境,主要包括:
1. ⼀台Linux服务器,系统:Centos7
2. 安装npm,node环境
git常用指令三. 安装Git
通过下列命令,在机器上安装git:
## 通过下列命令安装git
yum install git
## 查看当前git版本
git --version
四. 安装GitLab
1. 下载gitlab的rpm包
地址:
2. 执⾏安装
## 安装rpm包
rpm -ivh gitlab-ce-9.5.9-ce.0.el7.x86_64.rpm
3. 修改访问URL
vim /etc/gitlab/gitlab.rb
## 修改以下内容并保存
external_url "10.0.112.65"
4. 重装配置
## 依次执⾏下⾯命令
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 gitlab-runner-downloads.s3.amazonaws/latest/binaries/gitlab-runner-linux-amd64 # x86
sudo wget -O /usr/local/bin/gitlab-runner gitlab-runner-downloads.s3.amazonaws/latest/binaries/gitlab-runner-linux-386
# arm
sudo wget -O /usr/local/bin/gitlab-runner gitlab-runner-downloads.s3.amazonaws/latest/binaries/gitlab-runner-linux-arm
2. ⽂件放置
⽂件已经放置于 /usr/local/bin/gitlab-runner,需要配置相应权限
chmod +x /usr/local/bin/gitlab-runner
3. 安装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已经注册上来了,如下所⽰:
3. 项⽬配置CI
在项⽬中新增.l⽂件,内容如下:
stages:
- build
xx-wiki:
stage: build
script:
- p=`pwd`
- echo $p
- gitbook install
- gitbook build
-
setsid nohup sh startup.sh > nohup.out 2>&1&
在项⽬中新增startup.sh⽂件,内容如下:
#!/bin/bash
for i in `ps -ef | grep gitbook | grep serve`;do kill -9 $i ; done; gitbook serve
提交到GitLab后,通过Pipelines菜单查看任务执⾏情况:
⼋. 验证
修改Wiki内容,然后推送到GitLab,可以看到GitLab上的任务被执⾏:
访问IP:4000,可以看到对应的Wiki被更新,证明WiKi搭建完成,并能实时更新
九. 遇到的问题
1. runner⼀直处于Pending状态
这是由于在注册gitlab runner完成后,有⼀个配置项需要修改,否则不会执⾏,详见以下链接:
2. runner⼀直处于running
这是由于直接通过gitbook serve启动时,没有以后台⽅式启动。最后通过setsid解决
⼗. 扩展
1. GitBook的常⽤插件
GitBook提供了⾮常多通⽤的插件,可以让我们的Wiki看起来更炫酷,功能更强⼤,下⾯是Wiki项⽬的book.json:
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论