[APP] - Steerhouse

Đang mở Phù hợp với người mới
#1,064 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
82/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
php
Lĩnh vực
api

Hướng nghiên cứu

Issue này đặc tả đầy đủ một app Heimdall mới: hãy đọc docs/interfaces.md của Steerhouse cho endpoint GET /api/stats, và sao chép mẫu của một app nâng cao hiện có với API key dạng bearer token (ví dụ Tracearr cho toggle skip-TLS). Thêm class của app vào repo Heimdall-Apps, triển khai tile Run / Queue / Failed từ các số đếm được trả về, và xác minh bằng testRunner, php -l (8.2) và PHPCS PSR-12. Hoàn thành nghĩa là tile hiển thị số đếm chính xác, chuyển sang trạng thái active trong lúc chạy, và báo thông tin xác thực không hợp lệ khi key sai.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
PHP
Star
326
Fork
337
Merge trung bình
4 phút
Pull request đã merge (30 ngày)
3

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của linuxserver/Heimdall-Apps

Tất cả issue của linuxserver/Heimdall-Apps

Issue tương tự

Thêm issue về PHP

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.