SNYK PRODUCTS
Getting started with Snyk Open Source
Get started with Snyk Open Source to inspect, find and fix vulnerabilities in your application's Open Source libraries.
This process describes getting started using the Snyk Web UI and a SCM (source code management) system.
Prerequisites
Ensure you have:
- A code project using open source packages, on a supported SCM system such as GitHub. See Git repository (SCM) integrations.
- A supported language and package manager, such as Java. See Open Source language and package manager support.
Stage 1: Add source control integration
if you already have an integration set up, go to Step 3.
Choose a source code integration, to allow Snyk to work on a project.
- 1.
- 2.Select Integrations > Source control.
- 3.Click the source control system (for example, GitHub) to integrate with Snyk.
- 4.Fill in the account credentials as prompted (or authenticate with your account in GitHub), to grant Snyk access permissions for integration.
Stage 2: Add Projects
Add projects to test with Snyk, by choosing repositories for Snyk to test and monitor.
In the Snyk Web UI, first select Projects from the Snyk Web UI, then click Add Project, selecting where to add the project repos from (for example GitHub).
Add a repo
Select the repositories to use, then click Add selected repositories to import the selected repositories into your projects:
This also:
- Creates a Webhook, so when you change code, Snyk tests your pull / merge requests, to check that new dependencies do not introduce more vulnerabilities.
In Settings, optionally choose to: ****
- Use Add custom file location to add any additional dependencies from custom paths.
- Use Exclude folders to list up to 10 folders to exclude from scanning during the import; for example, to shorten scanning time.
Import progress
- 1.A progress bar appears: click View last import log to see log results.
- 2.Project import completes, with a status error message:
Stage 3: View vulnerabilities
You can now view vulnerability results for imported projects. The Projects tab appears by default after import, showing vulnerability information for project you've imported.
You can expand an imported project to see vulnerability information for that project, including the number of issues found, grouped by severity level:
.
Click on an entry to open the issues view for that entry, including the module, where it was introduced, and how to fix it, plus more details about the vulnerability itself:
Stage 4: Fix vulnerabilities
For some languages, Snyk can fix your vulnerabilities using fix pull/merge requests.
Navigate to the Issues view for a project:
To fix vulnerabilities:
- 1.Click Fix this vulnerability to raise a fix PR for that issue (or click Fix these vulnerabilities to to fix multiple issues).
- 2.The Open a Fix PR screen opens and indicates the vulnerabilities you selected.
- 3.Check any additional issues you want to fix, or uncheck items to remove them from the fix.
- 4.Scroll down to the bottom of the screen and click Open a Fix PR.
- 5.Snyk now actions this PR, then a results screen appears.
- 6.Optionally, select the Files changed tab to see details of the changes made.
Last modified 8d ago
Export as PDF
Copy link
Edit on GitHub