Skip to content

Commit

Permalink
Document stdin phase setting
Browse files Browse the repository at this point in the history
  • Loading branch information
quantumsheep committed Jun 9, 2021
1 parent 6130fdd commit 2af5642
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,14 @@ Send a `POST` HTTP request to `http://localhost:8080/run` containing the wanted
| sandbox_settings | `SandboxSettings` | Override default sandbox limitation settings |

### Phase
| Name | Type | Default | Description |
|------------------|--------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------|
| name | `string` | Phase's index | Name that will be used in result output |
| script* | `string` | | Multi-line bash script that will be executed inside the isolated environment |
| environment | `Record<string, string>` | | Environment variables available inside `script` execution. This will override global environment variables with the same given keys |
| sandbox_settings | `SandboxSettings` | | Overrides default sandbox limitation settings. This will override global sandbox settings with the same given keys |
| profiling | `boolean` | false | Run a profiler on `script`. This functionnality is WIP |
| Name | Type | Default | Description |
|------------------|-------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------|
| script* | `string` | | Multi-line bash script that will be executed inside the isolated environment |
| name | `string` | Phase's index | Name that will be used in result output |
| stdin | `string` | | Content used in `stdin` |
| environment | `Record` | | Environment variables available inside `script` execution. This will override global environment variables with the same given keys |
| sandbox_settings | `SandboxSettings` | | Overrides default sandbox limitation settings. This will override global sandbox settings with the same given keys |
| profiling | `boolean` | false | Run a profiler on `script`. This functionnality is WIP |

### SandboxSettings
| Name | Type | Default | Description |
Expand Down

0 comments on commit 2af5642

Please sign in to comment.