Skip to content

Installation

Jump to bottom
INFINIT3I edited this page Feb 23, 2025 · 3 revisions

🛠️ Installation Guide for Hunt-AI

Welcome to the Hunt-AI installation guide! Follow these steps to set up Hunt-AI on your local machine and start threat hunting efficiently.

Prerequisites

Before installing Hunt-AI, make sure you meet the following system requirements:

  • 🖥️ PC with at least 8 GB RAM
  • ⚙️ Docker Compose v2 – To run the project with Docker and configure services.
  • 📦 Docker – Ensure you have Docker installed for containerization.
  • 🐍 Python 3.x – Make sure Python is installed for running tests and custom scripts.

Installation Steps

Follow these steps to set up Hunt-AI:

1️⃣ Clone the Repository

You can start by cloning the repository to your local machine. Open a terminal and run:

git clone https://github.com/Infinit3i/hunt-ai.git
cd hunt-ai

Alternatively, you can [download the ZIP](https://github.com/Infinit3i/hunt-ai/archive/refs/heads/main.zip) from the GitHub page and extract it to your desired location.

2️⃣ Build the Docker Image

Once you're in the hunt-ai directory, build the Docker image. This will set up all the required containers and services for Hunt-AI.

docker build -t hunt-ai .

3️⃣ Run the Docker Container

Now that you've built the image, run the container with:

docker run -d -p 31337:31337 hunt-ai

This command will run Hunt-AI in the background, listening on port 31337.

4️⃣ Access the Web Interface

To access Hunt-AI's web interface, open a browser and visit:

http://localhost:31337

If you're on a Linux-based system, you may need to open it with a browser command:

sleep 2 && google-chrome http://localhost:31337 &

Testing the Setup

To ensure everything is working properly, you can run tests to verify the installation. In the hunt-ai folder, run:

python -m unittest discover Testing

This will run all tests in the Testing folder to confirm that everything is set up correctly.

Using Hunt-AI

Once you have the environment up and running, you can begin using Hunt-AI to investigate and track threats. Refer to the [Usage Guide](Usage) for detailed steps on how to interact with the system and perform threat hunting operations.

Troubleshooting

If you run into issues, here are some common troubleshooting steps:

  • Docker Build Issues: Ensure Docker and Docker Compose are correctly installed and running. Verify by running docker --version and docker-compose --version.

  • Port Binding Issues: If port 31337 is already in use, modify the Docker run command to use a different port:

    docker run -d -p 8080:31337 hunt-ai

Contributing

Want to contribute to Hunt-AI? Check out our [Contributing Guide](Contributing) to get started!

Clone this wiki locally