Skip to content

Commit

Permalink
Updates README
Browse files Browse the repository at this point in the history
  • Loading branch information
wwtreese committed Nov 20, 2016
1 parent 73b97ff commit d51c724
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,19 @@

## Overview

This module is a couple of defined types to install a service, and set the parameters for that service. This will obviously require NSSM to be installed
This module contains a couple of defined types:
- `nssm::install` install a service
- `nssm::set` set the parameters for that service

#### Installing NSSM

This will obviously require NSSM to be installed. If you need to install nssm, you may optionally declare the nssm class:

`include nssm`

Note, however, that the `nssm` class is simply declaring the [windows::nssm](https://forge.puppet.com/counsyl/windows#windowsnssm) class, which already does an excellent job of downloading and installing nssm, so understand `counsyl/windows` as a dependency to using my `nssm` class.

If you already have nssm installed, a default path to the nssm exe is assumed as `C:\Program Files\nssm-2.24\win64`. This may be overridden if your PATH differs by supplying `nssm_path` as an attribute to the `nssm:install` and `nssm::set` defined types.

## Module Description

Expand Down

0 comments on commit d51c724

Please sign in to comment.