Skip to content

docs: clarify that prep-cmds fire on app start/termination, not client connect/disconnect #5562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cttech-io wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −0
Open

docs: clarify that prep-cmds fire on app start/termination, not client connect/disconnect #5562

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,14 @@ editing the `conf` file in a text editor. Use the examples as reference.
<td colspan="2">
A list of commands to be run before/after all applications.
If any of the prep-commands fail, starting the application is aborted.
@note{These run when the application <b>starts</b> and <b>terminates</b>, which is not
the same as a client connecting and disconnecting. Disconnecting does not terminate the
application - the session is kept alive so the client can resume - so <code>undo</code>
runs only on actual termination (quitting from the client, stopping it in the Web UI, or
Sunshine shutting down). Reconnecting resumes that session rather than launching the
application again, so <code>do</code> does not run on a reconnect either. Prep-commands
that change machine state needed by every stream, such as display layout or audio
routing, will therefore not be reapplied when a client resumes an existing session.}
</td>
</tr>
<tr>
Expand Down