Topshelf - An easy service hosting framework for building Windows services using .NET

LICENSE

Apache 2.0 - see LICENSE

IMPORTANT

NOTE: If you are looking at the source - please run build.bat before opening the solution. It creates the SolutionVersion.cs file that is necessary for a successful build.

Overview

INFO

Topshelf is an awesome service host for windows services.

Getting started with TopShelf

We are currently working on more documentation in order to get started. In principle, download the zip file.

Mailing List

Topshelf Discuss

Source

1. Clone the source down to your machine. git clone git://github.com/Topshelf/Topshelf.git
2. Download git, ruby and gems. Install -- a tutorial is here: [http://guides.rubyonrails.org/command_line.html]
3. Run rake global_version in order to generate the SolutionVersion.cs file which is otherwise missing.
   • You must have git on the path in order to do this. (Right click on Computer > Advanced System Settings, Advanced (tab) > Environment Variables... > Append the git executable's directory at the end of the PATH environment variable.
4. Edit with Visual Studio 2010 or alternatively edit and run rake. rake help displays all possible tasks that you can run. The package task, is what the build server does.
5. The default is .Net 4.0. At the moment, editing the solution file for .Net 3.5 requires the "fix" below.
6. In order to debug one of your services together with Topshelf: a) set Topshelf.Host as the startup project b) add "run" as parameters when Topshelf.Host starts (in the debug tab of properties) c) Add your service to the 'Services' folder. d) (open your own files and place debug points in them)

Editing in Visual Studio

1. Run rake global_version in the root folder.
2. Double-click/open the .sln file.

You can alternatively edit and build for .Net 3.5 instead of .Net 4.0 with this step:

• Edit all TopShelf/src/**/*.csproj files at the top of the files, where it says: `v4.0</TargetFrameworkVersion

  Change v4.0 to v3.5. The build script itself won't be affected by this change, but it'll help Visual Studio know what version we're building for.

3. Edit Topshelf.Host/app.config and uncomment the supportedRuntime- and runtime-elements.

Contributing

1. git config --global core.autoclrf false
2. Shared ReSharper settings are under src/Topshelf.resharper.xml for formatting and style. ReSharper should pick up on this automatically when you launch Visual Studio.
3. Make a pull request

Some hints

• Have a look at the readme-files along with the samples

• Make sure that your Shelved services don't change anything inside the 'Services' folder.

• Your service's .config-file needs to be named 'ServiceName.config', even if your dll is named 'ServiceName.dll' and App.config would be transformed into 'ServiceName.dll.config'. 'ServiceName.dll.config' won't be searched for when looking for a bootstrapper.

• When you use your Bootstrapper, you have the option of either calling HowToBuildService(), or ConstructUsing(). HowToBuildService actually calls ConstructUsing internally and you need the third argument -- the communication channel. This is the signature of the delegate you pass to ConstructUsing:

  public delegate TService DescriptionServiceFactory< TService >( ServiceDescription description, string name, IServiceChannel coordinatorChannel) : MulticastDelegate

REQUIREMENTS

• .NET Framework 3.5
• OR: .Net Framework 4.0

CREDITS

Logo Design by The Agile Badger