You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/radar/README.md
+17-1Lines changed: 17 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,6 +52,10 @@ apt-get update
52
52
apt-get install tuxcare-radar
53
53
```
54
54
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
+
55
59
## Configuration
56
60
57
61
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
73
77
apikey: FILLME
74
78
```
75
79
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
+
76
86
## Tagging
77
87
78
88
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.
85
95
86
96
## Firewall and Proxy Settings
87
97
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.
89
99
90
100
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:
91
101
@@ -146,4 +156,10 @@ If you need to manually run a scan instantly for any reason, you can run:
146
156
su -s /bin/bash nobody -c "tuxcare-radar --config /etc/tuxcare-radar/radar.yaml"
147
157
```
148
158
159
+
If you would like to run a CIS benchmark compliance scan, you can run the following as root:
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