https://github.com/holman/eponine

A very simple web server interface to shell scripts. Designed for Slack integrations on a Raspberry Pi.
https://github.com/holman/eponine

Last synced: about 1 year ago
JSON representation

A very simple web server interface to shell scripts. Designed for Slack integrations on a Raspberry Pi.

• Host: GitHub
• URL: https://github.com/holman/eponine
• Owner: holman
• Created: 2016-02-20T01:34:35.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-02-25T23:56:28.000Z (over 10 years ago)
• Last Synced: 2025-03-18T02:11:18.082Z (over 1 year ago)
• Language: Shell
• Size: 8.79 KB
• Stars: 55
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
![Eponine](https://cloud.githubusercontent.com/assets/2723/13193697/d0f48a56-d731-11e5-854a-d4743254a446.jpg)

# Eponine

Eponine is a [very tiny][server] web server in Go that accepts requests and responds with the output of shell scripts.

This was originally designed to be run on a Raspberry Pi and accessed via Slack, which is why there's a very Pi bent to the scripts. You can run it in other circumstances, though, if that's what you're into.

Starter scripts include a "who's here?" (a simple scan of MAC addresses on the local network and maps it against a known list of people in the room), and remote photo capture with the Pi's camera module.

Please note that this is super gnarly right now and will likely change quite a bit in the coming weeks.

## Install

Drop the latest binary to a directory on your machine and start the server with `./eponine`.

## Usage

Eponine can be accessed on port `24601` (haha).

The path of requests coming in get translated into shell script execution. So, a request coming in on `localhost:24601/people-scan` will execute `./bin/people-scan` on your machine. Needless to say, be careful of what you put in there.

Eponine will return whatever output the script outputs. If you want special formatting for Slack, for example, do it in the script.

## Scripts

Eponine will run anything in your local `bin` directory. Clone the repo if you want the whole batch, otherwise just add them one-by-one and you'll be good.

[server]:  https://github.com/holman/eponine/blob/master/server.go

[release]: https://github.com/holman/eponine/releases

## Contributing

Things are really raw right now; they'll maybe settle down eventually (or they won't and this will bitrot here forever).

Slug through the source if you'd like; contributions sorta welcome.