Add description for log ready option.

Platonic-Systems · Jun 7, 2024 · fdaa978 · fdaa978
1 parent 17f8bab
commit fdaa978
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/nix/process-compose/settings/process.nix b/nix/process-compose/settings/process.nix
@@ -143,6 +143,12 @@ in
       type = types.nullOr types.str;
       default = null;
       example = "process is ready";
+      description = ''
+        A string to search for in the output of the command that indicates
+        the process is ready. String will be part of a regex '.*{ready_log_line}.*'.
+        This should be used for long running processes that do not have a
+        readily accessible check for http or similar other checks.
+      '';
     };
 
     namespace = mkOption {