upstream/icinga-powershell-framework
1
0
Fork 0
mirror of https://github.com/Icinga/icinga-powershell-framework.git synced 2025-12-20 23:00:35 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updates docs to refer to the service installation guide

Browse source
This commit is contained in:
Lord Hepipud 2020-04-29 13:54:50 +02:00
parent c0e006640a
commit 3809806472
1 changed files with 2 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
doc/service/01-Install-Service.md
View file

@ -11,36 +11,12 @@ In order to make this work, you will require the Icinga Windows Service which ca
Benefits
---
Running the PowerShell Framework as background service will add the possibility to register certain functions which are executed depending on their configuration / coding. One example would be to frequently collect monitoring metrics from the installed plugins, allowing you to receice an average of time for the CPU load for example.
Running the PowerShell Framework as background service will add the possibility to register certain functions which are executed depending on their configuration / coding. One example would be to frequently collect monitoring metrics from the installed plugins, allowing you to receive an average of time for the CPU load for example.
Install the Service
---
At first you will require the Service Binary from the [Icinga Windows Service GitHub Repository](https://github.com/Icinga/icinga-powershell-service) and copy the binary locally to your system. A recommended path would be your Program Files / Program Files (x86) directory.
Any other custom location is fully supported, has to be however accessible from the Windows Service Environment.
Once you have found a location, the PowerShell Module will assist you with setting up the service itself. In this documentation we will assume the path you have chosen to copy the binary to is
```powershell
C:\Program Files\Icinga-Framework-Service
```
and the binary name is
```powershell
icinga-service.exe
```
Now lets install the service with the help of the PowerShell Module:
```powershell
Install-IcingaFrameworkService -Path 'C:\Program Files\Icinga-Framework-Service\icinga-service.exe'
```
You can validate if the service has been installed properly by using the Get Service Cmdlet:
Each enabled background daemon component is afterwards being started and executed.
A detailed documentation on how to download and install the service and be found directly on the services [installation guide](https://icinga.com/docs/windows/latest/service/doc/02-Installation/).
Register Functions
---