Repository navigation
Report a missing docker executable clearly and add error codes to config flow errors - #98
Merged
Merged
Conversation
Co-authored-by: gensyn <36128035+gensyn@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Improve user-friendliness of docker error messages
Report a missing docker executable clearly and add error codes to config flow errors
Oct 23, 2026
Co-authored-by: gensyn <36128035+gensyn@users.noreply.github.com>
Co-authored-by: gensyn <36128035+gensyn@users.noreply.github.com>
Co-authored-by: gensyn <36128035+gensyn@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The known-hosts filename heuristic can misclassify missing files and display incorrect recovery instructions.
1 open issue
What changed in this PR
This PR improves SSH Docker setup diagnostics for missing Docker executables, addressing the NAS troubleshooting scenario in #97, and introduces stable error codes.
Changes:
- Distinguishes exit status 127 and adds missing known-hosts file handling.
- Adds E001–E010 codes and troubleshooting guidance to English and German flow messages.
- Documents error codes and corrects the Custom Executables link.
| File | Description |
|---|---|
| translations/en.json | Adds coded English errors and recovery guidance. |
| translations/de.json | Adds matching German errors and guidance. |
| strings.json | Updates source flow messages with error codes. |
| README.md | Documents error codes and fixes an internal link. |
| options_flow.py | Handles missing executables and known-hosts files. |
Review effort: Balanced
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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
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.

Adding a container fails with the generic "docker command failed (exit status 1)" when the
dockerbinary isn't on thePATHof non-interactive SSH sessions, as on QNAP and Synology NAS devices. The user gets no hint about the cause or the fix. This PR makes that case explicit and gives each config/options flow error a stable code.Missing executable detection (
options_flow.py)docker_command_not_founderror when<docker_command> ps -qexits with status 127 (shell "command not found").docker_command_failed.Error messages (
strings.json,translations/en.json,translations/de.json)docker_command_not_foundtells the user to enter an absolute path such as/usr/bin/docker, or to add docker to thePATHof non-interactive SSH sessions.docker_command_failedis reworded to point at the command and the user's permission to run it.[E001]to[E009], so users can quote it in bug reports. The German translations are updated to match.Docs (
README.md)/usr/bin.Example of the new flow error:
Only config/options flow errors were changed. Abort messages and service exception messages are untouched. No new unit tests cover the exit-status-127 path.