Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
scriptnull authored Oct 18, 2024
1 parent b711916 commit c6a8beb
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# goKakashi - The Centralized Image Vulnerability Platform 🔍🚀
# gokakashi - The Centralized Image Vulnerability Platform 🔍🚀

[![golangci-lint](https://github.com/gokakashi/goKakashi/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/gokakashi/goKakashi/actions/workflows/lint.yml)
[![golangci-lint](https://github.com/gokakashi/gokakashi/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/gokakashi/gokakashi/actions/workflows/lint.yml)

Make vulnerability management effortless with **goKakashi**!
This tool simplifies the process of pulling, scanning, reporting, and notifying across all your container images. Gone are the days of manually juggling multiple tools and managing disparate processes—**goKakashi** brings everything under one roof.
🚧 Heavy work in progress 🚧

Make vulnerability management effortless with **gokakashi**!
This tool simplifies the process of pulling, scanning, reporting, and notifying across all your container images. Gone are the days of manually juggling multiple tools and managing disparate processes—**gokakashi** brings everything under one roof.

## Key Features
1. **Multi-Platform Image Aggregation**
Expand All @@ -12,8 +14,8 @@ This tool simplifies the process of pulling, scanning, reporting, and notifying
**Continuously developing** to support more platforms.

2. **Comprehensive Image Scanning**
Use goKakashi’s multi-scanner support to detect vulnerabilities in your images.
You have the flexibility to scan based on severity levels like CRITICAL or HIGH or both CRITICAL AND HIGH. By default, goKakashi scans all severities.\
Use gokakashi’s multi-scanner support to detect vulnerabilities in your images.
You have the flexibility to scan based on severity levels like CRITICAL or HIGH or both CRITICAL AND HIGH. By default, gokakashi scans all severities.\
_Current Support:_ Trivy scanner for detailed vulnerability scans.\
**Continuously developing** to support more scanners.

Expand All @@ -22,7 +24,7 @@ This tool simplifies the process of pulling, scanning, reporting, and notifying

5. **Custom Notifications & Ticketing**
Customize notifications to suit your needs, including where to get notified and control over priority, assignment, due dates etc.\
Automatically create and assign issues based on the severity of detected vulnerabilities. goKakashi ensures that new issues are only created when relevant, helping you avoid unnecessary noise.\
Automatically create and assign issues based on the severity of detected vulnerabilities. gokakashi ensures that new issues are only created when relevant, helping you avoid unnecessary noise.\
Meaningful tracking is maintained by creating new issues when key details change, such as Vulnerability (CVE), Severity, Installed Version, or Fixed Version\
Here's an example of the information you'll receive in a notification:
```
Expand Down Expand Up @@ -57,11 +59,11 @@ This tool simplifies the process of pulling, scanning, reporting, and notifying
Need to scan an image during development? Use our API endpoint to scan and get reports on the fly!\
_Current Support:_ Under development.

## Why Use goKakashi?
- **Reduce Engineering Overhead:** By centralizing the scanning process, goKakashi removes the need for multiple tools and need for managing and collaborating at multiple places.
## Why Use gokakashi?
- **Reduce Engineering Overhead:** By centralizing the scanning process, gokakashi removes the need for multiple tools and need for managing and collaborating at multiple places.
- **Streamline Release Management:** Automate the detection, reporting, and discussing resolution of vulnerabilities, reducing last-minute firefights.
- **Increase Security Proactivity:** Catch vulnerabilities before your customers do and maintain their trust with proactive management.
- **Scalability:** Designed to support long-term solutions for managing large-scale image vulnerability detection, goKakashi streamlines everything into a single, centralized platform.
- **Scalability:** Designed to support long-term solutions for managing large-scale image vulnerability detection, gokakashi streamlines everything into a single, centralized platform.
- **Unified Platform:** One tool to rule them all—be it for vulnerability scanning, reporting, or even access and communicating directly with your team!


Expand All @@ -71,10 +73,10 @@ This tool simplifies the process of pulling, scanning, reporting, and notifying
2. **Schedule Scans:** Set up a cron job to scan your images periodically.
3. **Choose Notification Integration:** Customize your notifications—integrate with Linear Jira or slack to get vulnerability alerts directly in your workflow.
_Current Support:_ Linear.
4. **Check Reports:** Access both public and private reports via the endpoints and where to store generated reports, defined by goKakashi. Go crazy and customize how you share them internally or with your clients.
4. **Check Reports:** Access both public and private reports via the endpoints and where to store generated reports, defined by gokakashi. Go crazy and customize how you share them internally or with your clients.

**Configuration Example:**
The goKakashi tool is highly configurable, giving you the flexibility to manage different scanning use cases.
The gokakashi tool is highly configurable, giving you the flexibility to manage different scanning use cases.
Below is an example of a typical config file:\
```
scan_targets:
Expand Down Expand Up @@ -148,7 +150,7 @@ docker run -it -v /Users/ashwiniag/config:/app/config -v /var/run/docker.sock:/v
<more to be dumped from notes>

## Current Phase
goKakashi is currently in active development. Right now, we support:
gokakashi is currently in active development. Right now, we support:

- Dockerhub Integration
- Trivy for Vulnerability Scanning
Expand All @@ -159,7 +161,7 @@ goKakashi is currently in active development. Right now, we support:
More features are on the way! 🚀 Stay tuned as we continue to build and improve. Your feedback and pain points are highly appreciated! 🌻

## Transparency & Feedback ✨
We’re excited to share goKakashi early with the community to gather feedback and improve quickly.\
We’re excited to share gokakashi early with the community to gather feedback and improve quickly.\
Whether you're curious, have suggestions, or if your team is looking for a fast and efficient way to streamline vulnerability scanning (and get back to enjoying that extra ice cream or your favorite anime), we’d love to hear from you. Feel free to open an issue or submit a pull request or request any features that would help on GitHub. Let’s build something awesome together!

## Reach Out 💭
Expand Down

0 comments on commit c6a8beb

Please sign in to comment.