Installation

Fedora 35 and later

sudo dnf install openscap-report

Enterprise Linux (EPEL)

Warning

Some Enterprise Linux needs to enable Extra Packages for Enterprise Linux (EPEL). Learn how to enable EPEL in EPEL documentation.

RHEL 9

Note

Extra packages must be enabled

sudo dnf install openscap-report

CentOS Stream 9

Note

Extra packages must be enabled

sudo dnf install openscap-report

AlmaLinux 9, Rocky Linux 9

Note

Extra packages must be enabled

sudo dnf install openscap-report

Via PyPi

# If you want to install openscap-report to $HOME/.local/bin, you have to run the below command:
pip3 install --user openscap-report

# If you want to install openscap-report globally instead, you have to run the below commands as admin, e.g. on Linux:
sudo pip3 install openscap-report

Installation from source

Requirements:

# Get repository with code
git clone https://github.com/OpenSCAP/openscap-report.git
cd openscap-report

# Install
sudo pip3 install .

# Alternatively, you can use this command to install the project in editable mode for developer use.
sudo pip3 install -e .

Build documentations

Install requirements

sudo dnf install python3-sphinx python3-sphinx_rtd_theme

Build man page

cd ./docs
sphinx-build -b man . TARGET_DIR

Build this HTML docs

Note

The files in the “modules” directory were generated using the sphinx-apidoc openscap_report docs/modules command.

cd ./docs
sphinx-build . TARGET_DIR