Installation
Social Analyzer can be installed and run in multiple ways. Choose the method that best fits your environment and workflow.
Prerequisites
Before installing Social Analyzer, ensure you have one of the following:
- Node.js (version 13 or higher) and npm
- Python 3 and pip3
- Docker and docker-compose (optional)
For screenshot functionality, you’ll need the latest version of Chrome or Firefox ESR installed on your system.
Installation Methods
Node.js Web App
Node.js CLI
Python Package
Python Script
Node.js Web App (Recommended)
The Web App provides the most feature-rich interface with visual analysis tools.Install system dependencies
Install required system packages: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
Depending on your Linux distribution, the first two lines may not be needed.
Clone the repository
git clone https://github.com/qeeqbox/social-analyzer.git
cd social-analyzer
Install Node dependencies
Start the Web App
Access the Web App at: http://0.0.0.0:9005/app.html Node.js CLI
Use the Node.js CLI for command-line automation and scripting.Install system dependencies
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
Clone and install
git clone https://github.com/qeeqbox/social-analyzer.git
cd social-analyzer
npm install
Run CLI commands
Test the installation:nodejs app.js --username "johndoe"
Python Package
Install Social Analyzer as a Python package via pip.Install Python and pip
sudo apt-get update
sudo apt-get install python3 python3-pip
Install social-analyzer
pip3 install social-analyzer
Verify installation
python3 -m social-analyzer --username "johndoe"
Python Script (From Source)
Run Social Analyzer directly from the Python source code.Install system dependencies
sudo apt-get update
sudo apt-get install git python3 python3-pip
Clone the repository
git clone https://github.com/qeeqbox/social-analyzer
cd social-analyzer
Install Python dependencies
pip3 install -r requirements.txt
Run the script
python3 app.py --username "janedoe"
Docker Installation
Docker installation provides grid option for faster parallel checking. Refer to the official wiki for Docker-specific instructions. Linux
The installation commands above are tested on Ubuntu/Debian-based distributions. For other distributions, adjust package manager commands accordingly.
Windows & macOS
For Windows, macOS, and other platforms including Raspberry Pi, check the installation wiki for platform-specific instructions.
Python API Import
If you want to use Social Analyzer programmatically in your Python projects:
from importlib import import_module
SocialAnalyzer = import_module("social-analyzer").SocialAnalyzer()
results = SocialAnalyzer.run_as_object(username="johndoe", silent=True)
print(results)
Advanced Python Usage
from importlib import import_module
SocialAnalyzer = import_module("social-analyzer").SocialAnalyzer()
results = SocialAnalyzer.run_as_object(
username="johndoe,janedoe",
silent=True,
output="json",
filter="good",
metadata=False,
timeout=10,
profiles="detected"
)
print(results)
Verifying Installation
Test your installation with a simple query:
nodejs app.js --username "test" --websites "youtube"
Troubleshooting
Social Analyzer requires Node.js version 13 or higher. Check your version:If needed, update Node.js using nvm or your package manager.
Ensure all dependencies are installed:npm install
# or
pip3 install -r requirements.txt
Screenshot functionality not working
Screenshot features require Chrome or Firefox ESR. Install the browser:sudo apt-get install firefox-esr
# or install Chrome from the official website
If you encounter permission errors when installing globally, use:sudo npm install
# or for Python
pip3 install --user social-analyzer
Next Steps
Quick Start
Learn how to run your first profile search with Social Analyzer
