[APP] - Steerhouse

Abierto Apto para principiantes
#1,064 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
php
Área
api

Línea de trabajo

El issue especifica por completo una nueva app de Heimdall: lee docs/interfaces.md de Steerhouse para el endpoint GET /api/stats y copia el patrón de una app mejorada existente con una API key de bearer token (por ejemplo, Tracearr para el toggle de skip-TLS). Añade la clase de la app en el repositorio Heimdall-Apps, implementa el tile Run / Queue / Failed a partir de los conteos devueltos y verifica con testRunner, php -l (8.2) y PHPCS PSR-12. Terminado significa que el tile muestra los conteos correctos, se activa durante las ejecuciones y reporta credenciales inválidas con una clave incorrecta.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
PHP
Estrellas
326
Forks
337
Merge medio
4 min
PR fusionados (30 d)
3

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de linuxserver/Heimdall-Apps

Todos los issues de linuxserver/Heimdall-Apps

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.