Skip to content

Commit

Permalink
chore(docs): Update documentation for hash based routing and url para…
Browse files Browse the repository at this point in the history
…meter
  • Loading branch information
Morl99 committed Mar 11, 2022
1 parent 7253687 commit 0b1a578
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ If you are using a GitLab Job to generate the Trivy report, you can supply a dir
You can pass a query parameter `url` to the app, and it will load a file from this url on startup. It is a good idea to print the URL of the vulnerability explorer at the end of the job log, so that the user can jump directly to the vulnerability report. If the name of the report is `trivy-results.json`, the url schema would look like this:

----
https://dbsystel.github.io/trivy-vulnerability-explorer?url=https://$CI_SERVER_URL/api/v4/projects/$CI_PROJECT_ID/jobs/$CI_JOB_ID/artifacts/trivy-results.json
https://dbsystel.github.io/trivy-vulnerability-explorer/#/?url=https://$CI_SERVER_URL/api/v4/projects/$CI_PROJECT_ID/jobs/$CI_JOB_ID/artifacts/trivy-results.json
----

CAUTION: There was a recent change in the implementation of the Routing, make sure to include the `#` within the URL, otherwise this feature will not work.

NOTE: While the feature was built having GitLab in mind, it should work for every artifact storage, where the json can be downloaded with a GET HTTP request that needs at most a single HTTP header for authentication.

== Contribute
Expand Down

0 comments on commit 0b1a578

Please sign in to comment.