Skip to content

Commit eee1b2a

Browse files
docs: synchronizing README from snyk/user-docs (#121)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent d49f5fa commit eee1b2a

1 file changed

Lines changed: 23 additions & 22 deletions

File tree

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,15 @@
1-
---
2-
description: Use this documentation to get started with the Eclipse plugin.
3-
---
4-
51
# Eclipse plugin
62

7-
Snyk offers IDE integrations that allow you to use the functionality of Snyk in your Integrated Development Environment. This page describes the Snyk Eclipse plugin. For information about all of the IDE plugins and their use, see [Snyk for IDEs](https://docs.snyk.io/ide-tools) in the docs.
8-
9-
The Snyk Eclipse plugin provides analysis of your code, containers, and Infrastructure as Code configurations.
10-
11-
Snyk scans for vulnerabilities, open source license issues, code quality, and infrastructure misconfigurations and returns results with security issues categorized by issue type and severity.
12-
13-
For open source, you receive automated, algorithm-based fix suggestions for both direct and transitive dependencies. This single plugin provides a Java vulnerability scanner or an open-source security scanner.
3+
The Snyk Eclipse plugin provides analysis of your code, containers, and infrastructure as code configurations.
144

155
Snyk scans for the following types of issues:
166

177
* [**Open Source Security**](https://snyk.io/product/open-source-security-management/) - security vulnerabilities and license issues in both the direct and in-direct (transitive) open-source dependencies pulled into the Snyk Project. See also the [`Open Source docs`](https://docs.snyk.io/products/snyk-open-source).
188
* [**Code Security**](https://snyk.io/product/snyk-code/) and [**Code Quality**](https://snyk.io/product/snyk-code/) - security vulnerabilities and quality issues in your code. See also the [Snyk Code docs](https://docs.snyk.io/products/snyk-code).
199
* [**Infrastructure as Code (IaC) Security**](https://snyk.io/product/infrastructure-as-code-security/) - configuration issues in your IaC templates: Terraform, Kubernetes, CloudFormation, and Azure Resource Manager. See also the [Snyk Infrastructure as Code docs](https://docs.snyk.io/products/snyk-infrastructure-as-code).
2010

11+
The Eclipse plugin provides automated, algorithm-based fix suggestions for both direct and transitive dependencies. This single plugin provides a Java vulnerability scanner and an open-source security scanner.
12+
2113
After you have installed and configured the Eclipse plugin, every time you run it, open a file, or autosave, Snyk scans the manifest files, proprietary code, and configuration files in your project. Snyk delivers actionable vulnerability, license, code quality, or misconfiguration issue details and displays the results natively within the Eclipse UI.
2214

2315
This page explains supported environments, support, and giving feedback and provides installation instructions. **After you complete the steps on this page**, you will continue by following the instructions in the other Eclipse plugins docs:
@@ -35,15 +27,15 @@ This page explains supported environments, support, and giving feedback and prov
3527
## Where you can download the Eclipse plugin
3628

3729
* **Eclipse Marketplace (recommended)**: [https://marketplace.eclipse.org/content/snyk-security-code%E2%80%8B-open-source%E2%80%8B-iac-configurations](https://marketplace.eclipse.org/content/snyk-security-code%E2%80%8B-open-source%E2%80%8B-iac-configurations)
38-
* Preview update site (CI/CD, on commit): [https://storage.googleapis.com/snyk-eclipse-plugin-test/preview/repository/](https://storage.googleapis.com/snyk-eclipse-plugin-test/preview/repository/)
39-
* Update site (weekly): [https://storage.googleapis.com/snyk-eclipse-plugin/weekly/repository/](https://storage.googleapis.com/snyk-eclipse-plugin/weekly/repository/)
30+
* Preview update site (CI/CD, on commit): [https://storage.googleapis.com/snyk-eclipse-plugin-test/preview-2.1/repository/](https://storage.googleapis.com/snyk-eclipse-plugin-test/preview-2.1/repository/)
31+
* Update site (weekly): [https://storage.googleapis.com/snyk-eclipse-plugin/weekly-2.1/repository/](https://storage.googleapis.com/snyk-eclipse-plugin-test/weekly-2.1/repository/)
4032
* Manual downloads: [https://github.com/snyk/snyk-eclipse-plugin/releases](https://github.com/snyk/snyk-eclipse-plugin/releases)
4133

4234
**Signing Information for Jars**
4335

44-
If you want to verify the correct provenance of your download, please verify the signing details from the Eclipse dialog with this data.
36+
If you want to verify the correct provenance of your download, verify the signing details from the Eclipse dialog with this data.
4537

46-
<img src="https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/image (58).png" alt="The signing key details to verify the integrity and origin of the download plugin" />
38+
<figure><img src="https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/image (134) (2) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (2) (2).png" alt="The signing key details to verify the integrity and origin of the download plugin"><figcaption><p>The signing key details to verify the integrity and origin of the download plugin</p></figcaption></figure>
4739

4840
The plugin runs on
4941

@@ -53,6 +45,9 @@ The plugin runs on
5345

5446
## Supported Eclipse Versions
5547

48+
* 2023-03
49+
* 2022-12
50+
* 2022-09
5651
* 2022-06
5752
* 2022-03
5853
* 2021-12
@@ -66,29 +61,35 @@ The plugin runs on
6661
* For Snyk Code, the Eclipse plugin supports all the [languages and frameworks supported by Snyk Code](https://docs.snyk.io/products/snyk-code/snyk-code-language-and-framework-support#language-support-with-snyk-code-ai-engine).
6762
* For Snyk IaC, the Eclipse plugin supports the following IaC templates: Terraform, Kubernetes, CloudFormation, and Azure Resource Manager.
6863

64+
## Supported operating systems and architecture
65+
66+
You can use the Eclipse plugin in the following environments:
67+
68+
* Linux: AMD64 and ARM64
69+
* Windows: 386 and AMD64
70+
* MacOS: AMD64 and ARM64
71+
6972
## How to install the Snyk Eclipse plugin
7073

7174
Navigate to the Marketplace from your running Eclipse instance. Search for Snyk and click **Install**.
7275

73-
<img src="https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/Screenshot 2022-05-17 at 16.29.29.png" alt="Eclipse Marketplace search showing Snyk plugin and Install button" />
74-
75-
When prompted accept the license agreement add the **Snyk Security** certificate to complete the installation (this happens only once).
76+
<figure><img src="https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/Screenshot 2022-05-17 at 16.29.29.png" alt="Eclipse Marketplace search showing Snyk plugin and Install button"><figcaption><p>Eclipse Marketplace search showing Snyk plugin and Install button</p></figcaption></figure>
7677

77-
![Add Snyk Security certificate](https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/Screenshot%202022-05-13%20at%2009.08.52)
78+
When you are prompted, accept the license agreement and add the **Snyk Security** certificate to complete the installation (this happens only once).
7879

7980
Restart the Eclipse instance:
8081

81-
<img src="https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/Screenshot 2022-05-13 at 09.16.37.png" alt="Restart Eclipse" />
82+
<figure><img src="https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/Screenshot 2022-05-13 at 09.16.37.png" alt="Restart Eclipse"><figcaption><p>Restart Eclipse</p></figcaption></figure>
8283

83-
Once Eclipse is restarted, the Snyk Wizard should run; this will setup your Snyk API endpoint and authentication token:
84+
Once Eclipse is restarted, the Snyk Wizard should run; this will set up your Snyk API endpoint and authentication token.
8485

8586
Once the Snyk configuration wizard runs; follow the instructions to set up your Snyk API:
8687

8788
<figure><img src="https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/eclipseSnykWizard (1).png" alt="Snyk configuration wizard"><figcaption><p>Snyk configuration wizard</p></figcaption></figure>
8889

8990
Once the Snyk is configured, navigate to **Eclipse Preferences** to ensure that **Snyk** now appears in the list:
9091

91-
<img src="https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/Screenshot 2022-05-17 at 16.36.07.png" alt="Eclipse preferences showing Snyk." />
92+
<figure><img src="https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/Screenshot 2022-05-17 at 16.36.07.png" alt="Eclipse preferences showing Snyk."><figcaption><p>Eclipse preferences showing Snyk.</p></figcaption></figure>
9293

9394
When you open the preferences you can opt out of downloading the CLI through the plugin and thus use your own installation of the CLI.
9495

0 commit comments

Comments
 (0)