diff --git a/docs/reference/options.md b/docs/reference/options.md index 3f38de331..4a91f08be 100644 --- a/docs/reference/options.md +++ b/docs/reference/options.md @@ -30795,7 +30795,7 @@ lazy attribute set of (null or package) -## process.after +## process.manager.after @@ -30816,125 +30816,95 @@ strings concatenated with “\\n” -## process.before +## process.manager.args -Bash code to execute before starting processes. +Additional arguments to pass to the process manager. *Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` +attribute set *Declared by:* - [https://github.com/cachix/devenv/blob/main/src/modules/processes.nix](https://github.com/cachix/devenv/blob/main/src/modules/processes.nix) -## process.implementation +## process.manager.before -The implementation used when performing ` devenv up `. +Bash code to execute before starting processes. *Type:* -one of “honcho”, “overmind”, “process-compose”, “hivemind” +strings concatenated with “\\n” *Default:* -` "process-compose" ` - - - -*Example:* -` "overmind" ` +` "" ` *Declared by:* - [https://github.com/cachix/devenv/blob/main/src/modules/processes.nix](https://github.com/cachix/devenv/blob/main/src/modules/processes.nix) -## process.process-compose +## process.manager.implementation -Top-level process-compose.yaml options when that implementation is used. +The process manager to use when running processes with ` devenv up `. *Type:* -attribute set +one of “hivemind”, “honcho”, “overmind”, “process-compose” *Default:* - -``` -{ - version = "0.5"; - unix-socket = "${config.devenv.runtime}/pc.sock"; - tui = true; -} - -``` +` "process-compose" ` *Example:* - -``` -{ - log_level = "fatal"; - log_location = "/path/to/combined/output/logfile.log"; - version = "0.5"; -} -``` +` "overmind" ` *Declared by:* - [https://github.com/cachix/devenv/blob/main/src/modules/processes.nix](https://github.com/cachix/devenv/blob/main/src/modules/processes.nix) -## process-managers.hivemind.enable +## process.managers.hivemind.package -Whether to enable hivemind as process-manager. +The hivemind package to use. *Type:* -boolean +package *Default:* -` false ` - - - -*Example:* -` true ` +` pkgs.hivemind ` *Declared by:* - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix) -## process-managers.hivemind.package +## process.managers.honcho.package -The hivemind package to use. +The honcho package to use. @@ -30944,44 +30914,39 @@ package *Default:* -` pkgs.hivemind ` +` pkgs.honcho ` *Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix) + - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix) -## process-managers.honcho.enable +## process.managers.overmind.package -Whether to enable honcho as process-manager. +The overmind package to use. *Type:* -boolean +package *Default:* -` false ` - - - -*Example:* -` true ` +` pkgs.overmind ` *Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix) + - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix) -## process-managers.honcho.package +## process.managers.process-compose.package -The honcho package to use. +The process-compose package to use. @@ -30991,65 +30956,86 @@ package *Default:* -` pkgs.honcho ` +` pkgs.process-compose ` *Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix) + - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix) -## process-managers.overmind.enable +## process.managers.process-compose.port -Whether to enable overmind as process-manager. +The port to bind the process-compose server to. + +Not used when ` unixSocket.enable ` is true. *Type:* -boolean +signed integer *Default:* -` false ` - - - -*Example:* -` true ` +` 8080 ` *Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix) + - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix) -## process-managers.overmind.package +## process.managers.process-compose.settings -The overmind package to use. +Top-level process-compose.yaml options + +Example: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml\` *Type:* -package +YAML value *Default:* -` pkgs.overmind ` +` { } ` + + + +*Example:* + +``` +{ + availability = { + backoff_seconds = 2; + max_restarts = 5; + restart = "on_failure"; + }; + depends_on = { + some-other-process = { + condition = "process_completed_successfully"; + }; + }; + environment = [ + "ENVVAR_FOR_THIS_PROCESS_ONLY=foobar" + ]; +} +``` *Declared by:* - - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix) + - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix) -## process-managers.process-compose.enable +## process.managers.process-compose.tui.enable -Whether to enable process-compose as process-manager. +Enable the TUI @@ -31059,11 +31045,6 @@ boolean *Default:* -` false ` - - - -*Example:* ` true ` *Declared by:* @@ -31071,66 +31052,47 @@ boolean -## process-managers.process-compose.package +## process.managers.process-compose.unixSocket.enable -The process-compose package to use. +Whether to enable running the process-compose server over unix domain sockets instead of tcp. *Type:* -package +boolean *Default:* -` pkgs.process-compose ` +` true ` + + + +*Example:* +` true ` *Declared by:* - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix) -## process-managers.process-compose.settings +## process.managers.process-compose.unixSocket.path -process-compose.yaml specific process attributes. - -Example: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml\` +Override the path to the unix socket. *Type:* -YAML value +null or string *Default:* -` { } ` - - - -*Example:* - -``` -{ - availability = { - backoff_seconds = 2; - max_restarts = 5; - restart = "on_failure"; - }; - depends_on = { - some-other-process = { - condition = "process_completed_successfully"; - }; - }; - environment = [ - "ENVVAR_FOR_THIS_PROCESS_ONLY=foobar" - ]; -} -``` +` ${config.devenv.runtime}/pc.sock ` *Declared by:* - [https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix](https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix) @@ -31141,7 +31103,7 @@ YAML value -Processes can be started with ` devenv up ` and run in foreground mode. +Processes can be started with ` devenv up ` and run in the foreground. @@ -31182,7 +31144,7 @@ process-compose.yaml specific process attributes. Example: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml\` -Only used when using ` process.implementation = "process-compose"; ` +Only used when using ` process.manager.implementation = "process-compose"; `