Skip to content

Commit 95f418a

Browse files
authored
Merge pull request #227 from sej7278/radar-cis
Added securescan instructions
2 parents 5b29a82 + 80cd6ec commit 95f418a

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

docs/radar/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ apt-get update
5252
apt-get install tuxcare-radar
5353
```
5454

55+
:::warning
56+
If you do an in-place upgrade of your APT-based OS, you should change the version number in `/etc/apt/sources.list.d/tuxcare-radar.list` beforehand.
57+
:::
58+
5559
## Configuration
5660

5761
You should have received your initial API key (something like `bc061b2b-c330-49f6-8953-849637d593ac`) along with your password.
@@ -73,6 +77,12 @@ enabled: true
7377
apikey: FILLME
7478
```
7579

80+
If you are registered to the EU instance instead of the default US one, you should also change the `base-url` like so:
81+
82+
```text
83+
base-url: https://eu.radar.tuxcare.com
84+
```
85+
7686
## Tagging
7787

7888
Tags are a powerful feature that let you easily identify and filter hosts based on tags. You can create tags to describe your environment, for example `prod`, `dev`, `staging` or the TuxCare products such as `esu`, `esa`, `kce`, or maybe location, such as `eu`, `us`, `apac`. To use tags, simply add them to /etc/tuxcare-radar/radar.yaml like so:
@@ -85,7 +95,7 @@ The next time a scan is run, the tags will appear in the asset overview.
8595

8696
## Firewall and Proxy Settings
8797

88-
TuxCare Radar requires outbound connectivity on tcp/443 (TLS) to `radar.tuxcare.com` which by default is in the US. If you need your own private instance, or can only use a certain geographical location, please discuss with your Account Manager. IPv6 or IPv4 can be used. No inbound connectivity is required, tuxcare-radar does not open any listening ports.
98+
TuxCare Radar requires outbound connectivity on tcp/443 (TLS) to `radar.tuxcare.com` (default US instance) or `eu.radar.tuxcare.com` (EU instance). IPv6 or IPv4 can be used. No inbound connectivity is required, tuxcare-radar does not open any listening ports.
8999

90100
To use via a proxy, set the `https_proxy` environment variable based on your infrastructure. For running the service from cron, you can use this:
91101

@@ -146,4 +156,10 @@ If you need to manually run a scan instantly for any reason, you can run:
146156
su -s /bin/bash nobody -c "tuxcare-radar --config /etc/tuxcare-radar/radar.yaml"
147157
```
148158

159+
If you would like to run a CIS benchmark compliance scan, you can run the following as root:
160+
161+
```text
162+
tuxcare-radar securescan --config /etc/tuxcare-radar/radar.yaml
163+
```
164+
149165
Then visit [https://radar.tuxcare.com](https://radar.tuxcare.com/) (US) or [https://eu.radar.tuxcare.com](https://eu.radar.tuxcare.com/) (EU) to view the results.

0 commit comments

Comments
 (0)