Local installation
This guide explains how to install and run Pithus in a local environment using Docker Compose. This documentation is mostly aimed at developers.
A local installation is useful to avoid sharing the application you want to analyse, but you will not benefit on the large database of already published samples that are available on our public instance.
If you intend to operate a publicly accessible instance, refer to the Deployment guide instead.
Downloading Pithus
Section titled “Downloading Pithus”Clone the official Pithus repository:
git clone https://github.com/Pithus/bazaar.gitNavigate to the project directory:
cd bazaarThe repository contains the application source code, Dockerfiles, configuration files and Docker Compose definitions required to run Pithus.
Building the application
Section titled “Building the application”Pithus provides a Docker Compose configuration for local development named local.yml.
Build the Docker images using:
docker compose -f local.yml buildThe initial build may take some time depending on your internet connection and available system resources.
Starting Pithus
Section titled “Starting Pithus”Once the images have been built, start the application:
docker compose -f local.yml upAlternatively, you can run the services in the background:
docker compose -f local.yml up -dand monitor the logs with:
docker compose -f local.yml logs -fThe application takes a little time to start, be patient. The django and worker services are the last ones to start.
Accessing your local instance
Section titled “Accessing your local instance”Once the services have all started, open your browser and navigate to:
Creating an administrator account
Section titled “Creating an administrator account”If you need access to the Django administration interface, you can create a superuser account.
Run:
docker compose -f local.yml run --rm django python manage.py createsuperuserFollow the interactive prompts to configure the account.
Once the account has been created, access the administration interface at: http://localhost:8001/admin
