Skip to content

Commit

Permalink
Document foreground processes
Browse files Browse the repository at this point in the history
  • Loading branch information
F1bonacc1 committed Dec 8, 2023
1 parent 2b5c7e8 commit 576a6b8
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Process Compose is a simple and flexible scheduler and orchestrator to manage no
- Merge Configuration Files
- Namespaces
- Run Multiple Replicas of a Process
- Run Foreground Process

It is heavily inspired by [docker-compose](https://github.com/docker/compose), but without the need for containers. The configuration syntax tries to follow the docker-compose specifications, with a few minor additions and lots of subtractions.

Expand Down
1 change: 1 addition & 0 deletions www/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ Because sometimes you just don't want to deal with docker files, volume definiti
- Merge Configuration Files
- Namespaces
- Run Multiple Replicas of a Process
- Run Foreground Process
17 changes: 16 additions & 1 deletion www/docs/launcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,21 @@ processes:

3. Daemon processes can only be stopped with the `$PROCESSNAME.shutdown.command` as in the example above.

## Foreground Processes

```yaml hl_lines="4"
processes:
vim:
command: "vim process-compose.yaml"
is_foreground: true
```
Foreground processes are useful for cases when a full `tty` access is required (e.g. `vim`, `top`, `gdb -tui`)

1. Foreground process have to be started manually (`F7`). They can be started multiple times.
2. They are available in TUI mode only.
3. To return to TUI, exit the foreground process.
4. In [TUI Client](client.md#tui-client) mode, a local process will be started.

## Disabled Processes

Process execution can be disabled:
Expand All @@ -183,7 +198,7 @@ processes:
disabled: true #default false
```

Even if disabled, it is still listed in the TUI and the REST client can be started manually when needed.
Even if disabled, the process is still listed in the TUI and the REST client, and can be started manually when needed.

## Auto Restart on Exit

Expand Down

0 comments on commit 576a6b8

Please sign in to comment.