[APP] - USAS

オープン
#1,068 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
38/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
ansible, php
領域
full-stack

調査の方向性

Start by reading the existing app definitions and the repository’s contribution guidance to find how enhanced apps declare configuration, API requests, and tile fields. Implement the USAS app using the issue’s GET /api/status endpoint and bearer token details. Done means the config accepts the token securely and the tile displays Run, VMs, and New with the described refresh behavior; validate against the test plan in the issue.

索引モデルが issue の本文から書いたものです。

説明

app-request request-valid
App name

USAS

Website

https://github.com/HoneyBearTech/ubuntu-server-auto-setup

License

MIT License

Tile background

dark

Icon

usas.svg

Description

Adds USAS (https://github.com/HoneyBearTech/ubuntu-server-auto-setup), a self-hosted web UI and set of
Ansible playbooks that install Ubuntu Server on new Proxmox VE VMs unattended and apply a hardened
baseline, as an enhanced app.

  • Endpoint: GET /api/status, documented in USAS's docs/interfaces.md ("The status API"). It returns a
    short summary only: the running run's playbook, the last run's playbook and result, the inventory's
    servers still to install, and the cluster's running/total VMs. It never holds host, node, cluster or
    VM names, addresses, VM IDs, logs or secrets.
  • Auth: Authorization: Bearer . The API is off (404) until the token is made in USAS on
    the Account page, under "Status for dashboards"; the token can read this summary and nothing else.
    The config field is a password input.
  • Tile: Run / VMs / New. "Run" shows the last run's result (OK, Failed, Stopped), or "Now" with the
    playbook while a run is going. Status is "active" while a run is in progress (5 s refresh),
    otherwise 30 s. Unknown values in the answer are ignored, so the tile only ever shows its own labels.

Test plan: tested against a self-hosted USAS (v0.6.0) in linuxserver/heimdall (2.8.3). Test says
"Successfully communicated with the API" with a valid token; the tile showed "Run OK, VMs 10/11, New 2",
and "Now Install" during a provisioning run.

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分
マージ済み PR(30日)
3

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

linuxserver/Heimdall-Apps のほかの issue

linuxserver/Heimdall-Apps の issue をすべて見る

似ている issue

PHP の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。