mirror of
https://github.com/DeNNiiInc/UltyScan.git
synced 2026-04-17 18:26:00 +00:00
128 lines
3.5 KiB
Markdown
128 lines
3.5 KiB
Markdown
# 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.
|
|
|
|
---
|
|
|
|
## Native 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.
|
|
|
|
```bash
|
|
git clone https://github.com/1N3/Sn1per
|
|
```
|
|
*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:
|
|
|
|
```bash
|
|
cd Sn1per
|
|
```
|
|
|
|
### 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.
|
|
|
|
```bash
|
|
sudo bash install.sh
|
|
```
|
|
|
|
### Step 4: Verification
|
|
Once the script finishes, verify the installation by running the scanner's help command:
|
|
|
|
```bash
|
|
sudo sniper --help
|
|
```
|
|
If you see the help menu with the logo, the installation was successful!
|
|
|
|
---
|
|
|
|
## 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)
|
|
|
|
1. **Start the container**:
|
|
From within the `Sn1per` directory, run:
|
|
```bash
|
|
sudo docker compose up -d
|
|
```
|
|
*The `-d` flag runs it in the background.*
|
|
|
|
2. **Access the container**:
|
|
To start using the scanner, enter the interactive shell:
|
|
```bash
|
|
sudo docker run --privileged -it sn1per-kali-linux /bin/bash
|
|
```
|
|
|
|
3. **Run the tool**:
|
|
Inside the container, you can run:
|
|
```bash
|
|
sniper --help
|
|
```
|
|
|
|
### Option B: BlackArch Container
|
|
|
|
If you prefer BlackArch Linux:
|
|
|
|
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
|
|
```
|
|
|
|
---
|
|
|
|
## 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
|
|
```
|
|
|
|
### 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`
|
|
|
|
### Docker "Permission Denied"
|
|
If you get permission errors with Docker, ensure your user is in the `docker` group or use `sudo` before docker commands.
|
|
|
|
---
|
|
[Return to README](../README.md)
|