> For the complete documentation index, see [llms.txt](https://blog.syselement.com/home/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://blog.syselement.com/home/operating-systems/linux/tools/sysreptor.md).

# SysReptor

> 🔗 [SysReptor Pentest Report Creator](https://docs.sysreptor.com/)
>
> 🔗 Local install: <http://127.0.0.1:8000/>

## Install SysReptor

```bash
sudo apt update
sudo apt install sed curl openssl uuid-runtime coreutils

# Community
cd ~/tools
curl -s https://docs.sysreptor.com/install.sh | bash

# The installation script creates a new sysreptor directory holding the source code and everything you need. It will build a docker image, create volumes and secrets and bring up your containers.
```

## Update SysReptor

```bash
# Update
bash ~/tools/sysreptor/update.sh
```

```bash
# Restart
cd ~/tools/sysreptor/deploy
docker compose -f docker-compose.yml up -d
```

## Configure

```bash
# HTB Designs/Templates
cd ~/tools/sysreptor/deploy
url="https://docs.sysreptor.com/assets/htb-designs.tar.gz"
curl -s "$url" | docker compose exec --no-TTY app python3 manage.py importdemodata --type=design
```

> ➡️ Check the official [documentation](https://docs.sysreptor.com/setup/configuration/) for further configuration and usage.

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://blog.syselement.com/home/operating-systems/linux/tools/sysreptor.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.