Skip to content

Commit

Permalink
added documentation for settings in Install Actions
Browse files Browse the repository at this point in the history
  • Loading branch information
CJ Virtucio authored and phatboyg committed Sep 19, 2018
1 parent 6d7ddf2 commit bb40040
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/source/configuration/config_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ Runs the service using the local service account.
Custom Install Actions
======================

These settings allow user-specified code to be executed during the service install/uninstall process.
These actions allow user-specified code to be executed during the service install/uninstall process. Each install action takes a *settings* parameter of type Topshelf.HostSettings, providing you with an API to service-related properties such as the *InstanceName*, *ServiceName*, etc.

Before Install Actions
----------------------
Expand All @@ -268,7 +268,7 @@ Topshelf allows actions to be specified that are executed before the service is

HostFactory.New(x =>
{
x.BeforeInstall(() => { ... });
x.BeforeInstall(settings => { ... });
});


Expand All @@ -281,7 +281,7 @@ Topshelf allows actions to be specified that are executed after the service is i

HostFactory.New(x =>
{
x.AfterInstall(() => { ... });
x.AfterInstall(settings => { ... });
});

Before Uninstall Actions
Expand Down

0 comments on commit bb40040

Please sign in to comment.