Repository navigation
docs(hermes-webui): document skills canonical-location requirement - #90
Merged
Merged
Conversation
The WebUI's /api/skills 500s when HERMES_HOME_HOST_PATH/skills/ is a symlink to a path outside the bind mount, because the symlink target is unreachable from the container's filesystem. Upstream webui code (in api/routes.py _skills_list_from_dir) treats the broken-symlink case as 'create the directory' and crashes on mkdir with FileExistsError because the symlink itself exists. This is a deployment-shape constraint, not an upstream bug worth filing — upstream is moving toward rejecting symlinked paths on write (PRs #5414/#5415/#5416), so the runtime contract is: skills live at ~/.hermes/skills/ as a real directory. Users who want version control initialize a git repo at ~/.hermes/ itself; the existing .gitignore already excludes caches, sessions, secrets, and runtime state. No source change to hermes-webui; runtime-config docs only.
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.
Summary
Document the runtime-config requirement that
HERMES_HOME_HOST_PATH/skills/must be a real directory inside the bind mount, not a symlink to a path outside it. The WebUI's/api/skillsenumerates skills by walking~/.hermes/skills/from inside the container; if that path is a symlink pointing outside the bind mount, the container can't resolve it and_skills_list_from_dir500s withFileExistsError [Errno 17]frommkdir().Why docs-only
What this PR changes
Adds a new
### Skills directory layoutsection toapps/hermes-webui/metadata/description.mdcovering:get_hermes_home() / "skills"in both hermes-agent and hermes-webui).~/.hermes/itself; the existing.gitignorealready excludes caches, sessions, secrets, and runtime state.Verification
bun test(perCLAUDE.md) passes 126/126. This change is metadata-only and doesn't touchdocker-compose.jsonorconfig.json, so no schema validation impact.Test plan
Deploy this app store update on a fresh Runtipi install with
~/.hermes/skillsas either a real directory or a symlink to a path inside the bind mount — both should boot cleanly. A symlink to a path outside the bind mount will reproduce the original/api/skills500 (documented as the constraint to avoid).