Skip to content

fix(template): prefer Docker Hub image metadata #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JSONbored merged 1 commit into from
May 1, 2026
Merged

fix(template): prefer Docker Hub image metadata #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Unraid AIO Template

A hardened starter for future `*-aio` repositories: one public repo per app, one companion GHCR image, one Unraid CA XML, and one beginner-first experience that still leaves room for power-user overrides.
A hardened starter for future `*-aio` repositories: one public repo per app, one Docker Hub-facing image, one Unraid CA XML, and one beginner-first experience that still leaves room for power-user overrides.

This template is opinionated on purpose. It is built for repos that should be:

Expand Down
2 changes: 1 addition & 1 deletion docs/release-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
- verify first boot works with defaults
- verify advanced settings stay optional
- verify generated credentials persist if applicable
- confirm GHCR package is public and pullable
- confirm the Docker Hub image is public and pullable
- confirm `awesome-unraid` contains the XML and icon
- confirm the README first-run notes match the real install behavior
- if using release tags, confirm version tags such as `v1.2.3` publish the expected image tags
Expand Down
6 changes: 3 additions & 3 deletions docs/repo-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Apply these to every derived repo before it becomes public.
- Disable Wikis and Projects unless you actively use them
- Add a social preview image before the repo goes public
- Set a clear About description and relevant GitHub topics
- Mark the GHCR package public only after the first successful publish
- Confirm the Docker Hub repository is public and pullable after the first successful publish
- Make sure the repo description clearly reflects the wrapped upstream app

## Branch Protection
Expand Down Expand Up @@ -53,8 +53,8 @@ Suggested required checks:

## Packages

- After the first successful publish, make the GHCR package public if the repo is public
- Verify the package name matches the intended CA XML repository value
- After the first successful publish, verify the Docker Hub repository is public if the repo is public
- Verify the Docker Hub image name matches the intended CA XML repository value

## Secrets and Variables

Expand Down
4 changes: 2 additions & 2 deletions template-aio.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?xml version="1.0"?>
<Container version="2">
<Name>yourapp-aio</Name>
<Repository>ghcr.io/jsonbored/yourapp-aio:latest</Repository>
<Registry>https://ghcr.io/jsonbored/yourapp-aio</Registry>
<Repository>jsonbored/yourapp-aio:latest</Repository>
<Registry>https://hub.docker.com/r/jsonbored/yourapp-aio</Registry>
<Network>bridge</Network>
<MyIP/>
<Shell>sh</Shell>
Expand Down
Loading