diff --git a/README.md b/README.md index 0d0f8a86..a4df0d07 100755 --- a/README.md +++ b/README.md @@ -9,21 +9,25 @@ The analysis and public extracted information from this OSINT tool could help in `This project is currently used by some law enforcement agencies in countries where resources are limited - The detection database is different than the one shared here..` ## So·cial Me·di·a + Websites and applications that enable users to create and share content or to participate in social networking - Oxford Dictionary ## Structure - + ## APP (Preferred!) + Standard localhost WEB APP url: http://0.0.0.0:9005/app.html -## CLI +## CLI + ## Features + - String & name analysis (Permutations and Combinations) - Find a profile using multiple techniques (HTTPS library & Webdriver) - Multi profile search (Used for correlation - any combination separated with "," ) @@ -54,12 +58,15 @@ Standard localhost WEB APP url: http://0.0.0.0:9005/app.html - And, more!! ## Special Detections + - Facebook (Phone number, name, or profile name) - Gmail (example@gmail.com) - Google (example@example.com) ## Install & Run + ### Linux (As Node WebApp) + ```bash sudo apt-get update #Depedning on your Linux distro, you may or may not need these 2 lines @@ -74,6 +81,7 @@ npm start ``` ### Linux (As Node CLI) + ```bash sudo apt-get update #Depedning on your Linux distro, you may or may not need these 2 lines @@ -93,6 +101,7 @@ nodejs app.js --username "johndoe" --type "adult" ``` ### Linux (As python package) + ```bash sudo apt-get update sudo apt-get install python3 python3-pip @@ -109,6 +118,7 @@ python3 -m social-analyzer --username "johndoe" --websites "car" --logs --screen ``` ### Linux (As python script) + ```bash sudo apt-get update sudo apt-get install git python3 python3-pip @@ -127,6 +137,7 @@ python3 app.py --username "johndoe" --websites "car" --logs --screenshots ``` ### Importing as object (python) + ```python #E.g. #1 @@ -143,10 +154,16 @@ print(results) ``` ### Linux, Windows, MacOS, Raspberry pi.. + - check this [wiki](https://github.com/qeeqbox/social-analyzer/wiki/install) for all possible installation methods - check this [wiki](https://github.com/qeeqbox/social-analyzer/wiki/integration) for integrating social-analyzer with your OSINT tools, feeds, etc... +```markdown +For detailed setup instructions, see [SETUP.md](SETUP.md) +``` + ## social-analyzer --h + ``` Required Arguments: --username E.g. johndoe, john_doe or johndoe9999 @@ -179,17 +196,21 @@ Setting: ``` ## Open Shell + [![Open in Cloud Shell](https://img.shields.io/static/v1?label=%3E_&message=Open%20in%20Cloud%20Shell&color=3267d6&style=flat-square)](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/qeeqbox/social-analyzer&tutorial=README.md) [![Open in repl.it Shell](https://img.shields.io/static/v1?label=%3E_&message=Open%20in%20repl.it%20Shell&color=606c74&style=flat-square)](https://repl.it/github/qeeqbox/social-analyzer) ## Resources + - DuckDuckGo API, Google API, NodeJS, bootstrap, selectize, jQuery, Wikipedia, font-awesome, selenium-webdriver & tesseract.js - Let me know if I missed a reference or resource! ## Disclaimer\Notes + - Download this project from GitHub and treat it as a security project - If you want your website to be excluded from this project list, please reach out to me - This tool is meant to be used locally, not as a service (It does not have any Access Control) - For issues related to modules that end with -private or under the private group ![](https://raw.githubusercontent.com/qeeqbox/social-analyzer/main/readme/modules.png), reach out directly to me (do not open an issue on GitHub) ## Other Projects + [![](https://github.com/qeeqbox/.github/blob/main/data/analyzer.png)](https://github.com/qeeqbox/analyzer) [![](https://github.com/qeeqbox/.github/blob/main/data/chameleon.png)](https://github.com/qeeqbox/chameleon) [![](https://github.com/qeeqbox/.github/blob/main/data/honeypots.png)](https://github.com/qeeqbox/honeypots) [![](https://github.com/qeeqbox/.github/blob/main/data/osint.png)](https://github.com/qeeqbox/osint) [![](https://github.com/qeeqbox/.github/blob/main/data/url-sandbox.png)](https://github.com/qeeqbox/url-sandbox) [![](https://github.com/qeeqbox/.github/blob/main/data/mitre-visualizer.png)](https://github.com/qeeqbox/mitre-visualizer) [![](https://github.com/qeeqbox/.github/blob/main/data/woodpecker.png)](https://github.com/qeeqbox/woodpecker) [![](https://github.com/qeeqbox/.github/blob/main/data/docker-images.png)](https://github.com/qeeqbox/docker-images) [![](https://github.com/qeeqbox/.github/blob/main/data/seahorse.png)](https://github.com/qeeqbox/seahorse) [![](https://github.com/qeeqbox/.github/blob/main/data/rhino.png)](https://github.com/qeeqbox/rhino) [![](https://github.com/qeeqbox/.github/blob/main/data/raven.png)](https://github.com/qeeqbox/raven) [![](https://github.com/qeeqbox/.github/blob/main/data/image-analyzer.png)](https://github.com/qeeqbox/image-analyzer) diff --git a/SETUP.md b/SETUP.md new file mode 100644 index 00000000..50f24dbb --- /dev/null +++ b/SETUP.md @@ -0,0 +1,149 @@ +# `SETUP.md` — Social Analyzer Installation Guide + +

