mirror of
https://github.com/DeNNiiInc/UltyScan.git
synced 2026-04-17 20:35:59 +00:00
Complete documentation overhaul with Web UI installation
This commit is contained in:
@@ -1,127 +1,203 @@
|
||||
# Installation Guide
|
||||
|
||||
Welcome to the **UltyScan** installation guide. This document provides step-by-step instructions to get **UltyScan** up and running on your system.
|
||||
|
||||
## Table of Contents
|
||||
1. [Prerequisites](#prerequisites)
|
||||
2. [Native Installation (Kali Linux / Ubuntu / Debian)](#native-installation)
|
||||
3. [Docker Installation (Recommended for others)](#docker-installation)
|
||||
4. [Troubleshooting](#troubleshooting)
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before installing, ensure you have:
|
||||
- **Operating System**: Kali Linux (preferred), Ubuntu, Debian, or Parrot OS.
|
||||
- **Permissions**: Root (administrator) access is required. Use `sudo` if you are not logged in as root.
|
||||
- **Internet Connection**: Required to download dependencies.
|
||||
- **Operating System**: Ubuntu 22.04/24.04, Debian 11/12, or Kali Linux
|
||||
- **RAM**: Minimum 4GB (8GB recommended)
|
||||
- **Disk Space**: At least 10GB free
|
||||
- **Network**: Internet access for package downloads
|
||||
- **Permissions**: Root access required
|
||||
|
||||
---
|
||||
|
||||
## Native Installation
|
||||
## Quick Installation
|
||||
|
||||
This is the standard installation method for Kali Linux, Ubuntu, and Debian systems.
|
||||
|
||||
### Step 1: Clone the Repository
|
||||
Open your terminal (command prompt) and run the following command to download the **UltyScan** code to your computer.
|
||||
### One-Command Install
|
||||
|
||||
```bash
|
||||
git clone https://github.com/1N3/Sn1per
|
||||
git clone https://github.com/DeNNiiInc/UltyScan /usr/share/sniper
|
||||
cd /usr/share/sniper
|
||||
bash install.sh force
|
||||
```
|
||||
*Note: This creates a folder named `Sn1per`. You can rename it to `UltyScan` if you wish, but the internal scripts expect standard paths.*
|
||||
|
||||
### Step 2: Navigate to the Directory
|
||||
Move into the downloaded folder:
|
||||
The `force` flag runs the entire installation without prompts.
|
||||
|
||||
### What Gets Installed
|
||||
|
||||
The installer automatically sets up:
|
||||
|
||||
| Component | Description |
|
||||
|-----------|-------------|
|
||||
| **Core Scanner** | Main sniper script and modes |
|
||||
| **Dependencies** | Nmap, Metasploit, Python tools |
|
||||
| **Web Interface** | Apache + PHP dashboard |
|
||||
| **Sudoers Config** | Web UI permissions |
|
||||
| **Symlinks** | Easy command access |
|
||||
|
||||
---
|
||||
|
||||
## Step-by-Step Installation
|
||||
|
||||
### 1. Update System
|
||||
|
||||
```bash
|
||||
cd Sn1per
|
||||
apt update && apt upgrade -y
|
||||
```
|
||||
|
||||
### Step 3: Run the Installer
|
||||
Run the installation script. This script will automatically download and install all necessary tools and dependencies.
|
||||
|
||||
**Warning**: This process can take a while (10-30 minutes) depending on your internet speed, as it installs many security tools.
|
||||
### 2. Install Git
|
||||
|
||||
```bash
|
||||
sudo bash install.sh
|
||||
apt install -y git
|
||||
```
|
||||
|
||||
### Step 4: Verification
|
||||
Once the script finishes, verify the installation by running the scanner's help command:
|
||||
### 3. Clone Repository
|
||||
|
||||
```bash
|
||||
sudo sniper --help
|
||||
git clone https://github.com/DeNNiiInc/UltyScan /usr/share/sniper
|
||||
```
|
||||
If you see the help menu with the logo, the installation was successful!
|
||||
|
||||
### 4. Run Installer
|
||||
|
||||
```bash
|
||||
cd /usr/share/sniper
|
||||
bash install.sh force
|
||||
```
|
||||
|
||||
### 5. Verify Installation
|
||||
|
||||
```bash
|
||||
sniper --help
|
||||
```
|
||||
|
||||
You should see the help menu with all available options.
|
||||
|
||||
---
|
||||
|
||||
## Docker Installation
|
||||
|
||||
If you are not using Kali/Debian, or prefer a containerized environment, use Docker. This keeps your host system clean.
|
||||
|
||||
### Prerequisites
|
||||
- Ensure **Docker** and **Docker Compose** are installed on your system.
|
||||
- [Install Docker Engine](https://docs.docker.com/engine/install/)
|
||||
- [Install Docker Compose](https://docs.docker.com/compose/install/)
|
||||
|
||||
### Option A: Kali Linux Container (Recommended)
|
||||
- Docker installed
|
||||
- Docker Compose installed
|
||||
|
||||
1. **Start the container**:
|
||||
From within the `Sn1per` directory, run:
|
||||
```bash
|
||||
sudo docker compose up -d
|
||||
```
|
||||
*The `-d` flag runs it in the background.*
|
||||
### Steps
|
||||
|
||||
2. **Access the container**:
|
||||
To start using the scanner, enter the interactive shell:
|
||||
```bash
|
||||
sudo docker run --privileged -it sn1per-kali-linux /bin/bash
|
||||
```
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/DeNNiiInc/UltyScan /opt/ultyscan
|
||||
cd /opt/ultyscan
|
||||
|
||||
3. **Run the tool**:
|
||||
Inside the container, you can run:
|
||||
```bash
|
||||
sniper --help
|
||||
```
|
||||
# Build and start container
|
||||
docker-compose up -d
|
||||
|
||||
### Option B: BlackArch Container
|
||||
# Enter the container
|
||||
docker exec -it kali-linux bash
|
||||
|
||||
If you prefer BlackArch Linux:
|
||||
# Run installer inside container
|
||||
./install.sh force
|
||||
```
|
||||
|
||||
1. **Start the container**:
|
||||
```bash
|
||||
sudo docker compose -f docker-compose-blackarch.yml up -d
|
||||
```
|
||||
---
|
||||
|
||||
2. **Access the container**:
|
||||
```bash
|
||||
sudo docker run --privileged -it sn1per-blackarch /bin/bash
|
||||
```
|
||||
## Post-Installation
|
||||
|
||||
### Access the Web Interface
|
||||
|
||||
After installation, you'll see:
|
||||
|
||||
```
|
||||
============================================
|
||||
ULTYSCAN WEB INTERFACE
|
||||
============================================
|
||||
URL: http://YOUR_IP/ultyscan/
|
||||
Logs: /var/log/ultyscan/
|
||||
Loot: /usr/share/sniper/loot/workspace/
|
||||
============================================
|
||||
```
|
||||
|
||||
Open the URL in your browser to access the dashboard.
|
||||
|
||||
### Configure API Keys
|
||||
|
||||
Edit the configuration file to add your API keys:
|
||||
|
||||
```bash
|
||||
nano /root/.sniper.conf
|
||||
```
|
||||
|
||||
Add your keys:
|
||||
|
||||
```bash
|
||||
SHODAN_API_KEY="your_shodan_key"
|
||||
CENSYS_APP_ID="your_censys_id"
|
||||
CENSYS_API_SECRET="your_censys_secret"
|
||||
HUNTERIO_KEY="your_hunter_key"
|
||||
GITHUB_API_KEY="your_github_token"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "Command not found"
|
||||
If running `sniper` says command not found:
|
||||
- Ensure you ran the install script as root (`sudo bash install.sh`).
|
||||
- Try running it directly from the installation directory:
|
||||
```bash
|
||||
cd /usr/share/sniper
|
||||
./sniper --help
|
||||
```
|
||||
### Issue: Command Not Found
|
||||
|
||||
### Dependency Errors
|
||||
If the installer fails on a specific package:
|
||||
1. Run `sudo apt update --fix-missing`
|
||||
2. Run `sudo apt upgrade`
|
||||
3. Re-run `./install.sh`
|
||||
```bash
|
||||
# Check if symlink exists
|
||||
ls -la /usr/bin/sniper
|
||||
|
||||
### Docker "Permission Denied"
|
||||
If you get permission errors with Docker, ensure your user is in the `docker` group or use `sudo` before docker commands.
|
||||
# Recreate if missing
|
||||
ln -s /usr/share/sniper/sniper /usr/bin/sniper
|
||||
```
|
||||
|
||||
### Issue: Web UI Not Loading
|
||||
|
||||
```bash
|
||||
# Check Apache status
|
||||
systemctl status apache2
|
||||
|
||||
# Restart Apache
|
||||
systemctl restart apache2
|
||||
|
||||
# Check if files exist
|
||||
ls -la /var/www/html/ultyscan/
|
||||
```
|
||||
|
||||
### Issue: Scans Not Starting from Web UI
|
||||
|
||||
```bash
|
||||
# Check sudoers configuration
|
||||
cat /etc/sudoers.d/www-data-sniper
|
||||
|
||||
# Should contain:
|
||||
# www-data ALL=(ALL) NOPASSWD: /usr/bin/bash /usr/share/sniper/sniper *
|
||||
|
||||
# Fix if missing:
|
||||
echo 'www-data ALL=(ALL) NOPASSWD: /usr/bin/bash /usr/share/sniper/sniper *' > /etc/sudoers.d/www-data-sniper
|
||||
chmod 440 /etc/sudoers.d/www-data-sniper
|
||||
```
|
||||
|
||||
### Issue: Permission Denied Errors
|
||||
|
||||
```bash
|
||||
# Fix ownership
|
||||
chown -R root:root /usr/share/sniper
|
||||
chmod +x /usr/share/sniper/sniper
|
||||
|
||||
# Fix web UI permissions
|
||||
chown -R www-data:www-data /var/www/html/ultyscan
|
||||
chown www-data:www-data /var/log/ultyscan
|
||||
```
|
||||
|
||||
---
|
||||
[Return to README](../README.md)
|
||||
|
||||
## Updating
|
||||
|
||||
To update to the latest version:
|
||||
|
||||
```bash
|
||||
cd /usr/share/sniper
|
||||
git pull origin main
|
||||
bash install.sh force
|
||||
```
|
||||
|
||||
Or from the Web UI: Go to **Settings** → **Update UltyScan**
|
||||
|
||||
Reference in New Issue
Block a user