SunRed/myriad
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

add more details in readme

Browse source
This commit is contained in:
1computer1 2020-06-17 05:05:32 -04:00
parent 43c5204982
commit 79ab50508d
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,6 +1,21 @@
# Myriad # Myriad
Arbitrary code execution server using Docker. Arbitrary code execution server using Docker.
Each language has its own Docker image and so each evaluation will run in the respective language's locked-down container.
Features include:
- Building images on startup.
- Preparing containers on startup or on demand.
- Periodically cleanup running containers.
- Customizable settings for each image:
- Maximum memory usage.
- Maximum CPU usage.
- Maximum evaluation time.
- Maximum concurrent evaluations.
- Maximum number of retries.
Requires Docker 18+ to operate.
## Download Pre-Built Binary ## Download Pre-Built Binary
@ -20,7 +35,7 @@ Make sure the place where `stack` or `cabal` places binaries is in your PATH.
Run `stack install` or `cabal new-install` inside the project folder. Run `stack install` or `cabal new-install` inside the project folder.
Or, to build within the project, run `stack build` or `cabal new-build`. Or, to build within the project, run `stack build` or `cabal new-build`.
## Configuration ## Configure and Run
Make sure the configuration is filled out, see `config.example.yaml` for an example. Make sure the configuration is filled out, see `config.example.yaml` for an example.
Run `myriad` (or `stack run` or `cabal new-run` if you built within the project) to start the server. Run `myriad` (or `stack run` or `cabal new-run` if you built within the project) to start the server.