-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #97 from sej7278/hidden-radar
Added radar docs without homepage/sidebar update
- Loading branch information
Showing
2 changed files
with
91 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <<EOL | ||
[kernelcare] | ||
name=kernelcare | ||
baseurl=https://repo.cloudlinux.com/kernelcare/\$releasever/\$basearch | ||
enabled=1 | ||
gpgcheck=1 | ||
gpgkey=https://repo.cloudlinux.com/kernelcare/RPM-GPG-KEY-KernelCare | ||
EOL | ||
``` | ||
|
||
For APT-based distributions (Debian, Ubuntu etc): | ||
|
||
```text | ||
curl -s https://repo.cloudlinux.com/kernelcare/kernelcare.gpg -o /usr/share/keyrings/kcare.gpg | ||
source /etc/os-release | ||
if [ "$ID" = "debian" ]; then export VERSION_CODENAME=kcare; fi | ||
printf '%s' \ | ||
"deb [signed-by=/usr/share/keyrings/kcare.gpg] " \ | ||
"https://repo.cloudlinux.com/kernelcare/kernelcare-$ID/$VERSION_ID " \ | ||
"$VERSION_CODENAME main" > /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. | ||
|