https://github.com/eccstartup/serverize

Serverize an arbitrary shell program (especially REPLs) into a web interface
https://github.com/eccstartup/serverize

Last synced: 6 days ago
JSON representation

Serverize an arbitrary shell program (especially REPLs) into a web interface

• Host: GitHub
• URL: https://github.com/eccstartup/serverize
• Owner: eccstartup
• Created: 2013-07-18T08:39:48.000Z (over 11 years ago)
• Default Branch: jetty
• Last Pushed: 2013-07-18T07:00:02.000Z (over 11 years ago)
• Last Synced: 2023-03-28T23:38:32.406Z (almost 2 years ago)
• Language: JavaScript
• Homepage:
• Size: 186 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
serverize

=========

This tool turns an arbitrary shell program (especially REPLs) into a web server.

Users can create new instances of the shell program and interact with them using a web interface.

By using this interface, users can have access to the shell program without actually installing or running it on their own machines.

This could be especially helpful for teaching programming languages (those with a REPL, of course) in a class.

Note that the program instances created by this tool have the same privilege as the user who runs this tool.

Some programs such as irb (interactive ruby) have access to the network and the underlying filesystem.

It is your responsibility to make sure that the exposed web interface is not a security threat to your system.

For example, you are supposed to run this tool under a jailed user account with limited access to the system settings.

Usage: `java Serverizer [port] [program]`

Configuration via environment variables:

- `MAX_SESSIONS`, default: 5

- `SESSION_WAIT_SECONDS`, default: 10

- `READER_THREAD_BUFFER_SIZE`, default: 1024 (bytes)

- `SLEEP_INTERVAL_MS`, default: 10 000

- `SESSION_TIMEOUT_MS`, default: 10 000

- `SCRIPT_UTILITY_PATH`, default: /usr/bin/script

TODO items:

1. stderr

2. Ctrl-C, Ctrl-D, etc.

3. Notify via the web interface when the underlying process finishes execution, and report the exit status

Dependency

----------

This tool relies on the [script](http://linux.die.net/man/1/script) utility to

automatically flush (unbuffer) the output of the underlying process.  It should

be placed at `/usr/bin/script`, or a location specified by the environment

variable `SCRIPT_UTILITY_PATH`.