Skip to content

Commit

Permalink
how-to-doc (#9)
Browse files Browse the repository at this point in the history
Co-authored-by: chandrakanthkannam <[email protected]>
  • Loading branch information
chandrakanthkannam and chandrakanthkannam authored May 14, 2024
1 parent 8f808ef commit 2571964
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,23 @@ Run commands on host machine via http request.
## Configurable options

- Below are the environment variables which can be set to overwrite default values
- RUST_LOG: determine log level, Default is INFO.
- R_CMD_TIMEOUT: Time out value in sec, only numerics, example: 100 for 100sec timeout, Default is 50
- RUN_IT_PORT: port number to listen on, Default is 48786
- `RUST_LOG`: determine log level, Default is INFO.
- `R_CMD_TIMEOUT`: Time out value in sec, only numerics, example: 100 for 100sec timeout, Default is 50
- `RUN_IT_PORT`: port number to listen on, Default is 48786

## DEMO

https://github.com/chandrakanthkannam/run-it/assets/49658217/c6e55c75-6eeb-4a94-9786-6dace5cf2404

## How to

### Build locally

- To build locally it is required to have `rust` and `cargo` installed
- Clone the repo and run: `cargo build -r`
- This would leave a executable in `<clone_repo_loc>/target/release/run-it` path
- If above environment variables are set those values are used otherwise default values are used.

## TODO

- Valid unit tests
Expand Down

0 comments on commit 2571964

Please sign in to comment.