dennisroche/topshelf.owin

Topshelf.Owin provides extensions to configure a self-hosted OWIN instance along with your service class.

Topshelf.Owin

Extend TopShelf to be a self-hosted API using OWIN (Open Web Interface for .NET)

NB: Owin requires .NET 4.5 or later.

How to use

Install the Nuget package.

Install-Package Topshelf.Owin

Then modify your TopShelf service.

using Topshelf;
using TopShelf.Owin;

namespace YourService
{
    internal class Program
    {
        static void Main(string[] args)
        {
            HostFactory.Run(c =>
            {
                c.RunAsNetworkService();
         
                c.Service<YourService>(s =>
                {
                    s.ConstructUsing(() => new YourService());
                    s.WhenStarted((service, control) => service.Start());
                    s.WhenStopped((service, control) => service.Stop());

                    s.OwinEndpoint(app =>
                    {
                        app.Domain = "localhost";
                        app.Port = 8080;
                    });
                });

            });
        }

    }
}

If you want to use with AutoFac, then also add AutoFac.WebApi and TopShelf.AutoFac packages and then set the DependencyResolver.

s.OwinEndpoint(app =>
{
    app.UseDependencyResolver(new AutofacWebApiDependencyResolver(container));
}

By default, it will map routes using attributes on the actions. If you want to change the HttpCongfiguration to change routes or change the JSON serializer, you can:

s.OwinEndpoint(app =>
{
    app.ConfigureHttp(httpConfiguration =>
    {
        httpConfiguration.MapHttpAttributeRoutes();
        httpConfiguration.Formatters.Clear();
        httpConfiguration.Formatters.Add(new JsonMediaTypeFormatter());

        var jsonSettings = httpConfiguration.Formatters.JsonFormatter.SerializerSettings;
        jsonSettings.Formatting = Formatting.Indented;
        jsonSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
    });
});

If you want to bind any OWIN app/middleware other than WebAPI, you can do so by accessing the IAppBuilder instance directly, e.g.:

s.OwinEndpoint(app =>
{
    app.ConfigureAppBuilder(appBuilder => appBuilder.UseNancy());
});

topshelf.owin's Issues

Not compatible with .NET Core 3.1

When adding this package to a Core 3.1 project, you get this message:
Package 'Topshelf.Owin 1.4.39' was restored using '.NETFramework,Version=v4.6.1, .NETFramework,Version=v4.6.2, .NETFramework,Version=v4.7, .NETFramework,Version=v4.7.1, .NETFramework,Version=v4.7.2, .NETFramework,Version=v4.8' instead of the project target framework '.NETCoreApp,Version=v3.1'. This package may not be fully compatible with your project.

How to enable SSL use Topshelf.owin

Using Hangfire

The documentation shows how to use Nancy, But when I try to do the same thing with Hangfire, the application can not start.

                        app.ConfigureAppBuilder(appBuilder =>
                        {
                            GlobalConfiguration.Configuration.UseSQLiteStorage("ConnectionString");
                            appBuilder.UseHangfireServer();
                            appBuilder.UseHangfireDashboard();
                        });

I am trying to figure out how to do this without modifying your library in the meanwhile.

Incorrect Top-Level Namespace

The namespace should be "Topshelf", not "TopShelf" to keep it in line with its parent project. Otherwise works pretty great.

System.Web.Http

Hi,

Following your sample, when I try to run a simple service, I get the following exception on the OwinEndpoint line:

Could not load file or assembly 'System.Web.Http, Version=5.2.2.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35' or one of its dependencies. The system cannot find the file specified.

Which dependency am I missing?

Strong name version?

Any chance of getting a strong name version of this?

Missing Microsoft.Owin.Host.HttpListener dependency

I suggest adding Microsoft.Owin.Host.HttpListener to package.config

Repro:
Adding TopShelf.Owin to a Console application targeting .NET 4.5, setting up HostFactory per ReadMe.md example (adding an explicit .CreateUsing(() => new YourService())) yields the following exception:

Configuration Result:
[Success] Name YourService
[Success] ServiceName YourService
Topshelf v3.1.135.0, .NET Framework v4.0.30319.42000
[Topshelf.Owin] Starting OWIN self-host, listening on: http://localhost:8080/
Topshelf.Hosts.ConsoleRunHost Error: 0 : An exception occurred, System.MissingMe
mberException: The server factory could not be located for the given input: Micr
osoft.Owin.Host.HttpListener
at Microsoft.Owin.Hosting.Engine.HostingEngine.ResolveServerFactory(StartCont
ext context)
at Microsoft.Owin.Hosting.Engine.HostingEngine.Start(StartContext context)
at Microsoft.Owin.Hosting.WebApp.StartImplementation(IServiceProvider service
s, StartOptions options, Action1 startup) at TopShelf.Owin.WebAppConfigurator.Start() at TopShelf.Owin.OwinServiceConfiguratorExtensions.<>c__DisplayClass0_01.b__0(HostStartContext t)
at Topshelf.Runtime.EventCallbackList1.Notify(T data) at Topshelf.Runtime.ServiceEventsImpl.BeforeStart(HostControl hostControl) at Topshelf.Builders.DelegateServiceBuilder1.DelegateServiceHandle.Start(Hos
tControl hostControl)
at Topshelf.Hosts.ConsoleRunHost.Run()
Exiting with code 1.
Press ENTER to exit...

After manually adding Microsoft.Owin.Host.HttpListener to the console application, it ran fine.

Autofac Dependancy Injection not working

I am not able to get Injection up with this project. Controllers are always using parameterless constructor.

    HostFactory.Run(c =>
    {
        c.RunAsNetworkService();

        c.Service<YourService>(s =>
        {
            s.ConstructUsing(() => new YourService());
            s.WhenStarted((service, control) => service.Start());
            s.WhenStopped((service, control) => service.Stop());

            s.OwinEndpoint(app =>
            {
                app.Domain = "localhost";
                app.Port = 8080;


            });

            // Create your container
            var builder = new ContainerBuilder();
            builder.RegisterType<SampleDependency>().As<ISampleDependency>().SingleInstance().PropertiesAutowired();
            builder.RegisterApiControllers(Assembly.GetExecutingAssembly());
            var container = builder.Build();
            
            s.OwinEndpoint(app =>
            {
                app.UseDependencyResolver(new AutofacWebApiDependencyResolver(container));
            });

        });

    });

Service doesn't work on lan

Hi,
I can't reach my service over the network.
This is my configuration: