Installers

Component: NServiceBus
NuGet Package NServiceBus (6.x)

Installers ensure that endpoint-specific artifacts (e.g. database tables, queues, directories, etc.) are created and configured when the endpoint is started.

When to run installers

Installers require permissions to administer resources such as database tables, queues, or directories. Following the principle of least privilege, it is recommended to run an endpoint with these elevated permissions only during initial deployment.

For example, an endpoint can be started manually as an administrator or elevated user to allow installers to run. The required resources will be ready as soon as the endpoint has successfully started. The endpoint can then be shut down and installed as a service, which can run as a regular user that does not have permission to modify resources.

The alternative to using installers is to create the required resources before the endpoint is run. The method of doing this varies for each transport or persistence package. For more information, see operations.

Running installers

By default, installers are only run when the application starts with a debugger attached. This includes applications being debugged remotely.

Installers can be enabled to always run at startup:

endpointConfiguration.EnableInstallers();

// this will run the installers
await Endpoint.Start(endpointConfiguration)
    .ConfigureAwait(false);

Installers may need to be run depending on the arguments that are provided to the host or aspects the environment the endpoint is hosted in.

For example, installers can be enabled based on command line arguments:

public static void Main(string[] args)
{
    var runInstallers = args.Any(x => x.ToLower() == "/runInstallers");

    if (runInstallers)
    {
        endpointConfiguration.EnableInstallers();
    }
}

They can also be enabled by a machine name convention:

if (!Environment.MachineName.EndsWith("-PROD"))
{
    endpointConfiguration.EnableInstallers();
}

Starting with NServiceBus Version 6.4, installers can be disabled to never run at startup:

endpointConfiguration.DisableInstallers();

// this will not run the installers
await Endpoint.Start(endpointConfiguration)
    .ConfigureAwait(false);

Custom installers

Implement the INeedToInstallSomething interface to create a custom installer:

public class MyInstaller :
    INeedToInstallSomething
{
    public Task Install(string identity)
    {
        // Code to install something

        return Task.CompletedTask;
    }
}

Assemblies in the runtime directory are scanned for installers so no code is needed to register them.

Related Articles


Last modified