Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.DS_Store
__pycache__/
*.pyc
.pytest_cache/
.validation-output/
12 changes: 10 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

## Unreleased — targeting v0.1.0

- Added a `Changes` field to the template so Community Apps shows a changelog
to users who already installed the app.
- Project status now lives in one place, the top of `docs/RELEASE-REVIEW.md`.
Other documents link to it. Removed internal review narrative and stale test
and file counts from the public documentation.
- The publication inventory test now reads Git's file list, so `pytest` caches
and other ignored files no longer fail it. Tests check document structure and
links rather than exact status sentences.
- Added a PNG export of the existing community artwork and switched template/profile
icon URLs to PNG for Docker Manager compatibility. Original SVG preserved.
- Changed the default host WebUI/API port to `6969` for CPU, CUDA 12 and CUDA 13
Expand Down Expand Up @@ -38,8 +46,8 @@
- Prepared least-privilege, commit-pinned GitHub Actions CI, Dependabot action
updates, contribution/security guidance and a standalone Git publishing checklist.
- September 13: published the approved GitHub review draft with a clean signed
history and noreply commit identity. First hosted CI passed all 25 checks;
public links/file hashes and recorded repository security settings verified.
history and noreply commit identity. First hosted CI passed. Public links,
file hashes and recorded repository security settings verified.

No public versioned release has been made; the GitHub repository is a review draft.
Version numbers describe the Unraid integration,
Expand Down
9 changes: 3 additions & 6 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Security

This integration is beta, with no versioned stable release yet. Once released,
maintenance will focus on the current integration template; it does not provide
maintenance will focus on the current integration template. It does not provide
security maintenance for upstream images, dependencies, models or Unraid itself.

