-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
180 additions
and
50 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,31 @@ | ||
--- | ||
title: Debian / Ubuntu | ||
linkTitle: Debian | ||
--- | ||
|
||
## Installation | ||
|
||
Stable release installation packages can be found here: | ||
|
||
- [ConSol Software Repository](https://labs.consol.de/repo/stable/) (recommended) | ||
- [Github Releases](https://github.com/ConSol-Monitoring/snclient/releases) | ||
|
||
Add the repository as described on the link itself. | ||
|
||
#> apt install snclient | ||
|
||
![apt install snclient](apt.png "apt install snclient") | ||
|
||
### Firewall | ||
|
||
The firewall should be configured to allow these ports: | ||
|
||
- `8443` : if you enabled the webserver (the default is enabled) | ||
- `5666` : if you enabled the NRPE server (disabled by default) | ||
- `9999` : if you enabled the Prometheus server (disabled by default) | ||
|
||
## Uninstall | ||
|
||
Uninstall is available possible with `apt`. | ||
|
||
#> apt remove snclient |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,33 @@ | ||
--- | ||
title: OSX | ||
linkTitle: OSX | ||
--- | ||
|
||
## Installation | ||
|
||
Stable release installation packages can be found here: | ||
|
||
- [Github Releases](https://github.com/ConSol-Monitoring/snclient/releases) | ||
|
||
Download the .pkg file from the releases page und start it. You might need to | ||
open the system settings allow opening the package since it is not signed. | ||
|
||
![system settings](osx-settings.png "osx system settings") | ||
|
||
This should open the installer: | ||
|
||
![pkg installer](osx-pkg.png "osx pkg installer") | ||
|
||
### Firewall | ||
|
||
The firewall should be configured to allow these ports: | ||
|
||
- `8443` : if you enabled the webserver (the default is enabled) | ||
- `5666` : if you enabled the NRPE server (disabled by default) | ||
- `9999` : if you enabled the Prometheus server (disabled by default) | ||
|
||
## Uninstall | ||
|
||
Uninstall is available possible with the uninstall shell script. | ||
|
||
%> sudo /usr/local/bin/snclient_uninstall.sh |
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,29 @@ | ||
--- | ||
title: Redhat / Rocky / AlmaLinux | ||
linkTitle: RHEL | ||
--- | ||
|
||
## Installation | ||
|
||
Stable release installation packages can be found here: | ||
|
||
- [ConSol Software Repository](https://labs.consol.de/repo/stable/) (recommended) | ||
- [Github Releases](https://github.com/ConSol-Monitoring/snclient/releases) | ||
|
||
Add the repository as described on the link itself. | ||
|
||
#> dnf install snclient | ||
|
||
### Firewall | ||
|
||
The firewall should be configured to allow these ports: | ||
|
||
- `8443` : if you enabled the webserver (the default is enabled) | ||
- `5666` : if you enabled the NRPE server (disabled by default) | ||
- `9999` : if you enabled the Prometheus server (disabled by default) | ||
|
||
## Uninstall | ||
|
||
Uninstall is available possible with `dnf`. | ||
|
||
#> dnf remove snclient |
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,71 @@ | ||
--- | ||
title: Windows | ||
linkTitle: Windows | ||
--- | ||
|
||
## Installation | ||
|
||
Stable release installation packages can be found here: | ||
|
||
- [SNClient Releases Page](https://github.com/ConSol-Monitoring/snclient/releases) | ||
|
||
You might need to expand the assets to find the download links. | ||
![Assets](download.png "Expand Assets") | ||
|
||
Then start the .msi installer and follow the instructions. | ||
|
||
![MSI Installer](msi.png "MSI Installer") | ||
|
||
### Firewall | ||
|
||
The windows .msi package will add the firewall exceptions automatically. in | ||
case you need to re-install the firewall exception, you can run this command: | ||
|
||
C:\Program Files\snclient> .\snclient.exe install firewall | ||
|
||
If you don't need the exceptions anymore, there is an uninstall command as well: | ||
|
||
C:\Program Files\snclient> .\snclient.exe uninstall firewall | ||
|
||
### MSI Installation Parameters | ||
|
||
Running the .msi installer manually lets you choose some basic options. The idea | ||
here is to set the ports, so the following firewall setup will know which ports | ||
to open. | ||
|
||
All none basic options should go into a local custom ini file which can be | ||
provided during installation as well. | ||
|
||
Installing the msi from the terminal with `msiexec.exe` provides those options | ||
as public property. | ||
|
||
ex.: | ||
|
||
msiexec.exe /i snclient.msi /l*V snclient_installer.log /qn PASSWORD="test" INCLUDES="https://company.local/snclient_local.ini" | ||
|
||
Installs the .msi and logs everything into the snclient_installer.log logfile. It | ||
also sets the initial password and includes a ini file fetched by https. | ||
|
||
Here is a table of all available properties: | ||
|
||
| Property | Default Value | Description | | ||
| -------------------- | ----------------- | ----------- | | ||
| INCLUDES | | Adds include files to the /Includes section. | | ||
| ALLOWEDHOSTS | 127.0.0.1, ::1 | Sets the 'allowed hosts'. | | ||
| PASSWORD | CHANGEME | Sets the password (will be written to the .ini encrytped). | | ||
| WEBSERVER | 1 | Enable/Disable the REST web server. | | ||
| WEBSERVERPORT | 8443 | Set port for web server. | | ||
| WEBSERVERSSL | 1 | Enable/Disable TLS/SSL for the web server. | | ||
| NRPESERVER | 0 | Enable/Disable the NRPE server. | | ||
| NRPESERVERPORT | 5666 | Set port for NRPE server. | | ||
| NRPESERVERSSL | 1 | Enable/Disable TLS/SSL for the NRPE server. | | ||
| PROMETHEUSSERVER | 0 | Enable/Disable the Prometheus web server. | | ||
| PROMETHEUSSERVERPORT | 9999 | Set port for prometheus web server. | | ||
| PROMETHEUSSERVERSSL | 0 | Enable/Disable TLS/SSL for the Prometheus web server. | | ||
|
||
## Uninstall | ||
|
||
Uninstall is available either by starting the `snclient.msi installer` again. If the installer has the same version as the | ||
installed one, it will offer a uninstall` option. | ||
|
||
Another way is to use the `windows software center` and uninstall the agent from there. |