Skip to content

Installation

Jump to bottom
Richard Mwewa edited this page Jul 13, 2023 · 16 revisions

Linux

Install from PyPI

Installing octosuite from PyPI is simple and straight forward.

Simply run the following command:

pip install octosuite

Screenshot 2023-01-23 032211

This will begin the installation.

Build from source

Firstly, clone the repository

git clone https://github.com/bellingcat/octosuite.git

Screenshot 2023-01-23 032722

Then change the working directory to octosuite

cd octosuite

Screenshot 2023-01-23 032955

After that is done, run the following command to build and install octosuite:

pip install .

Docker

  1. Clone the repo
git@github.com:bellingcat/octosuite.git
  1. Build the Docker container image
docker build --tag octosuite .
  1. Run the Docker container
docker run -it octosuite

Windows

  • Download the latest (recommended) zip containing the Windows executable available in release

Once downloaded, extract the zip and find the Octosuite.exe file 2023-01-23_03-40

Then, double click it to launch Octosuite 2023-01-23_03-41

Mac OS

GUI

The GUI is not packaged into .app or .dmg so you will need to have python installed and download a zip file containing the GUI for MacOS from the release page

1. Open a terminal window

on your Mac, do one of the following:

  • Click the Launchpad icon in the Dock, type Terminal in the search field, then click Terminal.
  • In the Finder , open the /Applications/Utilities folder, then double-click Terminal.**

2. Move to the directory that contains the GUI

Screen Shot 2023-01-26 at 9 17 47 PM

3. Install dependencies Use the command pip install -r requirements.txt to install all dependencies Screen Shot 2023-01-26 at 9 20 23 PM

4. Run the GUI To run/start the GUI, you can run the following command python3 octosuite.py

Screen Shot 2023-01-26 at 9 27 22 PM

CLI

1. Open a terminal window

on your Mac, do one of the following:

  • Click the Launchpad icon in the Dock, type Terminal in the search field, then click Terminal.
  • In the Finder , open the /Applications/Utilities folder, then double-click Terminal.

2. Mount the .dmg file

Use the hdiutil command to mount the .dmg file as follows

hdiutil attach /path/to/file.dmg

3. Install the .app file

After mounting the .dmg file, the image will be mounted to /Volumes/. You will be able to see the OctoSuite .app file in the folder. Now run the following command to copy the .app file to the Applications folder

sudo cp -rf "/Volumes/OctoSuite v*.app" /Applications

Note

The * symbol should be replaced with the current version tag

4. Run the .app file

In the Finder , open the /Applications folder, then look for OctoSuite. Once found, right-click the file and select 'Show Package Contents' and navigate to Contents/MacOS, in the MacOs directory you will see a file named OctoSuite, double-click it and OctoSuite should start

Note

The .app file has been tested only on MacOS High Sierra 10.13.6

The .exe file has been tested on Windows 10 and Windows 11

The .app file is still in beta, and might contain some unnoticed bugs. Feel free to open an issue if that's the case.

Clone this wiki locally