Using Pode as a Service in Windows, MacOSX and Linux (Systemd)

[mdaneri]

Description

This pull request introduces a new feature to the Pode framework: built-in cross-platform service management. With this update, users can now easily register, start, stop, suspend, resume, query, restart, and unregister Pode-based services on Windows, Linux, and macOS.

Key Features

• New Service Functions:

  • Register-PodeService: Register a Pode-based service with customizable options such as username, startup type, logging, and more.
  • Start-PodeService: Start a registered service.
  • Stop-PodeService: Stop a running service.
  • Suspend-PodeService: Suspend a service (Windows only).
  • Resume-PodeService: Resume a suspended service (Windows only).
  • Restart-PodeService: Restart a service.
  • Get-PodeService: Query the status of a service, including Running, Stopped, or Paused.
  • Unregister-PodeService: Unregister a service with optional forceful stopping.

• Cross-Platform Compatibility:

  • Windows: Uses Windows Service Manager and supports additional options like SecurityDescriptorSddl.
  • Linux: Manages services via systemd, with support for custom user creation.
  • macOS: Leverages launchctl for service management.

Examples

Register and Start a Service

Register-PodeService -Name "HelloService" -Description "Example Pode Service" -ParameterString "-Verbose" -Start

Stop a Service

Stop-PodeService -Name "HelloService"

Query a Service

Get-PodeService -Name "HelloService"

Documentation

The pull request includes comprehensive documentation covering:

• Usage of all service-related functions with examples.

Bug Fixes

• Addressed potential issues with missing service configuration files during unregistration.
• Improved error handling and verbose logging across all service functions.

Notes

• Users should ensure they have administrative/root privileges when using these functions.

[A-wels]

@mdaneri @Badgerati What is missing on this pull request in order to merge it? Is there anything blocking it?

[Badgerati]

@A-wels There's a lot of conflicts from various other works and refactors that need resolving, it was also never reviewed/tested.

Is there something specific you're after here, which can't be achieved using exists Run as a Service docs?

[A-wels]

@Badgerati nssm has not been changed in 9 years and I really don't feel comfortable recommending it to my company. I would much prefer a native way to handle the Pode lifecycle on Windows.

[Badgerati]

@A-wels Thanks. Once I've finished with other tasks for Pode, I'll come back to this and review.