Update local hostname variable to $LOCAL_HOSTNAME in docs/config exam…

…ples
rechecked · Feb 4, 2024 · a7e7bcb · a7e7bcb
1 parent 176d804
commit a7e7bcb
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 22 deletions.
diff --git a/build/package/config.yml b/build/package/config.yml
@@ -55,17 +55,17 @@ pluginTypes:
 #    type: nrdp
 
 # Passive check configuration
-# $HOST is alias for the hostname of the server,
+# $LOCAL_HOSTNAME is alias for the hostname of the server,
 # since this may change, you may want to hardcode it
 
 #checks:
-#  - hostname: $HOST
+#  - hostname: $LOCAL_HOSTNAME
 #    interval: 5m
 #    endpoint: system/version
 #    options:
 #      warning: 10
 #      critical: 20
-#  - hostname: $HOST
+#  - hostname: $LOCAL_HOSTNAME
 #    servicename: CPU Usage
 #    interval: 30s
 #    endpoint: cpu/percent

diff --git a/docs/checks/passive-checks.md b/docs/checks/passive-checks.md
@@ -36,11 +36,11 @@ Each check can be set with a pecific `interval` time, which is per check. There
 
 ### Example Host Check
 
-The variable `$HOST` will be replaced with the hostname of the rcagent system
+The variable `$LOCAL_HOSTNAME` will be replaced with the hostname of the rcagent system
 
 ```
 checks:
-  - hostname: $HOST
+  - hostname: $LOCAL_HOSTNAME
     interval: 5m
     endpoint: system/version
     options:
@@ -54,7 +54,7 @@ Example of service checks, including running a plugin as a passive service check
 
 ```
 checks:
-  - hostname: $HOST
+  - hostname: $LOCAL_HOSTNAME
     servicename: Custom Plugin
     interval: 5m
     endpoint: plugins
@@ -63,21 +63,21 @@ checks:
       args:
         - -m "hello and test!"
         - --dir /test/dir
-  - hostname: $HOST
+  - hostname: $LOCAL_HOSTNAME
     servicename: CPU Usage
     interval: 30s
     endpoint: cpu/percent
     options:
       warning: 10
       critical: 20
-  - hostname: $HOST
+  - hostname: $LOCAL_HOSTNAME
     servicename: Memory Usage
     interval: 5m
     endpoint: memory/virtual
     options:
       warning: 80
       critical: 90
-  - hostname: $HOST
+  - hostname: $LOCAL_HOSTNAME
     servicename: Disk Usage - C:
     interval: 1h
     endpoint: disk

diff --git a/docs/config/checks.md b/docs/config/checks.md
@@ -6,7 +6,7 @@ In the YAML file, `checks` is a list of checks to run. You can have as many pass
 
 ## Special Values
 
-### `$HOST`
+### `$LOCAL_HOSTNAME`
 
 This value is populated with the hostname of the system the rcagent is running on.
 
@@ -38,13 +38,13 @@ You can pass all the normal URL-style parameters in the options, such as warning
 
 ```
 checks:
-  - hostname: $HOST
+  - hostname: $LOCAL_HOSTNAME
     interval: 5m
     endpoint: system/version
     options:
       warning: 10
       critical: 20
-  - hostname: $HOST
+  - hostname: $LOCAL_HOSTNAME
     servicename: CPU Usage
     interval: 30s
     endpoint: cpu/percent

diff --git a/docs/config/options.md b/docs/config/options.md
@@ -262,13 +262,13 @@ senders:
     type: nrdp
 
 checks:
-  - hostname: $HOST
+  - hostname: $LOCAL_HOSTNAME
     interval: 5m
     endpoint: system/version
     options:
       warning: 10
       critical: 20
-  - hostname: $HOST
+  - hostname: $LOCAL_HOSTNAME
     servicename: CPU Usage
     interval: 30s
     endpoint: cpu/percent

diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md
@@ -126,13 +126,13 @@ Next, set up the passive checks you wish to send, in this example we will send a
 
 ```
 checks:
-  - hostname: $HOST
+  - hostname: $LOCAL_HOSTNAME
 	interval: 5m
 	endpoint: cpu/percent
 	options:
 	  warning: 10
 	  critical: 20
-  - hostname: $HOST
+  - hostname: $LOCAL_HOSTNAME
 	servicename: CPU Usage
 	interval: 30s
 	endpoint: cpu/percent
@@ -141,6 +141,6 @@ checks:
 	  critical: 20
 ```
 
-The $HOST variable is the hostname of the system the rcagent is running on and gets populated during runtime. The options section allows you to pass parameters just like the URL for active checks via the status API. This is why we pass warning/critical values in this way.
+The $LOCAL_HOSTNAME variable is the hostname of the system the rcagent is running on and gets populated during runtime. The options section allows you to pass parameters just like the URL for active checks via the status API. This is why we pass warning/critical values in this way.
 
 For a [full list of options](../../config/options) for [checks](../../config/checks) and [senders](../../config/options#senders) check the config file reference section.
diff --git a/docs/status-api/system.md b/docs/status-api/system.md
@@ -145,7 +145,7 @@ Parameter | Default | Description
 
 	```
 	{
-		"version": "1.0.4"
+		"version": "1.1.0"
 	}
 	```
 
@@ -154,7 +154,7 @@ Parameter | Default | Description
 	```
 	{
 		"exitcode": 0,
-		"output": "OK - rcagent version is 1.0.4",
+		"output": "OK - rcagent version is 1.1.0",
 		"perfdata": "",
 		"longoutput": ""
 	}
@@ -163,5 +163,5 @@ Parameter | Default | Description
 === "Plugin"
 
 	```
-	OK - rcagent version is 1.0.4
+	OK - rcagent version is 1.1.0
 	```
diff --git a/versioninfo.json b/versioninfo.json
@@ -22,14 +22,14 @@
         "Comments": "",
         "CompanyName": "ReChecked",
         "FileDescription": "ReChecked system status and monitoring agent.",
-        "FileVersion": "v1.0.4.0",
+        "FileVersion": "v1.1.0.0",
         "InternalName": "rcagent.exe",
         "LegalCopyright": "(c) 2023 ReChecked",
         "LegalTrademarks": "",
         "OriginalFilename": "",
         "PrivateBuild": "",
         "ProductName": "ReChecked Agent",
-        "ProductVersion": "v1.0.4.0",
+        "ProductVersion": "v1.1.0.0",
         "SpecialBuild": ""
     },
     "VarFileInfo": {