SysReptor
Self-Hosted
System Requirements

Server ​

Self-Hosted
  • Ubuntu
  • 8GB RAM

Even though we officially support Ubuntu only, installation is technically possible on most UNIX-based target systems including Kali, Fedora, macOS or RHEL. Follow the manual installation steps and adapt the commands to your system. If all dependencies are installed, easy script installation might also work.
On Windows, use WSL 2 with an Ubuntu distribution.

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 docker  # 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.

Optional: Verify docker images
shell
SYSREPTOR_VERSION=$(cat sysreptor/deploy/.env | grep 'SYSREPTOR_VERSION=' | cut -d'=' -f2-)
# SYSREPTOR_VERSION=$(docker exec -it sysreptor-app bash -c 'echo "$VERSION"')

# Verify setup.tar.gz
curl -s -L --output sysreptor.tar.gz.sigstore.json https://github.com/syslifters/sysreptor/releases/${SYSREPTOR_VERSION}/download/setup.tar.gz.sigstore.json
cosign verify-blob sysreptor.tar.gz --key https://docs.sysreptor.com/cosign.pub --bundle sysreptor.tar.gz.sigstore.json

# Verify docker images
cosign verify --key https://docs.sysreptor.com/cosign.pub "syslifters/sysreptor:${SYSREPTOR_VERSION}"
cosign verify --key https://docs.sysreptor.com/cosign.pub "syslifters/sysreptor-languagetool:${SYSREPTOR_VERSION}"  # Pro only

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.