From c2f4a697927536a035e1797efd4b949528506f41 Mon Sep 17 00:00:00 2001 From: Simon John Date: Thu, 3 Oct 2024 10:02:31 +0100 Subject: [PATCH] Added radar docs without homepage/sidebar update Added RSS feed for ESU --- .../README.md | 5 ++ docs/radar/README.md | 86 +++++++++++++++++++ 2 files changed, 91 insertions(+) create mode 100644 docs/radar/README.md diff --git a/docs/enterprise-support-for-almalinux/README.md b/docs/enterprise-support-for-almalinux/README.md index 6b06d414..96165241 100644 --- a/docs/enterprise-support-for-almalinux/README.md +++ b/docs/enterprise-support-for-almalinux/README.md @@ -63,6 +63,11 @@ Leveraging Open Vulnerability and Assessment Language (OVAL) patch definitions w * AlmaLinux 9.2 FIPS: [https://repo.tuxcare.com/tuxcare/9.2/almalinux9.2-fips-oval.xml](https://repo.tuxcare.com/tuxcare/9.2/almalinux9.2-fips-oval.xml) * AlmaLinux 9.2 ESU: [https://repo.tuxcare.com/tuxcare/9.2/almalinux9.2-esu-oval.xml](https://repo.tuxcare.com/tuxcare/9.2/almalinux9.2-esu-oval.xml) +### RSS releases feeds + +* AlmaLinux 9.2 FIPS: [https://cve.tuxcare.com/rss_feed/releases/almalinux9.2fips](https://cve.tuxcare.com/rss_feed/releases/almalinux9.2fips) +* AlmaLinux 9.2 ESU: [https://cve.tuxcare.com/rss_feed/releases/almalinux9.2esu](https://cve.tuxcare.com/rss_feed/releases/almalinux9.2esu) + ### Technical support All TuxCare products include technical support provided according to the support policy [https://tuxcare.com/TuxCare-support-policy.pdf](https://tuxcare.com/TuxCare-support-policy.pdf). It delivers 24/7/365 access to our engineers through the TuxCare Support Portal [https://tuxcare.com/support-portal/](https://tuxcare.com/support-portal/) and to our online knowledge base. diff --git a/docs/radar/README.md b/docs/radar/README.md new file mode 100644 index 00000000..31c653dd --- /dev/null +++ b/docs/radar/README.md @@ -0,0 +1,86 @@ +# TuxCare Radar + +This guide describes [TuxCare Radar](https://tuxcare.com/radar/) and how to install and use it. + +## What is TuxCare Radar? + +TuxCare Radar is an intelligent vulnerability scanner for Linux systems, fully integrated with TuxCare's live patching and ELS technologies. It swiftly uncovers vulnerabilities and ensures their effective prioritization using a unique algorithm that assesses the risk to your company based on a comprehensive set of risk factors. + +## Installation + +If you are not already a KernelCare or ePortal user, you will first need to install our repository configuration: + +RPM-based distributions (AlmaLinux, RHEL etc): + +```text +cat > /etc/yum.repos.d/kernelcare.repo < /etc/apt/sources.list.d/kcare.list +``` + +If you are already a KernelCare user or have followed the above repo instructions, you should be able to install Radar as simply as running one of the following: + +RPM-based distributions (AlmaLinux, RHEL etc): + +```text +yum install tuxcare-radar +``` + +For APT-based distributions (Debian, Ubuntu etc): + +```text +apt-get install tuxcare-radar +``` + +## Configuration + +You should have received your initial API key (something like `bc061b2b-c330-49f6-8953-849637d593ac`) along with your password. + +You will need to edit /etc/tuxcare-radar/radar.yaml on each server you wish to scan using Radar and insert your API key. In most instances we would recommend doing this via a centralised config-management tool such as Ansible or Puppet, but you could of course use `vim` or `sed` on the server itself, for example: + +```text +sed -i 's/apikey:.*/apikey: bc061b2b-c330-49f6-8953-849637d593ac/' /etc/tuxcare-radar/radar.yaml +``` + +By default the file will look like this, where `FILLME` should be replaced with your API key: + +```text +base-url: https://radar.tuxcare.com +logfile: /var/log/tuxcare-radar/radar.log +statefile: /var/cache/tuxcare-radar/radar.json +time-between-runs: 23h +apikey: FILLME +``` + +## Usage + +The installer should have created an /etc/cron.d/tuxcare-radar file that will run every 4th hour, it will check if a scan has been run in the last 23 hours (`time-between-runs` in radar.yaml) and if not, it will run a scan. + +If you need to manually run a scan instantly for any reason, you can run: + +```text +su -s /bin/bash nobody -c "tuxcare-radar --config /etc/tuxcare-radar/radar.yaml" +``` + +Then visit [https://radar.tuxcare.com](https://radar.tuxcare.com/) to view the results. +