User Guide

1. Navigate to https://scantist.io
2. Login using a Github account set-up for you.
3. Once you log in, the application dashboard will be presented to you.
4. To scan a project, you must add it first. Click on the ‘Projects’ tab on the left-sidebar menu.
5. Click the green ‘Manage’ button next to the ‘Projects’ header on the mid-left of the screen.
6. The list of available projects in the test Github account will now be shown. Click on the ‘Add’ button pertaining to the projects that you wish to scan – a pop-up will confirm the addition.
7. Once the project is added, and you’ll be redirected back to the ‘Projects’ view. You can view the ‘Project Details’ by clicking on the project name from this view at any time. Also, at the ‘Project Details’ page you may set scan settings and policy for event-driven integrations and licensing conflicts. 8a. To manually the scan, click the ‘Actions’ button at the right-end of the row containing the added project. From the drop-down menu that appears, click ‘Scan’. 8b. To trigger scans every time a pull-request is made to your Github repository, go to the ‘Project Details’ and under the ‘Scan Settings’ turn on the Event-driven scan.
8. Once a scan has been initiated, the status of the project will now change to ‘Running’. Depending on the size of project, it can take about 10 minutes for the scan to finish.
9. Click the ‘Vulnerabilities’ tab on the left-sidebar menu. You will now be presented with a ‘By Project’ and ‘By Issue’ overview of vulnerabilities found.
10. To view the list of vulnerabilities detected in a project, click on the ‘View’ link at the right-end corner corresponding to the project you wish to view in the ‘By Project’ tab.
11. You will now be shown a list of vulnerabilities found in the latest scan for the project, and some details regarding the same.
12. To view details pertaining to a particular vulnerability found in the latest scan, click on the ‘View’ link corresponding to the vulnerability. The Issue details page will provide you more details, including the actual vulnerable code and patched code (if available).
13. To view potential licensing issues, click the ‘Licenses’ tab on the left-sidebar menu. You will now be presented with a ‘By Project’ and ‘By License’ overview.
14. To view the list of library and corresponding licenses detected in a project, click on the ‘View’ link at the right-end corner corresponding to the project you wish to view in the ‘By Project’ tab.
15. You will now be shown a list of libraries and their licenses found in the latest scan for the project, and some details regarding the same.