gitage 基于 GIT 的静态 WEB 服务开源项目

我要开发同款
匿名用户2020年11月19日
33阅读
开发技术JavaScript
所属分类Web应用开发、WEB服务/SOAP/SOA
授权协议MIT

作品详情

gitage基于NodeJS的git-pages静态WEB服务依赖:

gitnodejs>8目前支持的托管系统:

gogsgitea概述gitage运行在nodejs上,依赖git(gitea,gogs,gitlab)等托管系统的web勾子。

gitage主要为团队/公司等非公开组织提供一个易于部署的pages服务。

gitage提供markdown文件渲染,以及 一些类型 文件的预览支持。

用法

首次运行,需要执行命令 npmrundownload 下载依赖的第三方包。

npmrunbuildnodedist/gitage.js服务器配置配置文件名为 config (区分大小写),放置在部署根目录。

config

#是否启用调试DEBUG=false#启动服务的IP地址HOST=0.0.0.0#启动服务的端口PORT=1997#日志路径,可以指定为绝对路径或相对路径LOG_PATH=logs#日志记录的级别LOG_LEVEL=info#仓库部署路径,可以指定为绝对路径或相对路径PROJECT_ROOT_PATH=projects#仓库检出临时目录,留空使用系统临时目录PROJECT_CHECKOUT_TMP=

在无此文件时,使用以上默认配置

注意:配置项名称均使用大写

仓库配置在仓库下添加文件 gitage.config.json,其格式如下(可选):

{"type":"markdown","path":"docs","index":"index.html","tag":true,"branch":"master","ignore":["file","dir","..."]}type 标记部署内容的类型,目前仅支持 markdown,表示内容为 markdown,否则直接留空 区分大小写path 部署目录,默认为 docsindex 部署目录下的索引页名称,默认为 index.html/index.md 区分大小写tag 是否仅在收到 tag 时部署,默认为 false (计划中)branch 指定部署的分支,默认为 master (配置文件应该存放在主分支上,以避免无法正常读取)在仓库的webhook上添加地址:

POST https://127.0.0.1:1997/hook/

127.0.0.1 是部署的服务器IP 1997 是部署的端口

type-markdown当 type=markdown 时,可以在仓库内指定一个目录(可以是仓库根目录 /),用于发布文档文件。

在此模式下,会扫描整个部署目录,并自动生成文档树。每个文件都包含其最后更新的用户/日期以及更新消息。

目前支持 .md|.markdown|.txt|.pdf|.docx 类型文件在线查看。

截图

 
声明:本文仅代表作者观点,不代表本站立场。如果侵犯到您的合法权益,请联系我们删除侵权资源!如果遇到资源链接失效,请您通过评论或工单的方式通知管理员。未经允许,不得转载,本站所有资源文章禁止商业使用运营!
下载安装【程序员客栈】APP
实时对接需求、及时收发消息、丰富的开放项目需求、随时随地查看项目状态

评论