docs(heimdall): the install recipe, from having actually installed it - #293
Conversation
The submission notes were written before anyone had run this. Installing it
on a live Heimdall 2.8.1 corrected three claims and produced a recipe worth
keeping.
The appid is NOT issued by Heimdall. It is sha1(lowercase app name) --
verified against CashPilot's own app.json and against Grafana, Vaultwarden
and Home Assistant. That matters because it means the package can be
assembled and tested locally BEFORE anything is sent upstream, which is
how the rest of this section came to exist.
A hand-installed app persists. Both paths Heimdall loads from are symlinks
into the config bind mount, so it survives a container update -- the
opposite of what I assumed.
The trap worth documenting: ItemController::getStats catches every
exception and returns {"status":"inactive","html":""}. A broken app looks
merely IDLE, never broken, so verifying by reading the HTTP response alone
reads a silent failure as a pass. The log has to be checked too.
Smaller things that cost time: the blades must sit beside the PHP class
(the view namespace is registered to app_path('SupportedApps')), ownership
must be numeric because `chown abc:users` fails on an unRAID host, and
sqlite3 is not in the container.
Also records the em-dash rule as exercised against the installed class,
including the row that makes the table mean something: a genuine zero
renders "$0.00" while an unread one renders a dash, from the same 0.
Drops the note saying CashPilot has no read-only token -- it does now, and
that is the key this tile should use.
|
Warning Review limit reached
Next review available in: 47 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@coderabbitai review |
|
1 participant
The submission notes were written before anyone had run this. Installing it on a live Heimdall 2.8.1 corrected three claims and produced a recipe worth keeping.
Three things this file got wrong
The
appidis not issued by Heimdall. It issha1(lowercase app name):Same relation holds for Grafana, Vaultwarden and Home Assistant. This matters because it means the package can be assembled and tested before anything is sent upstream — which is how the rest of this section came to exist.
A hand-installed app persists. Both paths Heimdall loads from are symlinks into the config bind mount, so it survives a container update — the opposite of what I had assumed.
CashPilot now has a read-only token (#291), so the note apologising for its absence is gone. That is the key this tile should use.
The trap worth documenting
ItemController::getStatscatches every exception and returns{"status":"inactive","html":""}. A broken app therefore looks merely idle, never broken. Verifying an install by reading the HTTP response alone reads a silent failure as a pass — the log has to be checked too. Mine was empty, which is the part that made the live result trustworthy.Smaller things that cost time
app_path('SupportedApps'). Enhanced apps ship blades, non-enhanced ones don't, so a file listing from the wrong app misleads.chown abc:usersfails on an unRAID host because that user exists only inside the container.sqlite3is not in the container; usephp -rwith PDO.The rule, exercised against the installed class
has_readings:true, total_adjusted:66.61, active_services:43$66.6143has_readings:false, total_adjusted:043active_services:null$66.61has_readings:true, total_adjusted:0, active_services:0$0.000The last row is the one that makes the table mean anything: it carries the same
0as the second and renders differently, proving the dash followshas_readingsrather than the number. Without it the table would also pass against a tile that simply dashed every zero.Docs only — no code paths touched.
Closes CashPilot-76xy.