[APP] - Steerhouse

未关闭 适合新手
#1,064 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
82/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
php
领域
api

调研方向

该 issue 完整规定了一个新的 Heimdall 应用:阅读 Steerhouse 的 docs/interfaces.md 了解 GET /api/stats 端点,并照搬一个现有的带 bearer token API key 的增强应用的模式(例如 Tracearr 的 skip-TLS 开关)。在 Heimdall-Apps 仓库中添加该应用类,根据返回的计数实现 Run / Queue / Failed 磁贴,并使用 testRunner、php -l(8.2)和 PHPCS PSR-12 进行验证。完成的标准是:磁贴显示正确的计数,在运行期间变为活跃状态,并且对错误的 key 报告凭据无效。

由索引模型根据 Issue 内容生成。

描述

app-request request-valid
App name

Steerhouse

Website

https://github.com/HoneyBearTech/Steerhouse

License

MIT License

Tile background

dark

Icon

steerhouse.svg

Description

Adds Steerhouse (https://github.com/HoneyBearTech/Steerhouse), a self-hosted web UI and API for
running Ansible playbooks, as an enhanced app.

  • Endpoint: GET /api/stats, documented in Steerhouse's docs/interfaces.md. It returns counts only:
    queued, running, succeeded_24h, failed_24h, workers_online.
  • Auth: Authorization: Bearer . Steerhouse has a "stats" key preset that can read these
    counts and nothing else; the config field is a password input.
  • Tile: Run / Queue / Failed (failed and timed-out runs in the last 24 hours). Status is "active"
    while runs are queued or running (5 s refresh), otherwise 30 s.
  • Optional "Skip TLS verification" toggle, as in Tracearr.

Test plan: tested against a self-hosted Steerhouse in linuxserver/heimdall. Test says "Successfully
communicated with the API" with a valid key and "Failed: Invalid credentials" with a wrong one; the
tile's numbers match the API, it is active while a run is in progress and inactive otherwise, and a
revoked key leaves it at zero without errors. testRunner, the unit tests, php -l (8.2) and PHPCS
PSR-12 pass.

I intend to build this as an Enhanced app myself
  • Yes, I plan to add Enhanced support in a follow-up
主要语言
PHP
星标
326
派生
337
平均合并
4 分钟
30 天内合并 PR
3

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

linuxserver/Heimdall-Apps 的其他 Issue

查看 linuxserver/Heimdall-Apps 的全部 Issue

相似的 Issue

更多 PHP Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。