The application port exposes unauthenticated UI/API management. Keep it on trusted
Expand All @@ -11,11 +11,8 @@ and GPU access are described in the [README](README.md#security).
Do not post credentials, private audio or exploitable vulnerability details in
public issues. Use the repository's
**Security → Advisories → Report a vulnerability** option for sensitive integration
reports. Private vulnerability reporting was enabled and verified through
GitHub's API on September 13, 2026; the advisories page is live. See the
[publication checklist](docs/PUBLISHING.md).
If it is unavailable, request a private reporting channel in a public issue
reports. If it is unavailable, request a private reporting channel in a public issue
without including sensitive details. Follow upstream's own reporting policy for
vulnerabilities in audio.cpp; do not assume this integration can fix them.
vulnerabilities in audio.cpp. Do not assume this integration can fix them.

No response-time guarantee or independent security certification is offered.
46 changes: 22 additions & 24 deletions docs/MAINTAINER.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,19 @@ status tracker; detailed experiment reports remain in this docs directory.

## Validation and submission context

**Status: beta integration, targeting v0.1.0; full deployment acceptance pending.**
CPU, CUDA 12 and CUDA 13 have passed isolated Pocket TTS testing on one Unraid
host. Native Docker `--user=99:100` resolved the initial model-folder permission
failure. The [September 12 CPU retest](CPU-RETEST-20260912.md) passed short-text,
streaming and restart checks using a fixed official image; the owner also confirmed
playback. Controlled CUDA 13 recreation, image update and rollback passed within
their documented scope. These are not full Community Apps release acceptance.
See the [current release review](RELEASE-REVIEW.md) for completed checks,
remaining gates and the exact proposed repository contents.
The selected repository destination is `lozenge0/audio-cpp-unraid`, with GitHub
Issues as the integration support destination. The owner reports completing the
Community Apps submission and receiving automatic approval. Catalog visibility
and installation through the public listing are not yet verified. Portal approval
does not establish runtime compatibility. See the release review for current status.

The template requests both **AI** and **Tools** categories. Catalog placement
depends on CA processing the updated template; it has not yet been confirmed live.
The current submission state, completed evidence and remaining gates live in
[the release review](RELEASE-REVIEW.md). Do not repeat that status here.

CPU, CUDA 12 and CUDA 13 passed isolated Pocket TTS testing on one
Unraid host. Native Docker `--user=99:100` resolved the initial model-folder
permission failure. The [September 12 CPU retest](CPU-RETEST-20260912.md) passed
short-text, streaming and restart checks on a fixed official image. Controlled
CUDA 13 recreation, image update and rollback passed within their documented
scope. These are not full Community Apps release acceptance, and portal approval
does not establish runtime compatibility.

The repository is `lozenge0/audio-cpp-unraid`, with GitHub Issues for support.
The template requests both **AI** and **Tools** categories.

## Scope and layout

Expand Down Expand Up @@ -63,17 +59,20 @@ Follow [the release review](RELEASE-REVIEW.md) and
The GitHub Actions workflow runs these tests on pushes, pull requests
and manual dispatch, with no custom secrets, image builds or server access.
Dependabot proposes CI action updates for review, not container updates.
The [first hosted run](https://github.com/lozenge0/audio-cpp-unraid/actions/runs/34725657862)
passed all 25 checks. See [contribution guidance](../CONTRIBUTING.md) and
See [contribution guidance](../CONTRIBUTING.md) and
[security reporting](../SECURITY.md).

The public repository and hosted CI are verified, and the owner reports CA
auto-approval. Next verify catalog visibility and the public branch-selection/install
flow, review tested images and complete or explicitly defer outstanding lifecycle
Next verify catalog visibility and the public branch-selection/install flow,
review tested images and complete or explicitly defer outstanding lifecycle
checks. Rerun CA Validate/Scan after meaningful XML changes. Follow the
[GitHub publishing checklist](PUBLISHING.md). Never publish the surrounding
audio.cpp checkout. Portal approval is not full deployment acceptance.

When a template change affects installed users, add a dated entry to the
`Changes` field in `templates/audio-cpp.xml`. Community Apps shows that field
as the app changelog. Docker Manager does not refresh installed templates, so
the entry must say what an existing user needs to change by hand.

## Primary references

- [Upstream Docker guide](https://github.com/0xShug0/audio.cpp/blob/main/docs/docker.md)
Expand All @@ -93,5 +92,4 @@ and tests, not upstream software, third-party dependencies or model weights.
The icon is separately dedicated under CC0 1.0 Universal, to the extent the owner
holds applicable rights; see [artwork provenance and terms](../assets/README.md).
The owner approved these choices and subsequent GitHub draft publication on
2026-09-12. The owner subsequently completed the CA submission and reported
auto-approval. No versioned integration release has been created.
2026-09-12.
11 changes: 5 additions & 6 deletions docs/PLAN.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,9 @@

## Current publication status

The standalone GitHub repository and CI are live. The owner reports CA submission
and auto-approval; catalog visibility and public installation remain unverified.
The beta template requests AI and Tools categories. See RELEASE-REVIEW.md for the
current evidence and remaining checks. No production migration has been performed.
See the status section at the top of [the release review](RELEASE-REVIEW.md).
That file is the single source for submission state, evidence and remaining
checks. No production migration took place.

## Runtime progress recorded on 2026-09-12

Expand Down Expand Up @@ -76,8 +75,8 @@ passed; actual CA rendering and full deployment acceptance remain pending.

## Stage 4 — Community Apps submission

The owner reports automatic approval. Confirm catalog visibility and review
Validate/Scan results; rerun those checks after meaningful XML changes. Do not
Confirm catalog visibility and review Validate/Scan results. Rerun those checks
after meaningful XML changes. Do not
create a duplicate submission because the listing is not yet visible. Preserve
tested-combination limits, maintenance/support boundaries and rollback guidance.

Expand Down
7 changes: 3 additions & 4 deletions docs/PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,9 @@ Approved initialization procedure:
do not overwrite an existing repository or auto-add competing licence/README
files. Verify the remote before pushing `main`. Do not force-push.

The draft was published on September 13 (Europe/London); publication checks are
recorded in RELEASE-REVIEW.md. The owner subsequently reported CA auto-approval.
Keep the beta label and outstanding validation limits visible. No versioned
integration release has been created; catalog visibility still needs confirmation.
The draft was published on September 13 (Europe/London). Publication checks and
the current project status are recorded in [the release review](RELEASE-REVIEW.md).
Keep the beta label and outstanding validation limits visible.

## CI and repository settings

Expand Down
Loading