docs: document env vars for notify-send hooks in detached sessions#3531
Merged
Conversation
The desktop notifications tip did not mention that notify-send needs DISPLAY and DBUS_SESSION_BUS_ADDRESS when docker-agent runs outside a desktop terminal (SSH, detached tmux, containers), where the hook fails silently. Add an example using the per-hook env option. Also correct the sound_threshold sentence: the failure sound plays immediately on error, the threshold only gates the success sound.
dgageot
approved these changes
Jul 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The "Get Desktop Notifications with Hooks" tip did not mention the environment variables
notify-sendneeds outside a desktop terminal, and misstated whensound_thresholdapplies.Changes
envoption withDISPLAYandDBUS_SESSION_BUS_ADDRESSfor detached contexts (SSH, tmux started outside the desktop session, containers), where the notification is otherwise dropped silentlysound_threshold(default 10s) only gates the success sound (seepkg/tui/page/chat/runtime_events.go)env,working_dir,timeout) documented in the hooks referenceNotes
pkg/hooks/handler.go); docker-agent injects no env vars into hooks, the payload arrives via stdin JSON. The per-hookenvoption is the supported way to provide missing session variables.envplacement in the example matches theHookDefinitionschema inagent-schema.json.Validation