Skip to content

Commit 698870c

Browse files
authored
Feature: Add Snyk topic (init base) (#732)
1 parent 80e0b4d commit 698870c

3 files changed

Lines changed: 127 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,13 @@ We cover a wide range of DevOps topics in our content library, explore them unde
287287
<td>📖 <a href="https://tomcat.apache.org/">tomcat.apache.org</a></td>
288288
<td>✔️ <a href="./topics/apachetomcat/basic/">Tomcat basics</a></td>
289289
</tr>
290+
<tr>
291+
<td><img height="28" width="32" src="https://cdn.worldvectorlogo.com/logos/snyk.svg" /></td>
292+
<td>Snyk</td>
293+
<td><a href="./topics/snyk/">snyk</a></td>
294+
<td>📖 <a href="https://snyk.io/">snyk.io</a></td>
295+
<td>🏃 <a href="./topics/snyk/basic/">Snyk basics</a></td>
296+
</tr>
290297
</table>
291298

292299
- And **more upcoming topics...⏩** you can star/follow this repository to get more up-to-dated content ⭐

topics/snyk/README.md

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# Snyk
2+
3+
## 1. What is Snyk?
4+
5+
### Overview
6+
7+
The **Snyk** platform quickly finds and fixes security issues in proprietary code, open source dependencies, container images, and cloud infrastructure so businesses can build security directly into their continuous development process.
8+
Source: https://snyk.io/about/
9+
10+
### Official Website of Snyk
11+
12+
- https://snyk.io/
13+
14+
### Official Documentation of Snyk
15+
16+
- https://docs.snyk.io/
17+
18+
### What You Can Do with Snyk
19+
20+
- Scan and fix vulnerabilities in application code, dependencies, Docker images, and IaC (Terraform, Kubernetes, etc.).
21+
- Integrate security into your CI/CD pipelines.
22+
- Monitor projects for newly disclosed vulnerabilities.
23+
- Collaborate across Dev, Sec, and Ops teams.
24+
25+
Learn more: https://snyk.io/product/
26+
27+
---
28+
29+
## 2. Prerequisites
30+
31+
- Basic understanding of software development, dependencies, and build tools (npm, Maven, Docker, etc.).
32+
- Node.js installed (required for Snyk CLI).
33+
- Git (for scanning Git-based repositories).
34+
- A free Snyk account (sign up at https://snyk.io/login).
35+
36+
---
37+
38+
## 3. Installation
39+
40+
### How to Install Snyk CLI?
41+
42+
1. **Install Node.js** (if not already installed):
43+
44+
- https://nodejs.org/
45+
46+
2. **Install Snyk CLI**:
47+
48+
```bash
49+
npm install -g snyk
50+
```
51+
52+
3. **Authenticate with Snyk**:
53+
```bash
54+
snyk auth
55+
```
56+
- This will open a browser for you to log in.
57+
58+
See more: https://snyk.io/platform/snyk-cli/
59+
60+
---
61+
62+
## 4. Basics of Snyk
63+
64+
### Getting started
65+
66+
- Getting started with https://docs.snyk.io/getting-started
67+
68+
### Scanning Your Project
69+
70+
1. Navigate to your project directory:
71+
72+
```bash
73+
cd /path/to/your/project
74+
```
75+
76+
2. Run a test:
77+
78+
```bash
79+
snyk test
80+
```
81+
82+
3. To monitor the project continuously:
83+
```bash
84+
snyk monitor
85+
```
86+
87+
### Fixing Vulnerabilities
88+
89+
- Use:
90+
```bash
91+
snyk fix
92+
```
93+
- Automatically applies safe upgrades and patches where possible.
94+
95+
### Docker Image Scanning
96+
97+
```bash
98+
snyk container test your-image:tag
99+
```
100+
101+
### IaC Scanning (Terraform, Kubernetes YAML, etc.)
102+
103+
```bash
104+
snyk iac test
105+
```
106+
107+
---
108+
109+
## 5. Snyk Hands-On
110+
111+
- See: [basic](./basic/) for hands-on examples and test cases.
112+
113+
---
114+
115+
## 6. More...
116+
117+
### Recommended Resources
118+
119+
- [Snyk Open Source Guide](https://snyk.io/product/open-source-security-management/)

topics/snyk/basic/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Coming soon

0 commit comments

Comments
 (0)