Installation Guide

This guide will help you set up and run the IoTSploit project on your local machine. Follow these steps to get started.

Prerequisites

Before beginning the installation, ensure your system meets the following requirements:

git fetch
git checkout -b dev origin/dev

Ensure Docker is installed, then run the following commands:

docker pull redis
docker run --name sat-redis -p 6379:6379 -d redis:latest

We use Poetry for dependency management. Follow these steps to install and configure:

pip install poetry
poetry lock        # This may take 10-20 minutes
poetry install     # This may take 10-20 minutes
poetry shell

Note

The Poetry lock and install processes might take some time. Please be patient.

Run the following commands to set up the database:

python manage.py makemigrations
python manage.py makemigrations sat_toolkit
python manage.py migrate

Launch the application using:

python console.py

After installation, verify that everything is working correctly:

Ensure Redis service is running:
```
docker ps | grep redis
```
Check if IoTSploit Shell is working:
- Run python console.py
- Type help in the shell to see available commands
- Try running the device_info command

If you encounter problems during installation, here are solutions to common issues:

If Poetry installation fails, try upgrading Poetry using pip:
```
pip install --upgrade poetry
```

If you can’t connect to Redis, check if the Docker container is running:
```
docker ps | grep redis
```
If the container isn’t running, restart it:
```
docker start sat-redis
```

If you encounter database migration errors, try resetting migrations:

python manage.py migrate --fake
python manage.py migrate --fake-initial

After completing the installation, you can: