Readme update #224
Readme update #224
Conversation
| executable: "/Applications/ZAP.app/Contents/Java/zap.sh" | ||
| **Run** | ||
| ```sh | ||
| $ podman run -v ./config.yaml:/opt/rapidast/config/config.yaml:Z quay.io/redhatproductsecurity/rapidast:latest ./rapidast.py |
There was a problem hiding this comment.
/opt/rapidast -> /home/rapidast
There was a problem hiding this comment.
would it be nicer to add a mention that '/home/rapidast/config/config.yaml' is a default config file path and otherwise '--config <config_file_path>' can be used?
There was a problem hiding this comment.
/opt/rapidast is correct.
There was a problem hiding this comment.
would it be nicer to add a mention that '/home/rapidast/config/config.yaml' is a default config file path and otherwise '--config <config_file_path>' can be used?
To try and keep the quickstart section minimal, I think a better place for this might be showing the default in the help text.
| @@ -147,6 +208,7 @@ To avoid this, RapiDAST proposes 2 ways to provide a value for a given configura | |||
| - Create an entry in the configuration file (this is the usual method) | |||
| - Create an entry in the configuration file pointing to the environment variable that actually contains the data, by appending `_from_var` to the entry name: `general.authentication.parameters.rtoken_from_var=RTOKEN` (in this example, the token value is provided by the `$RTOKEN` environment variable) | |||
There was a problem hiding this comment.
while this was missing before this PR, we should mention that env vars can be defined with 'config.environ.envFile' too, now that '#advanced-configuration' has been explicitly linked :)
There was a problem hiding this comment.
will do in follow up PR
This is a large README.md update based on my early experiences getting familiar with rapidast. Some highlights:
container.typeoptionsIt's likely hard to review in a PR, to see the rendered version have a look here:
https://github.com/sfowl/rapidast/tree/readme-update