# docs-publish

**Repository Path**: lianzt/docs-publish

## Basic Information

- **Project Name**: docs-publish
- **Description**: gitbook 发布工具
- **Primary Language**: NodeJS
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-06-11
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# docs-publish

一个 gitbook 项目的多人协作工具，为 gitbook 项目提供自动发布、用户管理等功能。

# gitbook

GitBook 是使用 GitHub / Git 和 Markdown（或AsciiDoc）构建漂亮书籍的命令行工具（和Node.js库）。

本项目

## 自动发布

可以为gitbook项目提供自动发布功能，需要将服务器的 ssh key 上传到 git 云端，并分配权限，配置 gitbook 项目的 web hooks 指向 ***http://ip:port/pub-book/push*** 即可。

每当 gitbook 项目有更新时，就会自动进行 git pull 操作拉取最新版本，自动完成编译与发布。

可修改 *shell/publish-book.sh* 脚本更改默认行为。

## 邮件通知

每次自动发布完成，都会发送邮箱通知给相关人员。

## 自动布署

项目可以完成自动布置，需要将服务器的 ssh key 上传到 git 云端，并分配权限，配置项目的 web hooks 指向 ***http://ip:port/pub-self/push*** 即可。

每当项目有更新时，就会自动布署最新版本。

可修改 *shell/publish-self.sh* 脚本更改默认行为。

## 用户与权限

运行项目，通过浏览器打开项目后，需要输入用户名/密码登录才能进入到 gitbook 主页。

项目基于 url 路径管理权限，使用超级管理员登录后可以维护用户并分配权限。

# 运行环境

* linux 操作系统
* node.js v8.0 以上
* gitbook
* git


# 需要设置环境变量

在正式环境下自动部署运行,需设置环境变量:

* DOCS_PUBLISH: 项目根目录
* JUFAN_DOCS: 文档项目根目录

# 自动部署相关脚本

* package-admin.sh -> 打包 admin,用于测试
* publish-self.sh -> 自动更新自身,包括:更新, admin打包, 重启
* pull-book.sh -> book 项目更新
* comp-book.sh -> book 项目编译
* puhlish-book.s -> book 项目部署

以上脚本必须有执行权限, 授权命令:

> chmod +x shell/\*.sh

# 自动部署 web hooks

* 自身: http://ip:port/pub-self/push , 密码:112358
* book项目: http://ip:prot/pub-book/push, 密码:112358

密码与关心的分支可在 config.js 中配置