+ +

+ +**Social Analyzer** — API, CLI, and Web App for analyzing & finding profiles across +1000 social media websites. + +This guide explains how to **install and run Social Analyzer** on Linux, Windows, macOS, and Raspberry Pi. + +--- + +## 1. Prerequisites + +- **Node.js** ≥ 18.x +- **npm** (comes with Node.js) +- **Python 3.x** + pip (for Python CLI support) +- **Firefox** (or Chrome for WebDriver screenshots) +- **Tesseract OCR** (for OCR-based detection modules) +- Optional: **Docker** (for containerized execution) + +--- + +## 2. Linux Installation + +### a. Node.js Web App + +```bash +sudo apt-get update +sudo DEBIAN_FRONTEND=noninteractive apt-get install -y software-properties-common +sudo add-apt-repository ppa:mozillateam/ppa -y +sudo apt-get install -y firefox-esr tesseract-ocr git nodejs npm + +git clone https://github.com/qeeqbox/social-analyzer.git +cd social-analyzer + +npm update +npm install +npm start +``` + +- Access the web app at: [http://0.0.0.0:9005/app.html](http://0.0.0.0:9005/app.html) + +### b. Node.js CLI + +```bash +npm install +nodejs app.js --username "johndoe" +# Options: +# --metadata : extract metadata +# --top 100 : limit to top 100 websites +# --type "adult" : search by website category +``` + +### c. Python Package + +```bash +pip3 install social-analyzer +python3 -m social-analyzer --username "johndoe" +``` + +### d. Python Script + +```bash +git clone https://github.com/qeeqbox/social-analyzer +cd social-analyzer +pip3 install -r requirements.txt + +python3 app.py --username "johndoe" +``` + +--- + +## 3. Windows Installation + +- Install [Node.js](https://nodejs.org/) and Python 3.x +- Install **Firefox** or **Chrome** for WebDriver +- Install **Tesseract OCR**: [https://github.com/tesseract-ocr/tesseract](https://github.com/tesseract-ocr/tesseract) +- Clone the repo: + +```powershell +git clone https://github.com/qeeqbox/social-analyzer.git +cd social-analyzer +npm install +node app.js --username "johndoe" +``` + +--- + +## 4. macOS Installation + +```bash +brew update +brew install node python3 tesseract firefox git +git clone https://github.com/qeeqbox/social-analyzer.git +cd social-analyzer +npm install +node app.js --username "johndoe" +``` + +--- + +## 5. Raspberry Pi Installation + +```bash +sudo apt-get update +sudo apt-get install -y nodejs npm python3 python3-pip git tesseract-ocr firefox-esr +git clone https://github.com/qeeqbox/social-analyzer.git +cd social-analyzer +npm install +node app.js --username "johndoe" +``` + +--- + +## 6. Running Options + +| Command Option | Description | +| -------------- | --------------------------------------------- | +| `--username` | Required: e.g., johndoe, johndoe,janedoe | +| `--websites` | List specific websites: youtube tiktok tumblr | +| `--mode` | Analysis mode: fast, slow, special | +| `--output` | `json` or `pretty` output | +| `--metadata` | Extract metadata if possible | +| `--top` | Limit top N websites | +| `--type` | Filter websites by category | +| `--filter` | Filter by `good`, `maybe`, `bad` | +| `--profiles` | Filter profiles by detected/failed/unknown | + +> See `social-analyzer --h` for full CLI help. + +--- + +## 7. Troubleshooting + +- **Node version issues:** Ensure Node.js ≥18.x +- **Python errors:** Check `pip3` and correct Python version +- **Permission errors:** Use `sudo` on Linux/Mac or run PowerShell as Admin on Windows +- **Missing Firefox/Chrome:** Required for WebDriver screenshots +- **Tesseract OCR issues:** Ensure it's installed and accessible in PATH + +--- + +## 8. Additional Resources + +- Wiki for integration: [https://github.com/qeeqbox/social-analyzer/wiki/integration](https://github.com/qeeqbox/social-analyzer/wiki/integration) +- Wiki for full installation methods: [https://github.com/qeeqbox/social-analyzer/wiki/install](https://github.com/qeeqbox/social-analyzer/wiki/install) + +---