[APP] - Steerhouse

Aperta Adatta ai principianti
#1,064 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
php
Ambito
api

Direzione di ricerca

L'issue specifica completamente una nuova app Heimdall: leggi il file docs/interfaces.md di Steerhouse per l'endpoint GET /api/stats e copia il pattern di un'app potenziata esistente con una API key bearer-token (ad esempio Tracearr per il toggle skip-TLS). Aggiungi la classe dell'app nel repo Heimdall-Apps, implementa il tile Run / Queue / Failed a partire dai conteggi restituiti e verifica con testRunner, php -l (8.2) e PHPCS PSR-12. Fatto significa che il tile mostra i conteggi corretti, diventa attivo durante le esecuzioni e segnala credenziali non valide per una chiave errata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
PHP
Stelle
326
Fork
337
Merge medio
4m
PR unite (30g)
3

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di linuxserver/Heimdall-Apps

Tutte le issue di linuxserver/Heimdall-Apps

Issue simili

Altre issue su PHP

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.