Peach 基于go语言的,一款支持多语言、实时同步以及全文搜索功能的 Web 文档服务器。下面的表格对比了 Peach 与几款主流文档工具之间主要特性的区别(实际区别可能与我所理解的有偏差):
除此之外,Peach 还支持以下功能:
- 从任意 Git 托管源实时同步文档
- 根据首选语言全文搜索文档
- 使用 Markdown 作为文档书写语法
- 高度可自定义,包括模板、配置和 CSS 等
- 内置 Disqus 集成支持
阅读本文之前,你需要先配置好,go语言的环境,文章如下:
- 宝塔面板Linux环境-安装Golang:Go语言环境安装以及程序如何运行
下载安装
安装之前,必须已经部署好了 Go 语言的开发环境,如果你还没配置好请按照上面的文章来部署。安装方式有2种,大鸟这里选择源码安装的方式来部署。
github:https://github.com/peachdocs/peach
下载:https://github.com/peachdocs/peach/releases
1》源码安装
确认好go环境,可以通过以下命令进行检查,最低要求的 Go 语言版本为 1.3:
[root@daniao ~]# go version go version go1.12.5 linux/amd64 [root@daniao ~]# echo $GOPATH /www/wwwroot/Golang
2》命令安装 Peach
然后,您就可以通过以下命令安装 Peach:
go get github.com/peachdocs/peach
也可以通过使用 -u
标志来更新 Peach:
go get -u github.com/peachdocs/peach
3》检查安装在您系统的 Peach 版本
然后使用以下命令来检查安装在您系统的 Peach 版本:
[root@daniao ~]# peach -v Peach version 0.9.8.0810
开始使用
大鸟这里是把peach项目放在root目录,所以命令操作都是在root,根据约定,每个 Peach 项目都以 *.peach
的格式命名,在本例中,大鸟将使用 my.peach
,并将项目放置在默认的下载目录:
1》执行命令
mkdir Downloads cd Downloads peach new -target=my.peach
执行完之后,我们会看到
peach new -target=my.peach Creating 'my.peach'... Creating 'templates'... Creating 'public'... Do you want to use custom templates?[Y/n] n Done!
好了,来看看目前peach的项目是个什么情况吧:
cd my.peach tree -L 2
如果你的使用tree命令出错的时候请安装tree,CentOS使用[code]yum -y install tree[/code]
2》 Peach的配置
运行之前还需要配置一下,为了方便起见,我们直接使用 Peach 自己的配置,因为它已经 开源在 GitHub 上了。我们直接克隆到本地系统并命名为 custom
即可,因为该名称就是 Peach 用来加载所有自定义设置的目录。
git clone https://github.com/peachdocs/peach.peach.git custom
3》运行 Peach
上面的都设置好之后,我们就可以运行 Peach了,因为是peach是go语言开发的,所以运行之后,你不能关闭, 为了解决这个问题,我还需要安装screen。
>>>3.1安装screen
Centos运行命令[code]yum install screen[/code],unbuntu可以用[code]apt-get install screen[/code]
安装好之后,运行命令[code]screen -S Peach[/code]
>>3.2运行
在screen中运行Peach,命令如下:
cd /Downloads/my.peach peach web
运行命令之后,我们可以看到如下信息:
[Peach] 19-09-14 10:37:47 [ INFO] Peach 0.9.8.0810 [Peach] 19-09-14 10:37:47 [ INFO] Peach Server Listen on 127.0.0.1:5556
额,在服务器上,用这个[code]127.0.0.1:5556[/code]是打开不开的,所以我们还需要【饭袋】
4》设置【饭袋】
首先新建一个网站,用你已经解析好的域名绑定这个新建的网站,之后再网站设置里找到【反向袋里】
如图上设置一哈子,保存之后,奇迹就发生了。用这个测试域名打开后,如图:
额,完美的安装了这个文档程序。
5》自定义配置
如果您对 Peach 的自定义配置感兴趣,可以通过 custom/app.ini
文件简单地解释一下:
# 修改监听端口 HTTP_PORT = 5556 # 设置文档类型为远程 Git 源 TYPE = remote # 远程 Git 源的 URL TARGET = https://github.com/Unknwon/peach-docs.git
总结
安装还是不难的,安装好之后,如果要继续使用这个高大上的Peach ,我们还需要学习创建文档仓库、使用 Web 钩子同步文档、自定义模板文件、添加静态资源等等。
总之,门槛还是有点高的,萌新小白就放弃吧,不过这个Peach文档,大鸟还是非常喜欢的,我觉得香的很。