Skip to content

Commit 2af80cc

Browse files
committed
Documentation improvements
1 parent 315849a commit 2af80cc

File tree

1 file changed

+48
-1
lines changed

1 file changed

+48
-1
lines changed

README.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,46 @@ A security tool that detects malicious packages from external vulnerability feed
1010
<img src="art/demo.gif" alt="Malifiscan In-Action"/>
1111
</div>
1212

13+
## Table of Contents
14+
15+
- [Features](#️-features)
16+
- [Package Blocking & Security](#-package-blocking--security)
17+
- [How Exclusion Patterns Work](#how-exclusion-patterns-work)
18+
- [Blocking Commands](#blocking-commands)
19+
- [Safety Features](#safety-features)
20+
- [Quick Start](#-quick-start)
21+
- [Prerequisites](#prerequisites)
22+
- [Installation](#installation)
23+
- [Option 1: Using UV (Recommended)](#option-1-using-uv-recommended)
24+
- [Option 2: Using pip (Traditional)](#option-2-using-pip-traditional)
25+
- [Option 3: Using Docker](#option-3-using-docker)
26+
- [Usage](#-usage)
27+
- [Core CLI Commands](#core-cli-commands)
28+
- [Comprehensive CLI (cli.py)](#comprehensive-cli-clipy)
29+
- [Simplified Entry Point (python -m src.main)](#simplified-entry-point-python--m-srcmain)
30+
- [Interactive Mode](#interactive-mode)
31+
- [Cron Usage](#cron-usage)
32+
- [Testing](#-testing)
33+
- [Configuration](#-configuration)
34+
- [Quick Start Configuration](#quick-start-configuration)
35+
- [Configuration Layers (Priority Order)](#configuration-layers-priority-order)
36+
- [Configuration Files](#configuration-files)
37+
- [Notifications](#-notifications)
38+
- [Sample Output](#-sample-output)
39+
- [Performance Considerations](#-performance-considerations)
40+
- [Security Notes](#-security-notes)
41+
- [Documentation](#-documentation)
42+
- [Troubleshooting](#-troubleshooting)
43+
- [License](#-license)
44+
1345
## 🛡️ Features
1446

1547
- **OSV Feed Integration**: Fetches malicious package data from Google Cloud Storage OSV vulnerability database
1648
- **JFrog Artifactory Search**: Searches for packages in your Artifactory repositories using AQL (Artifactory Query Language)
1749
- **Security Cross-Reference**: Compares OSV malicious packages against your JFrog repositories to identify potential threats
1850
- **Package Blocking**: Block malicious packages using JFrog Artifactory exclusion patterns to prevent downloads
1951
- **Package Management**: View, block, and unblock packages with enterprise-grade safety features
52+
- **Notifications & Alerts**: Configurable notifications via webhook, or Microsoft Teams when malicious packages are detected
2053
- **Time-Based Filtering**: Configurable time window for fetching recent malicious packages (default: 48 hours)
2154
- **Rich CLI Interface**: Interactive command-line interface with progress bars and formatted output
2255
- **Comprehensive Health Checks**: Validates connectivity to OSV and JFrog services
@@ -370,7 +403,21 @@ storage_service:
370403
enabled: true
371404
```
372405
373-
## � Sample Output
406+
## 📢 Notifications
407+
408+
Malifiscan supports configurable notifications to alert your team when malicious packages are detected. Test your notification configuration with built-in testing commands that support both basic connectivity checks and realistic malicious package simulations.
409+
410+
```bash
411+
# Test basic notification functionality
412+
uv run python cli.py notifications check
413+
414+
# Test with realistic malicious package payload
415+
uv run python cli.py notifications check --malicious
416+
```
417+
418+
Configure webhook, or Microsoft Teams integration through the notification service settings in your configuration files.
419+
420+
## 📊 Sample Output
374421

375422
**Security Cross-Reference Scan:**
376423
```

0 commit comments

Comments
 (0)