# Servy

> Servy lets you run any app as a native Windows service with full control over the working directory, startup type, process priority, CPU affinity, logging, health checks, environment variables, dependencies, pre-launch and post-launch hooks, pre-stop and post-stop hooks, and parameters.

Starting from v10.2, Servy provides enterprise-grade per-service isolation between custom accounts, authenticated encryption (DPAPI, HKDF, AES-256 + HMAC-SHA256), and automated vault ACL hardening. All releases feature signed binaries, SBOMs, and continuous vulnerability scanning. See [Security](https://github.com/aelassas/servy/wiki/Security) and [Architecture](https://github.com/aelassas/servy/wiki/Architecture) for details.

Servy offers a desktop app, a CLI, and a PowerShell module that let you create, configure, and manage Windows services interactively or through scripts and CI/CD pipelines. It also includes a Manager app for easily monitoring and managing all installed services in real time.

Servy continuously monitors your app, restarting it automatically if it crashes, hangs, or stops. It allows non-service apps to run in the background and start automatically at system boot, even before logon, without rewriting them as services. Use it to run Node.js, Python, .NET, Java, Go, Rust, PHP, or Ruby applications; keep web servers, LLMs, background workers, sync tools, or daemons alive after reboots; and automate task runners, schedulers, or scripts in production with built-in health checks, logging, and restart policies.

## Features
- Clean, simple UI
- Monitor and manage all installed services with Servy Manager
- Real-time CPU and RAM monitoring with live performance graphs for installed services
- Real-time service stdout and stderr output preview in Servy Console
- Service dependency tree visualization with status indicators
- CLI and PowerShell module for full scripting and automated deployments
- Run any executable as a Windows service
- Set service name, description, startup type, priority, CPU affinity, working directory, environment variables, and dependencies
- Environment variable expansion supported in parameters, process paths, and startup directories
- Run services as Local System, local or domain accounts, Active Directory accounts, or gMSAs
- Redirect stdout/stderr to log files with automatic size-based and date-based rotations
- Run pre-launch hooks before starting the service, with retries, timeout, logging and failure handling
- Run post-launch hooks after the application starts successfully
- Run pre-stop and post-stop hooks before and after the application stops
- Supports Ctrl+C for command-line apps, close-window for GUI apps, and force kill if unresponsive
- Supports Ctrl+C propagation to descendant processes of the wrapped process
- Prevent orphaned/zombie processes with improved lifecycle management while ensuring resource cleanup
- Health checks and automatic service recovery
- Browse and search logs by level, date, and keyword for faster troubleshooting from Servy Manager
- Export/Import service configurations for easy backups and automation
- Service Event Notification alerts on service failures via Windows notifications and email, and via Slack, Microsoft Teams, Discord, Telegram, WhatsApp and more through a Heartbeat URL provider such as healthchecks.io
- Modern build (default, self-contained): Windows 10 (1809+), Windows 11 and Windows Server 2016+, on x64 and ARM64
- Legacy build (`net48`, requires .NET Framework 4.8): Windows 7 SP1, Windows 8.x and Windows Server 2008 R2+, on x64 only

## Who is it for?
- Developers: Run development servers, scripts, or custom tools as services without extra setup.
- Sysadmins & IT professionals: Ensure critical background processes stay alive, monitored, and properly logged.
- Teams or organizations: Automate background services reliably across multiple machines.

> **Full Text Documentation:** For full-text concatenated markdown documentation, see [llms-full.txt](https://servy-win.github.io/llms-full.txt).

## Quick Syntax Reference

### Servy CLI (`servy-cli.exe`)
- **Install Service:** `servy-cli install --name="MyService" --path="C:\App\app.exe" --startupType="Automatic"`
- **Start Service:** `servy-cli start --name="MyService"`
- **Stop Service:** `servy-cli stop --name="MyService"`
- **Restart Service:** `servy-cli restart --name="MyService"`
- **Uninstall Service:** `servy-cli uninstall --name="MyService"`
- **Query Status:** `servy-cli status --name="MyService"`

### Servy PowerShell Module (`Servy.psm1`)
- **Install Service:** `Install-ServyService -Name "MyService" -Path "C:\App\app.exe" -StartupType Automatic`
- **Start Service:** `Start-ServyService -Name "MyService"`
- **Stop Service:** `Stop-ServyService -Name "MyService"`
- **Restart Service:** `Restart-ServyService -Name "MyService"`
- **Get Service Status:** `Get-ServyServiceStatus -Name "MyService"`
- **Uninstall Service:** `Uninstall-ServyService -Name "MyService"`

## Official Website & Downloads

- [Home](https://servy-win.github.io/): Overview, quick example, use cases, and installation options
- [Downloads](https://servy-win.github.io/downloads/): Release history and download statistics
- [Contact](https://servy-win.github.io/contact/): Inquiries, suggestions, and support

## Core Documentation & Suite

- [Wiki Index](https://github.com/aelassas/servy/wiki): Complete GitHub wiki homepage
- [Overview](https://github.com/aelassas/servy/wiki/Overview): Quick example and a tour of the Desktop App and Manager settings
- [Installation Guide](https://github.com/aelassas/servy/wiki/Installation-Guide): Installing Servy via WinGet, Scoop, Chocolatey, and binaries
- [Quick Start / Usage](https://github.com/aelassas/servy/wiki/Usage): Core workflows and usage patterns
- [Servy Desktop App](https://github.com/aelassas/servy/wiki/Servy-Desktop-App): Managing services via the GUI
- [Servy Manager](https://github.com/aelassas/servy/wiki/Servy-Manager): Service status and health oversight
- [Servy CLI](https://github.com/aelassas/servy/wiki/Servy-CLI): Command-line reference, arguments, and flags
- [Servy PowerShell Module](https://github.com/aelassas/servy/wiki/Servy-PowerShell-Module): `Servy.psm1` cmdlet specifications and pipeline examples

## Configuration & Core Features

- [Advanced Configuration](https://github.com/aelassas/servy/wiki/Advanced-Configuration): Detailed service settings, priorities, and environment setup
- [Logging & Log Rotation](https://github.com/aelassas/servy/wiki/Logging-%26-Log-Rotation): stdout/stderr redirection, file sizes, and rotation policies
- [Health Monitoring & Recovery](https://github.com/aelassas/servy/wiki/Health-Monitoring-%26-Recovery): Crash recovery rules, heartbeat checks, and auto-restart policies
- [Environment Variables](https://github.com/aelassas/servy/wiki/Environment-Variables): Per-service custom environment blocks
- [Service Dependencies](https://github.com/aelassas/servy/wiki/Service-Dependencies): Startup ordering and dependency trees
- [Export / Import Services](https://github.com/aelassas/servy/wiki/Export-Import-Services): Exporting and deploying service configurations

## Lifecycle Hooks & Execution

- [Pre-Launch & Post-Launch Actions](https://github.com/aelassas/servy/wiki/Pre-Launch-%26-Post-Launch-Actions): Running scripts before and after service startup
- [Pre-Stop & Post-Stop Actions](https://github.com/aelassas/servy/wiki/Pre-Stop-%26-Post-Stop-Actions): Cleanup hooks prior to and following service shutdown
- [Shutdown & Teardown](https://github.com/aelassas/servy/wiki/Shutdown-%26-Teardown): Graceful termination timeouts and process kill trees

## Automation & Enterprise Production

- [Servy Automation & CI/CD](https://github.com/aelassas/servy/wiki/Servy-Automation-%26-CI-CD): Automated service deployments in pipelines
- [Embedding in Custom Installers](https://github.com/aelassas/servy/wiki/Embedding-in-Custom-Installers): Bundling Servy with WiX, Inno Setup, or custom installers
- [Integration with Monitoring Tools](https://github.com/aelassas/servy/wiki/Integration-with-Monitoring-Tools): Monitoring integrations, CI/CD pipelines, and Heartbeat URL out-of-band pings
- [Service Event Notifications](https://github.com/aelassas/servy/wiki/Service-Event-Notifications): Real-time alerts on crashes, failures, or state changes
- [Backup / Restore & VM Cloning](https://github.com/aelassas/servy/wiki/Backup-Restore-%26-VM-Cloning): Preserving configurations across server migrations

## Reference & Troubleshooting

- [Examples & Recipes](https://github.com/aelassas/servy/wiki/Examples-%26-Recipes): Production configurations for Python, Node.js, Java, Go, and .NET apps
- [Security](https://github.com/aelassas/servy/wiki/Security): Encryption at rest (DPAPI, HKDF, AES-256 with HMAC-SHA256), ACL hardening, supply chain, and the Servy trust boundary
- [Architecture](https://github.com/aelassas/servy/wiki/Architecture): Technology stack, project structure, architecture layers, and the named-pipe IPC with the Servy service
- [Comparison with Alternatives](https://github.com/aelassas/servy/wiki/Comparison-with-Alternatives): Detailed comparison vs. NSSM and WinSW
- [Building from Source](https://github.com/aelassas/servy/wiki/Building-from-Source): Compiling Servy from the C# source repository
- [Troubleshooting](https://github.com/aelassas/servy/wiki/Troubleshooting): Common failures and their fixes: services that won't start, access denied, missing logs, failing health checks
- [FAQ](https://github.com/aelassas/servy/wiki/FAQ): Frequently asked questions

## Source Code & Community

- [GitHub Repository](https://github.com/aelassas/servy): Source code and issue tracker
- [Latest Release](https://github.com/aelassas/servy/releases/latest): Release packages and installers
- [Changelog](https://github.com/aelassas/servy/blob/main/CHANGELOG.md): Version history and notes
- [Roadmap](https://github.com/aelassas/servy/blob/main/ROADMAP.md): Feature planning
- [License](https://github.com/aelassas/servy/blob/main/LICENSE.txt): MIT License
- [Sponsor Servy](https://github.com/sponsors/aelassas): Support ongoing development