github
/
winsw
mirror of https://github.com/winsw/winsw
1
0
Fork 0
Code Issues Releases Wiki Activity
winsw/README.md

108 lines
4.3 KiB
Markdown
Raw Normal View History

Revise docs for 3.0.0-alpha.1 (#587) * Add pre-release badge * Update XML spec for `<username>` * Update exit codes * Update XML spec for `<prompt>` * Create migration guide * Add a note for the previous version * docs -> documentation * * Format usage * Talk to myself * * Add deployment status badge * Update version strings * Update README title * Link to the migration guide * * Remove .NET Core version number * Delete exe-config-file.md * Update README.md * migration-guide.md -> migrate-to-3-x.md
2020-07-20 13:40:05 +00:00
# Windows Service Wrapper in a permissive license
adding doc
2013-03-01 23:55:22 +00:00
Clean up documentation
2018-11-29 16:00:00 +00:00
[![Github All Releases](https://img.shields.io/github/downloads/winsw/winsw/total?style=flat-square)](https://github.com/winsw/winsw/releases)
Revise docs for 3.0.0-alpha.1 (#587) * Add pre-release badge * Update XML spec for `<username>` * Update exit codes * Update XML spec for `<prompt>` * Create migration guide * Add a note for the previous version * docs -> documentation * * Format usage * Talk to myself * * Add deployment status badge * Update version strings * Update README title * Link to the migration guide * * Remove .NET Core version number * Delete exe-config-file.md * Update README.md * migration-guide.md -> migrate-to-3-x.md
2020-07-20 13:40:05 +00:00
[![GitHub Release](https://img.shields.io/github/v/release/winsw/winsw?include_prereleases&style=flat-square)](https://github.com/winsw/winsw/releases)
Clean up documentation
2018-11-29 16:00:00 +00:00
[![NuGet](https://img.shields.io/nuget/v/WinSW?style=flat-square)](https://www.nuget.org/packages/WinSW/)
Update build status badge on README
2019-09-17 16:00:00 +00:00
[![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&_a=summary)
Revise docs for 3.0.0-alpha.1 (#587) * Add pre-release badge * Update XML spec for `<username>` * Update exit codes * Update XML spec for `<prompt>` * Create migration guide * Add a note for the previous version * docs -> documentation * * Format usage * Talk to myself * * Add deployment status badge * Update version strings * Update README title * Link to the migration guide * * Remove .NET Core version number * Delete exe-config-file.md * Update README.md * migration-guide.md -> migrate-to-3-x.md
2020-07-20 13:40:05 +00:00
[![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&view=mine&definitionId=1)
Clean up documentation
2018-11-29 16:00:00 +00:00
[![Gitter](https://img.shields.io/gitter/room/winsw/winsw?style=flat-square)](https://gitter.im/winsw/winsw?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![License](https://img.shields.io/github/license/winsw/winsw?style=flat-square)](LICENSE.txt)
Fixes #142 - Deploy the automatic build on Appveyor (#144) * First configuration stub * Get rid of the old winsw_cert.pfx references, adjust docs * Fix the corrupted log4net reference, we use 2.0.3 * Generate stub SNK file * Signing: Try full SDK path to generate SNKs * Fix the path * Signing: Sign all assemblies being packed into WinSW * Tests: Try enabling tests * Tests and artifacts: Use absolute paths * Artifact path must be relative * The test DLL is the NUnit one * nunit-console does not require loggers * NUnit: Try picking all DLLs in the output folder * NUnit console: No wildcards * Tests: Fix the test project to make it properly working with the new project structure * Docs: Clarify the specifics of external extension usage * Add AppVeyor badge to README.md
2016-12-04 08:34:19 +00:00
Update the readme file
2016-11-25 22:26:12 +00:00
WinSW is an executable binary, which can be used to wrap and manage a custom process as a Windows service.
Clean up documentation
2018-11-29 16:00:00 +00:00
Once you download the installation package, you can rename *WinSW.exe* to any name, e.g. *MyService.exe*.
Update the readme file
2016-11-25 22:26:12 +00:00
Revise docs for 3.0.0-alpha.1 (#587) * Add pre-release badge * Update XML spec for `<username>` * Update exit codes * Update XML spec for `<prompt>` * Create migration guide * Add a note for the previous version * docs -> documentation * * Format usage * Talk to myself * * Add deployment status badge * Update version strings * Update README title * Link to the migration guide * * Remove .NET Core version number * Delete exe-config-file.md * Update README.md * migration-guide.md -> migrate-to-3-x.md
2020-07-20 13:40:05 +00:00
**We are actively developing WinSW v3. Please refer to the v2 branch for previous version documentation.**
**Please help us prioritize items by voting or commenting on the issues!**
Update documentation headers
2018-11-27 16:00:00 +00:00
## Why?
Docs: Decouple the project manifest to a standalone page
2016-11-25 22:28:42 +00:00
See the [project manifest](MANIFEST.md).
Cleanup and restructure the README page
2020-04-10 21:29:34 +00:00
## Supported platforms
WinSW offers executables for .NET Framework 2.0, 4.0 and 4.6.1.
Update README.md Co-Authored-By: Next Turn <45985406+NextTurn@users.noreply.github.com>
2020-04-17 06:03:12 +00:00
It can run on Windows platforms which have these versions of .NET Framework installed.
Revise docs for 3.0.0-alpha.1 (#587) * Add pre-release badge * Update XML spec for `<username>` * Update exit codes * Update XML spec for `<prompt>` * Create migration guide * Add a note for the previous version * docs -> documentation * * Format usage * Talk to myself * * Add deployment status badge * Update version strings * Update README title * Link to the migration guide * * Remove .NET Core version number * Delete exe-config-file.md * Update README.md * migration-guide.md -> migrate-to-3-x.md
2020-07-20 13:40:05 +00:00
For systems without .NET Framework, the project provides native 64-bit and 32-bit executables based on .NET Core.
Cleanup and restructure the README page
2020-04-10 21:29:34 +00:00
More executables can be added upon request.
Update documentation headers
2018-11-27 16:00:00 +00:00
## Download
Update the readme file
2016-11-25 22:26:12 +00:00
Cleanup and restructure the README page
2020-04-10 21:29:34 +00:00
WinSW binaries are available on [GitHub Releases](https://github.com/winsw/winsw/releases) and [NuGet](https://www.nuget.org/packages/WinSW/).
Reference GitHub as a release source
2016-12-09 22:58:28 +00:00
Cleanup and restructure the README page
2020-04-10 21:29:34 +00:00
Alternative sources:
* [Maven packaging](https://github.com/jenkinsci/winsw-maven-packaging) for executables, hosted by the [Jenkins project](https://jenkins.io/).
Binaries are available [here](https://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/).
Update the readme file
2016-11-25 22:26:12 +00:00
Update documentation headers
2018-11-27 16:00:00 +00:00
## Usage
Docs: Fix links
2016-11-25 20:56:39 +00:00
Revise docs for 3.0.0-alpha.1 (#587) * Add pre-release badge * Update XML spec for `<username>` * Update exit codes * Update XML spec for `<prompt>` * Create migration guide * Add a note for the previous version * docs -> documentation * * Format usage * Talk to myself * * Add deployment status badge * Update version strings * Update README title * Link to the migration guide * * Remove .NET Core version number * Delete exe-config-file.md * Update README.md * migration-guide.md -> migrate-to-3-x.md
2020-07-20 13:40:05 +00:00
WinSW is being managed by the [XML configuration file](docs/xml-config-file.md).
Docs: Fix links
2016-11-25 20:56:39 +00:00
Clean up documentation
2018-11-29 16:00:00 +00:00
Your renamed *WinSW.exe* binary also accepts the following commands:
Docs: Fix links
2016-11-25 20:56:39 +00:00
Revise docs for 3.0.0-alpha.1 (#587) * Add pre-release badge * Update XML spec for `<username>` * Update exit codes * Update XML spec for `<prompt>` * Create migration guide * Add a note for the previous version * docs -> documentation * * Format usage * Talk to myself * * Add deployment status badge * Update version strings * Update README title * Link to the migration guide * * Remove .NET Core version number * Delete exe-config-file.md * Update README.md * migration-guide.md -> migrate-to-3-x.md
2020-07-20 13:40:05 +00:00
* `install`
Install the service to Windows Service Controller.
Rename docs for SEO
2020-02-03 16:00:00 +00:00
This command requires some preliminary steps described in the [Installation guide](docs/installation.md).
Revise docs for 3.0.0-alpha.1 (#587) * Add pre-release badge * Update XML spec for `<username>` * Update exit codes * Update XML spec for `<prompt>` * Create migration guide * Add a note for the previous version * docs -> documentation * * Format usage * Talk to myself * * Add deployment status badge * Update version strings * Update README title * Link to the migration guide * * Remove .NET Core version number * Delete exe-config-file.md * Update README.md * migration-guide.md -> migrate-to-3-x.md
2020-07-20 13:40:05 +00:00
* `uninstall`
Uninstall the service. The opposite operation of above.
* `start`
Start the service. The service must have already been installed.
* `stop`
Stop the service.
* `stopwait`
Stop the service and wait until it's actually stopped.
* `restart`
Restart the service. If the service is not currently running, this command acts like `start`.
* `status`
Check the current status of the service.
Readme: Fix the documentation output
2017-06-15 07:09:16 +00:00
* This command prints one line to the console.
* `NonExistent` indicates the service is not currently installed
* `Started` to indicate the service is currently running
* `Stopped` to indicate that the service is installed but not currently running.
moving more text from Wiki
2013-03-02 00:11:27 +00:00
Revise docs for 3.0.0-alpha.1 (#587) * Add pre-release badge * Update XML spec for `<username>` * Update exit codes * Update XML spec for `<prompt>` * Create migration guide * Add a note for the previous version * docs -> documentation * * Format usage * Talk to myself * * Add deployment status badge * Update version strings * Update README title * Link to the migration guide * * Remove .NET Core version number * Delete exe-config-file.md * Update README.md * migration-guide.md -> migrate-to-3-x.md
2020-07-20 13:40:05 +00:00
Most commands require Administrator privileges to execute. Since 2.8, WinSW will prompt for UAC in non-elevated sessions.
Prompt for elevation (#457) * Prompt for elevation * Add error messages for interop errors * Assume process is elevated on Windows XP Co-authored-by: Oleg Nenashev <o.v.nenashev@gmail.com>
2020-04-19 07:04:50 +00:00
Update documentation headers
2018-11-27 16:00:00 +00:00
## Documentation
moving more text from Wiki
2013-03-02 00:11:27 +00:00
Add WinSW Developer Guide
2017-05-05 13:35:50 +00:00
User documentation:
Rename docs for SEO
2020-02-03 16:00:00 +00:00
* [Installation guide](docs/installation.md) - Describes the installation process for different systems and .NET versions
Revise docs for 3.0.0-alpha.1 (#587) * Add pre-release badge * Update XML spec for `<username>` * Update exit codes * Update XML spec for `<prompt>` * Create migration guide * Add a note for the previous version * docs -> documentation * * Format usage * Talk to myself * * Add deployment status badge * Update version strings * Update README title * Link to the migration guide * * Remove .NET Core version number * Delete exe-config-file.md * Update README.md * migration-guide.md -> migrate-to-3-x.md
2020-07-20 13:40:05 +00:00
* [Migration guide](docs/migrate-to-3-x) - Migrate to WinSW 3.x.
Decouple the documentation to several pages
2016-11-24 03:02:30 +00:00
* Configuration:
Rename docs for SEO
2020-02-03 16:00:00 +00:00
* [Main XML configuration file](docs/xml-config-file.md)
* [EXE configuration file](docs/exe-config-file.md)
* [Logging and error reporting](docs/logging-and-error-reporting.md)
* [Extensions](docs/extensions/extensions.md)
Decouple the documentation to several pages
2016-11-24 03:02:30 +00:00
* Use-cases:
Rename docs for SEO
2020-02-03 16:00:00 +00:00
* [Self-restarting services](docs/self-restarting-service.md)
* [Deferred file operations](docs/deferred-file-operations.md)
Descibe the build environment Follow-up to #62 Also resolves #5
2015-01-28 13:40:12 +00:00
Add WinSW Developer Guide
2017-05-05 13:35:50 +00:00
Developer documentation:
Update documentation headers
2018-11-27 16:00:00 +00:00
* [Developer guide](DEVELOPER.md)
Add WinSW Developer Guide
2017-05-05 13:35:50 +00:00
Cleanup and restructure the README page
2020-04-10 21:29:34 +00:00
## Contributing
Add compatibility notes to the documentation
2016-12-09 21:41:06 +00:00
Cleanup and restructure the README page
2020-04-10 21:29:34 +00:00
Contributions are welcome!
Apply suggestions from code review by @NextTurn Co-Authored-By: Next Turn <45985406+NextTurn@users.noreply.github.com>
2020-04-11 12:16:52 +00:00
No Contributor License Agreement is needed, just submit your pull requests.
Rename docs for SEO
2020-02-03 16:00:00 +00:00
See the [contributing guidelines](CONTRIBUTING.md) for more information.
Docs: Update WinSW 1/2 in README
2016-11-25 12:34:50 +00:00
Clean up documentation
2018-11-29 16:00:00 +00:00
## License
WinSW is licensed under the [MIT](LICENSE.txt) license.