leonowski/go-shell-api-docker repository overview

A utility to expose shell commands through a web API. Copied from: http://techfeast-hiranya.blogspot.com/2015/06/expose-any-shell-command-or-script-as.html⁠

⁠Building locally

Requirements: golang

go build

⁠Dockerfile for automated builds for common platforms

Building in Docker docker build whatever-you-want-to-call-this-thing .

After building, just copy the bins in /go-shell-api-bins. Example:

docker run -v "$(pwd)":/temp --rm -it whatever-you-want-call-this-thing sh -c "cp -R /go-shell-api-bins/* /temp/"

Pre-made container available on Dockerhub:

leonowski/go-shell-api-docker

⁠Running

go-shell-api -b some-binary-to-expose

Examples:

go-shell-api -b ls

This will expose the command ls at http://ip-address:8080⁠

An HTTP GET will give you the output of ls where the binary is running. Use POST to add options to the command. Example using curl:

curl -X POST -d "-ls" some-ip-address:8080

You can specify HTTPS and basic auth with these options:

./go-shell-api -b ls -https -u username -pw somepassword

If HTTPS is used, a self-signed cert is used. However, a cert and key can also be specified if desired. See full options below.

Full options available with -help:

  -b string
        Path to the executable binary
  -c string
        Path to the configuration file with allowed commands
  -cert string
        Path to the server certificate file (requires -https flag)
  -https
        Serve via HTTPS using a self-signed certificate or an optional custom certificate
  -key string
        Path to the server key file (requires -https flag)
  -l string
        Address to listen on (default "0.0.0.0")
  -p int
        HTTP port to listen on (default 8080)
  -pw string
        Basic authentication password
  -u string
        Basic authentication username