https://github.com/hyjiacan/gitage
Static web server based on git-scm, also known as pages service.
https://github.com/hyjiacan/gitage
git-scm gitage pages
Last synced: 28 days ago
JSON representation
Static web server based on git-scm, also known as pages service.
- Host: GitHub
- URL: https://github.com/hyjiacan/gitage
- Owner: hyjiacan
- License: mit
- Created: 2020-06-05T01:22:52.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T23:16:17.000Z (over 3 years ago)
- Last Synced: 2025-03-18T18:59:13.793Z (about 1 year ago)
- Topics: git-scm, gitage, pages
- Language: JavaScript
- Homepage:
- Size: 1.95 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gitage
Static web server based on NodeJS for git-pages.
Tested on [gitea](https://gitea.io/) for now.
Dependencies:
- Git
- nodejs>8
## Usage
```shell script
npm run build
node dist/gitage.js
```
## Server Configuration
Config file: `config` (case-sensitive), should be put in the root path of gitage.
*config*
```
# DEBUG flag
DEBUG = false
# ip to host
HOST = 0.0.0.0
# port to listen
PORT = 1997
# The path to put logs file, can be absolute or relative
LOG_PATH = logs
# The path to checkout repository, can be absolute or relative
PROJECT_ROOT_PATH = projects
# Log the messages which higher than this level
LOG_LEVEL = info
# The temporary path to the checkout, leave it blank to use the system temp path
PROJECT_CHECKOUT_TMP =
```
> If no _config_ file, the value above will be the default values.
> Note: Configuration item name must be **UPPERCASE**
## Repo Configuration
Add file `gitage.config.json` into your repo, in the form bellow:
```json
{
"type": "markdown",
"path": "docs",
"index": "index.html",
"tag": true,
"branch": "master",
"ignore": [
"file",
"dir",
"..."
]
}
```
- `type` Deploy type, only `markdown` supported currently, or just leave it blank **case-sensitive**
- `path` The directory to deploy (where the static assets located in), default: `docs`
- `index` The index file to deploy，default: `index.html/index.md` **case-sensitive**
- `tag` Whether to deploy only on `tag` pushed，default: `false` (planning)
Add web-hook on your repository:
POST `http://127.0.0.1:1997/hook/`
`127.0.0.1` The IP to serve
`1997` The port to serve
## Screenshots
