From b9947108a483a749be28deba9e1e8f0b29d640d2 Mon Sep 17 00:00:00 2001
From: Pujit Mehrotra <pujit@lime-technology.com>
Date: Mon, 13 Jan 2025 10:52:58 -0500
Subject: [PATCH] doc(api): document ready signal during nest server boot

---
 api/src/unraid-api/main.ts | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/api/src/unraid-api/main.ts b/api/src/unraid-api/main.ts
index b5a000e67..6832529bb 100644
--- a/api/src/unraid-api/main.ts
+++ b/api/src/unraid-api/main.ts
@@ -48,6 +48,10 @@ export async function bootstrapNestServer(): Promise<NestFastifyApplication> {
         const result = await server.listen({ port: parseInt(PORT), host: '0.0.0.0' });
         console.log('Server listening on %s', result);
     }
+
+    // This 'ready' signal tells pm2 that the api has started.
+    // PM2 documents this as Graceful Start or Clean Restart.
+    // See https://pm2.keymetrics.io/docs/usage/signals-clean-restart/
     if (process.send) {
         process.send('ready');
     }