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

34 lines
1.8 KiB
Markdown
Raw Normal View History

Clean up documentation
2018-11-29 16:00:00 +00:00
# WinSW extensions
Document the extension engine and exisitng extensions (#141) * Document the extension engine and exisitng extensions * Add the link to Extensions in ToC
2016-12-02 12:59:26 +00:00
Clean up documentation
2018-11-29 16:00:00 +00:00
Starting from WinSW 2.0, the wrapper provides an internal extension engine and several extensions.
Document the extension engine and exisitng extensions (#141) * Document the extension engine and exisitng extensions * Add the link to Extensions in ToC
2016-12-02 12:59:26 +00:00
These extensions allow to alter the behavior of the Windows service in order to setup the required service environment.
Update documentation headers
2018-11-27 16:00:00 +00:00
## Available extensions
Document the extension engine and exisitng extensions (#141) * Document the extension engine and exisitng extensions * Add the link to Extensions in ToC
2016-12-02 12:59:26 +00:00
Docs: fix the link in extensions.md
2016-12-02 14:05:15 +00:00
* [Shared Directory Mapper](sharedDirectoryMapper.md) - Allows mapping shared drives before starting the executable
Document the extension engine and exisitng extensions (#141) * Document the extension engine and exisitng extensions * Add the link to Extensions in ToC
2016-12-02 12:59:26 +00:00
* [Runaway Process Killer](runawayProcessKiller.md) - Termination of processes started by the previous runs of WinSW
Update documentation headers
2018-11-27 16:00:00 +00:00
## Developer guide
Document the extension engine and exisitng extensions (#141) * Document the extension engine and exisitng extensions * Add the link to Extensions in ToC
2016-12-02 12:59:26 +00:00
Clean up documentation
2018-11-29 16:00:00 +00:00
In WinSW v2 the extension does not support inclusion of external extension DLLs.
Document the extension engine and exisitng extensions (#141) * Document the extension engine and exisitng extensions * Add the link to Extensions in ToC
2016-12-02 12:59:26 +00:00
Update documentation headers
2018-11-27 16:00:00 +00:00
### Adding external extensions
Document the extension engine and exisitng extensions (#141) * Document the extension engine and exisitng extensions * Add the link to Extensions in ToC
2016-12-02 12:59:26 +00:00
The only way to create an external extension is to create a new extension DLL and
then to merge this DLL into the executable using tools like `ILMerge`.
See the example in `src/Core/ServiceWrapper/winsw.csproj`.
Generic extension creation guideline:
* Extension DLL should reference the `WinSWCore` library.
* The extension should extend the `AbstractWinSWExtension` class.
* The extension then can override event handlers offered by the upper class.
YAML extension support documentation (#655) * Yaml extension support documentation * Fixed Typos
2020-08-22 10:51:14 +00:00
* The extension should implement the configuration parsing from the `XmlNode` and `YamlExtensionConfiguration`.
Document the extension engine and exisitng extensions (#141) * Document the extension engine and exisitng extensions * Add the link to Extensions in ToC
2016-12-02 12:59:26 +00:00
* The extension should support disabling from the configuration file.
YAML extension support documentation (#655) * Yaml extension support documentation * Fixed Typos
2020-08-22 10:51:14 +00:00
WinSW engine will automatically locate your extension using the class name in the [XML configuration file](../xmlConfigFile.md) or [YAML configuration file](../yamlConfigFile.md).
Document the extension engine and exisitng extensions (#141) * Document the extension engine and exisitng extensions * Add the link to Extensions in ToC
2016-12-02 12:59:26 +00:00
See configuration samples provided for the extensions in the core.
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
For extensions from external DLLs, the `className` field should also specify the assembly name.
It can be done via fully qualified class name or just by the `${CLASS_NAME}, ${ASSEMBLY_NAME}` declaration.
Document the extension engine and exisitng extensions (#141) * Document the extension engine and exisitng extensions * Add the link to Extensions in ToC
2016-12-02 12:59:26 +00:00
Clean up documentation
2018-11-29 16:00:00 +00:00
Please note that in the current versions of WinSW v2 the binary compatibility of extension APIs **is not guaranteed**.