myriad/README.md
2019-09-04 23:56:37 -04:00

51 lines
1.1 KiB
Markdown

# Myriad
Arbitrary code execution server using Docker.
## Install
- Install GHC and Cabal, see [the Haskell website](https://www.haskell.org/)
- Run `cabal new-install`, a `myriad` executable will be installed
## Running
- Make sure the configuration is filled out, see `config.dhall` for an example
- Run `myriad --config path/to/config.dhall`
## Endpoints
### **GET** `/languages`
List of enabled languages.
Example response:
```json
["haskell", "javascript"]
```
### **POST** `/eval`
Evaluate code.
JSON payload with `language` and `code` keys.
The `language` is as in the name of a subfolder in the `languages` directory.
Example payload:
```json
{ "language": "haskell", "code": "main = print (1 + 1)" }
```
Example response:
```json
{ "result": "2\n" }
```
Errors with 404 if `language` is not found, `504` if evaluation timed out, or `500` if evaluation failed for other reasons.
### **GET** `/containers`
List of containers being handled by Myriad.
### **POST** `/cleanup`
Kill all containers, giving back the names of the containers killed.