「文档服务搭建」使用 GitLab、Jenkins搭建基于 Docsify 的内网文档管理平台

目的

搭建公司内部文档管理平台,修改完毕后推送至远端自动刷新

依赖环境

DocsifyGitLabJenkins

版本无要求

运行环境

CentOS Linux release 7.3.1611

依赖环境

如本地已安装需要的依赖环境,可直接略过该部分。

GitLab

介绍

GitLab是一个开源的Git仓库管理工具。

使用官网提供的安装方式,可以在公司内网上搭建私人的Git平台。

官网地址

初始化

打开系统防火墙 HTTP 和 SSH 访问权限
sudo yum install -y curl policycoreutils-python openssh-server cronie
sudo lokkit -s http -s ssh
安装邮件代理服务
sudo yum install postfix
sudo service postfix start
sudo chkconfig postfix on
添加GitLab仓库并安装
curl -sS http://packages.gitlab.com.cn/install/gitlab-ce/script.rpm.sh | sudo bash
sudo yum install gitlab-ce
启动服务
sudo gitlab-ctl reconfigure
通过域名访问

第一次访问 GitLab,需要输入初始化管理员账号的密码,系统默认的管理员账号为 root。

创建项目

新建Project
image-20181106114905907
image-20181106114937063
生成本机秘钥文件
image-20181106114416786
添加SSH Key
image-20181106114824567
Clone到本地
image-20181106115509558
git clone http://10.10.13.28/konghaorui/my-docs.git

Docsify

介绍

一个神奇的文档网站生成工具

官网地址

样式预览
image-20181106101916682
image-20181106101936176

初始化

安装脚手架工具(本机、服务器都需安装)
npm i docsify-cli -g
生成项目

进入Clone下来的项目目录,初始化文档工程

cd my-docs
docsify init ./docs
本地预览
docsify serve docs

Jenkins

介绍

Jenkins是一个开源的、提供友好操作界面的持续集成工具

主要用于持续、自动构建项目、测试软件工程、监控外部任务的运行

官网地址

初始化

因为服务器上已有tomcat服务在运行,所以此处使用直接挂载Jenkins到tomcat服务下的方式,相对比较简洁。如没有tomcat服务可以选择其他方式进行搭建。

下载war包

进入下载页面,选择对应版本安装包

image-20181106141611995
放置war包

将下载好的war包放置到tomcat安装目录,webapps文件夹下

image-20181106142110320
启动tomcat
cd bin
sh startup.sh

启动完毕后,访问 http://localhost:8080/jenkins 即可看到Jenkins页面

首次启动需要输入初始密码,密码信息在标记的文件位置查看

image-20181106142457633

注册完新用户再次进入就可以看到Jenkins首页了

image-20181106142655453

自动部署

在上面基本的环境都已经搭建成功,现在做的就是实现文档自动部署功能,使git项目能够和docsify相关联。

配置Jenkins

  • 打开jenkins页面

  • 添加插件:系统管理 - 插件管理

  • 需要添加的插件:Post Build Task、Gitlab Hook、Gitlab

  • 安装后重启Jenkins

创建任务
image-20181106144202434
添加源码管理

填写git仓库地址,添加用户,选择默认获取分支

image-20181106144520612
设置构建触发器
image-20181106145526720
设置构建后操作,自动启动docsify服务
image-20181106145715343
image-20181106145747153

设置自动启动docsify脚本

image-20181106145932345
git pull origin master
#判断进程是否存在,如果不存在就启动它
PIDS=`ps -ef |grep docsify |grep -v grep | awk '{print $2}'`
if [ "$PIDS" != "" ]; then
echo "docsify is runing!"
else
#运行进程
echo "starting docsify!"
docsify serve docs --port 4921 &
fi
保存配置

配置GitLab

设置webhook,当有提交时自动触发Jenkins任务

image-20181106150537152
image-20181106151039402

可点击test按钮模拟推送事件

image-20181106151321564

如出现200提示,说明任务触发成功

image-20181106152120100

查看Jenkins任务是否执行

image-20181106152214123

测试

修改任意文件内容后推送至远端,访问 http://服务器地址:4921 查看文档是否改变

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

推荐阅读更多精彩内容