https://github.com/Jamesits/SvcGuest

Install any executable as a Windows service. (systemd compatible config!)
https://github.com/Jamesits/SvcGuest

windows-service-wrapper

Last synced: 3 days ago
JSON representation

Install any executable as a Windows service. (systemd compatible config!)

• Host: GitHub
• URL: https://github.com/Jamesits/SvcGuest
• Owner: Jamesits
• License: mpl-2.0
• Created: 2018-09-15T13:42:12.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-04-20T13:29:36.000Z (over 2 years ago)
• Last Synced: 2024-11-08T05:26:12.171Z (5 days ago)
• Topics: windows-service-wrapper
• Language: C#
• Homepage:
• Size: 147 KB
• Stars: 49
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SvcGuest

Register any executable as a Windows service with a (partially) systemd-compatible unit config. What SvcGuest can achieve is a lot like [NSSM (the Non-Sucking Service Manager)](https://nssm.cc) but SvcGuest is designed to be shipped along with a larger piece of software rather than be used by end user directly.

[![Build status](https://dev.azure.com/nekomimiswitch/General/_apis/build/status/SvcGuest)](https://dev.azure.com/nekomimiswitch/General/_build/latest?definitionId=2)

Binaries are available for download in the [releases](https://github.com/Jamesits/SvcGuest/releases) page for your convenience. 

## Requirements

 * .NET Framework 4.6.2

## Usage

### Software Distributor

If you wrote a piece of software and doesn't want to adapt to the Windows Service interfaces yourself, you can distribute a binary release of `SvcGuest.exe` and your `program.service` config file ([example](examples/)) with your software, and run `svcguest.exe --install --config program.service` (remember to elevate!) during your software installation.

[MPL 2.0 License](LICENSE) allows distributing `SvcGuest.exe` with your software for free with some limitations. Ask your lawyer for advice if in doubt. 

### End User

Assume you have a program that you want to run at startup (before user login) but don't want to use legacy dirty methods like Task Scheduler. You need to put a `SvcGuest.exe`, a `your-program.service` config file (an [example](examples/) is available) into the same directory as the program (recommended, other directories are OK too).

* Right click on `svcguest.exe` -> "Run as administrator" to install all units interactively

* `svcguest.exe --install --config your-program.service` to register the service

* `svcguest.exe --uninstall --config your-program.service` to remove the service

* `svcguest.exe --help` for a complete help

## Features

Features supported on the master branch (for the releases, see the `.service` file provided):

* [x] Unit

    * [x] Description

    * [x] Documentation

* [x] Service

    * [x] Type

        * [x] simple

        * [ ] forking

        * [ ] oneshot

        * [ ] idle

    * [x] User

    * [x] RemainAfterExit

    * [x] ExecStartPre

    * [x] ExecStart

    * [x] ExecStartPost

    * [x] ExecStop

    * [x] ExecStopPost

    * [ ] Environment

    * [ ] EnvironmentFile

    * [ ] PassEnvironment

    * [ ] UnsetEnvironment

    * [x] WorkingDirectory

    * [ ] CPUAffinity

* [ ] Install

    * [ ] WantedBy

    * [ ] RequiredBy

## Notes

### Versioning 

Master branch is unstable; please use a specific release for production use. 

It is recommended to upgrade to the latest revision (i.e. if you are at 1.0.2.4, then you should upgrade to 1.0.2.5 or later version of 1.0.2.x); but if you have no issue running one of the releases and don't need any new function, then you don't need to upgrade to a later minor version (e.g. 1.0.2.x to 1.0.3.x).

### Donation

If this project is helpful to you, please consider buying me a coffee.

[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/Jamesits) or [PayPal](https://paypal.me/Jamesits)