From 07437878f1135b29537fedefadc315433ca3dc69 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 10 Sep 2024 10:57:38 +0000 Subject: [PATCH] Auto generate docs and examples --- docs/supported-process-managers/hivemind.md | 25 +----- docs/supported-process-managers/honcho.md | 25 +----- docs/supported-process-managers/overmind.md | 25 +----- .../process-compose.md | 84 +++++++++++++++---- 4 files changed, 73 insertions(+), 86 deletions(-) diff --git a/docs/supported-process-managers/hivemind.md b/docs/supported-process-managers/hivemind.md index a47fabeca..22002682e 100644 --- a/docs/supported-process-managers/hivemind.md +++ b/docs/supported-process-managers/hivemind.md @@ -3,30 +3,7 @@ [comment]: # (Please add your documentation on top of this line) -## process-managers\.hivemind\.enable - -Whether to enable hivemind as process-manager\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - - - -## process-managers\.hivemind\.package - - +## process\.managers\.hivemind\.package The hivemind package to use\. diff --git a/docs/supported-process-managers/honcho.md b/docs/supported-process-managers/honcho.md index dc6d2b690..f5832f9d6 100644 --- a/docs/supported-process-managers/honcho.md +++ b/docs/supported-process-managers/honcho.md @@ -3,30 +3,7 @@ [comment]: # (Please add your documentation on top of this line) -## process-managers\.honcho\.enable - -Whether to enable honcho as process-manager\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - - - -## process-managers\.honcho\.package - - +## process\.managers\.honcho\.package The honcho package to use\. diff --git a/docs/supported-process-managers/overmind.md b/docs/supported-process-managers/overmind.md index a59e792d4..0001de686 100644 --- a/docs/supported-process-managers/overmind.md +++ b/docs/supported-process-managers/overmind.md @@ -3,30 +3,7 @@ [comment]: # (Please add your documentation on top of this line) -## process-managers\.overmind\.enable - -Whether to enable overmind as process-manager\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - - - -## process-managers\.overmind\.package - - +## process\.managers\.overmind\.package The overmind package to use\. diff --git a/docs/supported-process-managers/process-compose.md b/docs/supported-process-managers/process-compose.md index 221149741..8867e831a 100644 --- a/docs/supported-process-managers/process-compose.md +++ b/docs/supported-process-managers/process-compose.md @@ -3,50 +3,47 @@ [comment]: # (Please add your documentation on top of this line) -## process-managers\.process-compose\.enable +## process\.managers\.process-compose\.package -Whether to enable process-compose as process-manager\. +The process-compose package to use\. *Type:* -boolean +package *Default:* -` false ` - - +` pkgs.process-compose ` -*Example:* -` true ` +## process\.managers\.process-compose\.port -## process-managers\.process-compose\.package +The port to bind the process-compose server to\. -The process-compose package to use\. +Not used when ` unixSocket.enable ` is true\. *Type:* -package +signed integer *Default:* -` pkgs.process-compose ` +` 8080 ` -## process-managers\.process-compose\.settings +## process\.managers\.process-compose\.settings -process-compose\.yaml specific process attributes\. +Top-level process-compose\.yaml options Example: https://github\.com/F1bonacc1/process-compose/blob/main/process-compose\.yaml\` @@ -81,3 +78,62 @@ YAML value ]; } ``` + + + +## process\.managers\.process-compose\.tui\.enable + + + +Enable the TUI + + + +*Type:* +boolean + + + +*Default:* +` true ` + + + +## process\.managers\.process-compose\.unixSocket\.enable + + + +Whether to enable running the process-compose server over unix domain sockets instead of tcp\. + + + +*Type:* +boolean + + + +*Default:* +` true ` + + + +*Example:* +` true ` + + + +## process\.managers\.process-compose\.unixSocket\.path + + + +Override the path to the unix socket\. + + + +*Type:* +null or string + + + +*Default:* +` ${config.devenv.runtime}/pc.sock `