A modern platform for visual, flexible, and extensible graph-based investigations. For cybersecurity analysts and investigators.
Update README.md
dextmorgn41bf1e2a9489
diff --git a/flowsint-api/README.md b/flowsint-api/README.mdindex 2b553006..d0ad6d46 100644--- a/flowsint-api/README.md+++ b/flowsint-api/README.md@@ -3,51 +3,16 @@## Installation1. Install Python dependencies:+2.```bash-pip install -r requirements.txt+poetry install```-2. Install spaCy models for person recognition:-```bash-python install_spacy_models.py-```+## Run-Or manually install the models:```bash-python -m pip install fr_core_news_md # French model (preferred)-python -m pip install en_core_web_md # English model (fallback)+# dev+poetry run uvicorn app.main:app --host 0.0.0.0 --port 5001 --reload+# prod+poetry run uvicorn app.main:app --host 0.0.0.0 --port 5001```--## Features--### Website Crawler (`to_crawler.py`)--The website crawler scans websites to extract:-- **Emails**: Email addresses found in the website content-- **Phone Numbers**: Phone numbers in various formats-- **Individuals**: Person names using spaCy Named Entity Recognition (NER)--The crawler:-- Follows internal links within the same domain-- Respects robots.txt and implements delays between requests-- Extracts visible text content from HTML pages-- Creates Neo4j relationships between websites and found entities--#### Person Recognition--The crawler uses spaCy to identify person names in website content:-- Supports both French (`fr_core_news_md`) and English (`en_core_web_md`) models-- Automatically falls back to English if French model is not available-- Creates `Individual` objects with first name, last name, and full name-- Establishes `MENTIONS_INDIVIDUAL` relationships in Neo4j--#### Configuration--The crawler can be configured with:-- `max_pages`: Maximum number of pages to crawl (default: 50)-- `timeout`: Request timeout in seconds (default: 30)-- `delay`: Delay between requests in seconds (default: 1.0)--## Usage--The API provides REST endpoints for various scanning operations. See the individual transform modules for specific usage examples.