https://github.com/gera2ld/garfield
Web server to execute commands.
https://github.com/gera2ld/garfield
Last synced: 10 months ago
JSON representation
Web server to execute commands.
- Host: GitHub
- URL: https://github.com/gera2ld/garfield
- Owner: gera2ld
- Created: 2016-08-24T09:28:30.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-02-28T15:26:37.000Z (over 8 years ago)
- Last Synced: 2025-08-07T05:20:06.205Z (12 months ago)
- Language: JavaScript
- Size: 208 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Garfield
===
This is a lite server to execute commands according to web requests.
Usage
---
1. Start:
``` sh
# Default address is `0.0.0.0:2333`
$ npm start
```
Configuration can be overridden by `config.yml` or environment variables.
See [src/server/config.js](src/server/config.js).
1. Open dashboard, then add projects and commands.
1. Make a request:
```
POST http://server.address/cmd/command_name/command_type
```
Config
---
Default configurations can be overridden by environment variables.
* `HOST`
The server host, default as `''`.
* `PORT`
The server port, default as `2333`.
* `DATA_DIR`
The directory to store data, also as current working directory to start each task. Default as `data`.
`DATA_DIR` can either be a path relative to current working directory or an absolute path.
* `SUPER_USERS`
A list of user IDs. Users with IDs in the list will have super user permissions temporarily.
* `GITHUB_CLIENT_ID` & `GITHUB_CLIENT_SECRET`
Required to log in with GitHub.