Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codemug/shhttp
An http service that can execute commands/shell scripts and manage their jobs
https://github.com/codemug/shhttp
http remote-control shell
Last synced: about 1 month ago
JSON representation
An http service that can execute commands/shell scripts and manage their jobs
- Host: GitHub
- URL: https://github.com/codemug/shhttp
- Owner: codemug
- License: apache-2.0
- Created: 2019-02-07T13:04:55.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-06T18:34:27.000Z (over 4 years ago)
- Last Synced: 2023-05-17T13:34:37.323Z (over 1 year ago)
- Topics: http, remote-control, shell
- Language: Go
- Size: 28.3 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# shhttp
It's a small HTTP service written in go that can accept different commands and shell scripts, execute them on the machine it's running on and return the result. It can also manage these commands/shell scripts as jobs. When a command(s)/script(s) is submitted as a job, the response of the HTTP request is returned immediately while the command/script keeps on executing. The service also exposes api to query the state of these jobs.
### Installation
#### Go based:
You need to install golang and [dep](https://github.com/golang/dep) on your machine. Clone the repo in your gopath/src and do a:
```sh
dep ensure
go install
```
#### Docker:
To directly run the docker image:
```
docker run -p 2112:2112 codemug/shhttp:latest
```
To build the image from source:
```
docker build -t codemug/shhttp:latest .
```
### Usage
The service can be directly launched from the shell, do an `sshttp --help`:
```
$ shhttp --help
Usage of shhttp:
-alsologtostderr
log to standard error as well as files
-clean-interval int
interval (hours) after which finished jobs are cleaned (default -1)
-dir string
location to store the job data (default "shhttp")
-hostname string
hostname to listen on (default "0.0.0.0")
-log_backtrace_at value
when logging hits line file:N, emit a stack trace
-log_dir string
If non-empty, write log files in this directory
-logtostderr
log to standard error instead of files
-port int
port to listen on (default 2112)
-stderrthreshold value
logs at or above this threshold go to stderr
-v value
log level for V logs
-vmodule value
comma-separated list of pattern=N settings for file-filtered logging
```
To run the daemon with defaults, simply do `shhttp` in the shell.
### API:
Read [Wiki](https://github.com/codemug/shhttp/wiki) for API usage.
### Roadmap:
I'm looking forward to add the following:
1. A kick-ass UI
2. Ability to run all tasks in a job concurrently
3. Ability to blacklist/whitelist certain commands using regexes
4. Ability to run jobs on a schedule
### Contributions:
Are welcome and encouraged.