{"id":13398381,"url":"https://github.com/winsw/winsw","last_synced_at":"2025-05-15T00:00:36.621Z","repository":{"id":799397,"uuid":"500093","full_name":"winsw/winsw","owner":"winsw","description":"A wrapper executable that can run any executable as a Windows service, in a permissive license.","archived":false,"fork":false,"pushed_at":"2024-04-25T15:34:47.000Z","size":3510,"stargazers_count":12858,"open_issues_count":232,"forks_count":1623,"subscribers_count":243,"default_branch":"v3","last_synced_at":"2025-05-07T23:38:55.426Z","etag":null,"topics":["csharp","dotnet","nuget","windows-service","windows-service-wrapper"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/winsw.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2010-02-03T02:49:39.000Z","updated_at":"2025-05-07T15:30:25.000Z","dependencies_parsed_at":"2024-01-13T16:23:16.782Z","dependency_job_id":"f0e9c66e-9ddb-4cb7-998b-552a88e85f3f","html_url":"https://github.com/winsw/winsw","commit_stats":{"total_commits":657,"total_committers":59,"mean_commits":"11.135593220338983","dds":0.6971080669710807,"last_synced_commit":"e4cf507bae5981363a9cdc0f7301c1aa892af401"},"previous_names":["kohsuke/winsw"],"tags_count":43,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winsw%2Fwinsw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winsw%2Fwinsw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winsw%2Fwinsw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winsw%2Fwinsw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/winsw","download_url":"https://codeload.github.com/winsw/winsw/tar.gz/refs/heads/v3","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254249199,"owners_count":22039029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","dotnet","nuget","windows-service","windows-service-wrapper"],"created_at":"2024-07-30T19:00:24.395Z","updated_at":"2025-05-15T00:00:36.415Z","avatar_url":"https://github.com/winsw.png","language":"C#","funding_links":[],"categories":["C# #","C\\#","C#","OpsShit","Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# Windows Service Wrapper in a permissive license\n\n[![Github All Releases](https://img.shields.io/github/downloads/winsw/winsw/total?style=flat-square)](https://github.com/winsw/winsw/releases)\n[![GitHub Release](https://img.shields.io/github/v/release/winsw/winsw?include_prereleases\u0026sort=semver\u0026style=flat-square)](https://github.com/winsw/winsw/releases)\n[![NuGet](https://img.shields.io/nuget/v/WinSW?style=flat-square)](https://www.nuget.org/packages/WinSW/)\n[![Build Status](https://img.shields.io/azure-devops/build/winsw/aabe43dd-6f6d-4660-b5dd-5b79e1e2ef4e/1?style=flat-square)](https://dev.azure.com/winsw/winsw/_build?definitionId=1\u0026_a=summary)\n[![Deployment Status](https://img.shields.io/azure-devops/release/winsw/aabe43dd-6f6d-4660-b5dd-5b79e1e2ef4e/1/1?style=flat-square)](https://dev.azure.com/winsw/winsw/_release?_a=releases\u0026view=mine\u0026definitionId=1)\n[![Gitter](https://img.shields.io/gitter/room/winsw/winsw?style=flat-square)](https://gitter.im/winsw/winsw?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n[![License](https://img.shields.io/github/license/winsw/winsw?style=flat-square)](LICENSE.txt)\n\nWinSW wraps and manages any application as a Windows service.\n\n**We are actively developing WinSW 3. Please refer to the [v2](https://github.com/winsw/winsw/tree/master) branch for previous version documentation.**\n\n## Why?\n\nSee the [project manifest](MANIFEST.md).\n\n## Supported platforms\n\nWinSW 3 can run on Windows platforms with .NET Framework 4.6.1 or later versions installed.\nFor systems without .NET Framework, the project provides native 64-bit and 32-bit executables based on .NET 7.\n\nMore executables can be added upon request.\n\n[.NET Framework system requirements](https://docs.microsoft.com/dotnet/framework/get-started/system-requirements)\\\nPreinstalled since Windows 10, version 1511 and Windows Server 2016.\\\nInstallable since Windows 7 SP1 and Windows Server 2008 R2 SP1.\n\n[.NET 7 system requirements](https://github.com/dotnet/core/blob/main/release-notes/7.0/supported-os.md)\\\nSupported since Windows 10, version 1607, Windows Server (Core) 2012 R2 and Nano Server, version 1809.\n\n## Download\n\nLatest release and pre-release WinSW binaries are available on [GitHub Releases](https://github.com/winsw/winsw/releases).\n\nAlternative sources:\n\n* CI builds are available on [Azure Pipelines](https://dev.azure.com/winsw/winsw/_build?definitionId=1).\n* [NuGet](https://www.nuget.org/packages/WinSW/). (2.x)\n* [Maven packaging](https://github.com/jenkinsci/winsw-maven-packaging) for executables, hosted by the [Jenkins project](https://jenkins.io/).\nBinaries are available [here](https://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/). (2.x)\n\n## Get started\n\n### Use WinSW as a global tool\n\n1. Take *WinSW.exe* or *WinSW.zip* from the distribution.\n1. Write *myapp.xml* (see the [XML config file specification](docs/xml-config-file.md) and [samples](samples) for more details).\n1. Run [`winsw install myapp.xml [options]`](docs/cli-commands.md#install-command) to install the service.\n1. Run [`winsw start myapp.xml`](docs/cli-commands.md#start-command) to start the service.\n1. Run [`winsw status myapp.xml`](docs/cli-commands.md#status-command) to see if your service is up and running.\n\n### Use WinSW as a bundled tool\n\n1. Take *WinSW.exe* or *WinSW.zip* from the distribution, and rename the *.exe* to your taste (such as *myapp.exe*).\n1. Write *myapp.xml* (see the [XML config file specification](docs/xml-config-file.md) and [samples](samples) for more details).\n1. Place those two files side by side, because that's how WinSW discovers its co-related configuration.\n1. Run [`myapp.exe install [options]`](docs/cli-commands.md#install-command) to install the service.\n1. Run [`myapp.exe start`](docs/cli-commands.md#start-command) to start the service.\n\n### Sample configuration file\n\nYou write the configuration file that defines your service.\nThe example below is a primitive example being used in the Jenkins project:\n\n```xml\n\u003cservice\u003e\n  \u003cid\u003ejenkins\u003c/id\u003e\n  \u003cname\u003eJenkins\u003c/name\u003e\n  \u003cdescription\u003eThis service runs Jenkins continuous integration system.\u003c/description\u003e\n  \u003cenv name=\"JENKINS_HOME\" value=\"%BASE%\"/\u003e\n  \u003cexecutable\u003ejava\u003c/executable\u003e\n  \u003carguments\u003e-Xrs -Xmx256m -jar \"%BASE%\\jenkins.war\" --httpPort=8080\u003c/arguments\u003e\n  \u003clog mode=\"roll\"\u003e\u003c/log\u003e\n\u003c/service\u003e\n```\n\nThe full specification of the configuration file is available [here](docs/xml-config-file.md).\nYou can find more samples [here](samples).\n\n## Usage\n\nWinSW is being managed by the [XML configuration file](docs/xml-config-file.md).\n\nYour renamed *WinSW.exe* binary also accepts the following commands:\n\n| Command                                             | Description |\n| -------                                             | ----------- |\n| [install](docs/cli-commands.md#install-command)     | Installs the service. |\n| [uninstall](docs/cli-commands.md#uninstall-command) | Uninstalls the service. |\n| [start](docs/cli-commands.md#start-command)         | Starts the service. |\n| [stop](docs/cli-commands.md#stop-command)           | Stops the service. |\n| [restart](docs/cli-commands.md#restart-command)     | Stops and then starts the service. |\n| [status](docs/cli-commands.md#status-command)       | Checks the status of the service. |\n| [refresh](docs/cli-commands.md#refresh-command)     | Refreshes the service properties without reinstallation. |\n| [customize](docs/cli-commands.md#customize-command) | Customizes the wrapper executable. |\n| dev                                                 | Experimental commands. |\n\nExperimental commands:\n\n| Command                                           | Description |\n| -------                                           | ----------- |\n| [dev ps](docs/cli-commands.md#dev-ps-command)     | Draws the process tree associated with the service. |\n| [dev kill](docs/cli-commands.md#dev-kill-command) | Terminates the service if it has stopped responding. |\n| [dev list](docs/cli-commands.md#dev-list-command) | Lists services managed by the current executable. |\n\nMost commands require Administrator privileges to execute. WinSW will prompt for UAC in non-elevated sessions.\n\n## Documentation\n\n* [Migrate to WinSW 3.x](docs/migrate-to-3-x.md)\n* Configuration:\n  * [XML configuration file](docs/xml-config-file.md)\n  * [Logging and error reporting](docs/logging-and-error-reporting.md)\n  * [Extensions](docs/extensions/extensions.md)\n* Use cases:\n  * [Self-restarting services](docs/self-restarting-service.md)\n  * [Deferred file operations](docs/deferred-file-operations.md)\n\n## Contributing\n\nContributions are welcome!\nSee the [contributing guidelines](CONTRIBUTING.md) for more information.\n\n## License\n\nWinSW is licensed under the [MIT](LICENSE.txt) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwinsw%2Fwinsw","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwinsw%2Fwinsw","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwinsw%2Fwinsw/lists"}