Skip to content
Self-Hosted
System Requirements

Server

Self-Hosted
  • Ubuntu[1]
  • 8GB RAM

Client

Cloud · Self-Hosted
  • Network connection to the server
  • Up-to-date desktop browser, one of:
    • Chrome
    • Edge
    • Firefox
    • Safari

Installation via script is the easiest option.

Install additonal requirements:

shell
sudo apt update
sudo apt install -y sed curl openssl uuid-runtime coreutils

Install Docker:

shell
curl -fsSL https://get.docker.com | sudo bash

Make sure your user is allowed to use Docker. For this, you can add your user to the docker group:

shell
sudo groupadd docker 2>/dev/null  # Creates the Docker group if it doesn't exist
sudo usermod -aG docker $USER  # Add the current user to the Docker group
newgrp -  # Instantly apply the group membership

Download the SysReptor install script and run:

shell
bash <(curl -s https://docs.sysreptor.com/install.sh)

The installation script creates a new sysreptor directory holding the source code and everything you need.
It will set up all configurations, create volumes and secrets, download images from Docker hub and bring up your containers.

Access your application at http://127.0.0.1:8000/.

We recommend using a webserver like Caddy (recommended), nginx or Apache to prevent potential vulnerabilities and to enable HTTPS.

Further configurations can be edited in sysreptor/deploy/app.env.

Stopping SysReptor

To stop SysReptor and all associated containers, go to the sysreptor/deploy directory and run docker compose stop.

Further questions?

Need help or have questions? Get support and connect with us and the SysReptor community.

Get help


  1. It may also run on Kali, MacOS, RHEL, and more as long as you take care of all dependencies. Our install and update procedures, however, focus on Ubuntu. ↩︎