Installation

... or how to install secator and it's dependencies on different platforms.

---

Installing secator

Pipx

pipx install secator

Pip

pip install secator

Bash

wget -O - https://raw.githubusercontent.com/freelabz/secator/main/scripts/install.sh | sh

Docker

docker run -it --rm --net=host -v ~/.secator:/root/.secator freelabz/secator --help

The volume mount -v is necessary to save all secator reports to your host machine, and--net=host is recommended to grant full access to the host network.

You can alias this command to run it easier:

alias secator="docker run -it --rm --net=host -v ~/.secator:/root/.secator freelabz/secator"

Now you can run secator like if it was installed on baremetal:

secator --help

Docker Compose

git clone https://github.com/freelabz/secator
cd secator
docker-compose up -d
docker-compose exec secator secator --help

If you chose the Bash, Docker, or Docker Compose installation methods, you can jump straight to CLI Usage.

---

Installing languages (optional)

secator uses external tools, so you might need to install languages used by those tools assuming they are not already installed on your system.

We provide a subcommand to install required languages if you don't manage them externally:

secator install langs go   # install Go
secator install langs ruby # install Ruby

---

Installing tools (optional)

secator can install tools automatically at runtime (provided security.auto_install_commands is enabled, which is the default), but you can also do it manually.

We provide a subcommand to install or update each supported tool which should work on all systems supporting apt:

secator install tools httpx  # install httpx
secator install tools        # install all supported tools

---

Installing addons (optional)

secator comes installed with the minimum amount of dependencies.

We provide a subcommand to install additional addons which are required for various features:

worker

Add support for Celery (see Distributed runs with Celery).

secator install addons worker

google

Add support for Google Drive exporter (see Exporters).

secator install addons google

mongodb

Add support for MongoDB driver (see MongoDB driver).

secator install addons mongodb

redis

Add support for Celery Redis broker / backend.

secator install addons redis

dev

Add development tools like coverage and flake8 required for running tests.

secator install addons dev

trace

Add tracing tools like memray and pyinstrument required for tracing functions.

secator install addons trace

---

Checking installation health

To figure out which languages or tools are installed on your system (along with their version):

secator health

Secator Health CLI Output

---