Unraid Community Apps
Community Apps
XML Field Reference
Public XML fields supported by the Community Apps submission parser. Generated from the parser-side field catalog.
This page is generated from the parser-side XML field catalog in server/appfeed/parsers/template-xml-field-spec.json.
Only fields marked public are listed here. Internal and moderation-only parser fields are intentionally omitted so submit docs do not leak private implementation details.
Maintainer note:
- Update
server/appfeed/parsers/template-xml-field-spec.jsonwhen the public/private XML contract changes. - Re-run
pnpm run submit:xml-specafter catalog changes. - Keep internal or moderation-only tags marked
privateso they never appear in submit docs.
Follow-up:
- This is currently driven by an explicit parser-backed catalog. A later tightening pass should move more field ownership closer to parser extraction and normalization so the catalog cannot drift from implementation semantics.
Level guide:
minimum: expected for the basic submission pathrecommended: strongly suggested metadata that improves review or presentationadvanced: accepted by the parser, but more specialized or legacy
Docker Template Fields
Public XML tags the parser supports for Docker app templates.
| Tag | Level | Parser notes |
|---|---|---|
<Name> | minimum | Display name shown in Community Apps. |
<Repository> | minimum | Docker image reference for the application. |
<Category> | recommended | Legacy category string normalized into CategoryList by the pipeline. |
<Icon> | recommended | Icon URL for the app or maintainer profile. |
<Overview> | recommended | Primary summary shown in Community Apps. |
<Project> | recommended | Homepage or source repository URL. |
<Support> | recommended | Support URL for forums, issues, or project help. |
<TemplateURL> | recommended | Canonical raw template URL used for identity and review. |
<Beta> | advanced | Legacy beta marker. Only true survives final output projection. |
<Branch> | advanced | Optional alternate release tags; each branch may include Tag, TagDescription, and override fields. |
<Changes> | advanced | Changelog text read from the source template when the feed marks a changelog as present. |
<Config> | advanced | Structured configuration entries preserved with @attributes and value keys. |
<Date> | advanced | Legacy date input accepted from XML and normalized against feed first-seen metadata. |
<DefaultTagDescription> | advanced | Description shown for the template's default repository tag when alternate branches are available. |
<Deprecated> | advanced | Legacy deprecation marker. Deprecated source paths may also force this flag. |
<DeprecatedMaxVer> | advanced | Marks the app deprecated when the running Unraid version is greater than this version. |
<Description> | advanced | Legacy long description. Promoted to Overview when Overview is missing, then removed from parser output. |
<Discord> | advanced | Discord invite or community URL shown as an app or repository support link. |
<DonateLink> | advanced | Donation or sponsorship URL. |
<DonateText> | advanced | Call-to-action text paired with DonateLink. |
<ExtraParams> | advanced | Additional Docker run arguments. Parser source transforms and security checks may rewrite or reject unsafe values. |
<ExtraSearchTerms> | advanced | Additional space-separated search terms used by legacy Community Apps search. |
<Facebook> | advanced | Facebook page URL shown as an app or repository support link. |
<Icon-azure> | advanced | Azure-theme app icon override used by legacy Community Apps. |
<Icon-black> | advanced | Black-theme app icon override used by legacy Community Apps. |
<Icon-gray> | advanced | Gray-theme app icon override used by legacy Community Apps. |
<Icon-white> | advanced | White-theme app icon override used by legacy Community Apps. |
<Licence> | advanced | Legacy spelling for license text or URL displayed in the app details popup. |
<License> | advanced | License text or URL displayed in the app details popup. |
<MaxVer> | advanced | Maximum supported Unraid version for compatibility filtering. |
<MinVer> | advanced | Minimum supported Unraid version for compatibility filtering. |
<MyIP> | advanced | Legacy container networking placeholder. Accepted by the parser but removed from final feed projection. |
<Network> | advanced | Legacy Docker network mode setting. |
<Photo> | advanced | Optional app or repository profile image URL. |
<Privileged> | advanced | Legacy privileged container flag. |
<ReadMe> | advanced | Optional readme URL. |
<Reddit> | advanced | Reddit community URL shown as an app or repository support link. |
<Registry> | advanced | Registry homepage URL shown for Docker templates. |
<Requires> | advanced | Requirements text preserved with raw whitespace for legacy parity formatting. |
<Screenshot> | advanced | Optional app screenshot URL; repeat the tag to show multiple screenshots. |
<Shell> | advanced | Shell used for container exec actions. |
<Twitter> | advanced | Twitter/X URL shown as an app or repository support link. |
<Video> | advanced | Optional app or repository profile video URL; repeat the tag to show multiple videos. |
<WebUI> | advanced | UI launch URL template shown in Community Apps. |
Plugin Template Fields
Public XML tags the parser supports for plugin wrapper templates.
| Tag | Level | Parser notes |
|---|---|---|
<PluginURL> | minimum | URL to the Unraid plugin manifest (.plg). |
<Name> | minimum | Display name shown in Community Apps. |
<Category> | recommended | Legacy category string normalized into CategoryList by the pipeline. |
<Icon> | recommended | Icon URL for the app or maintainer profile. |
<Overview> | recommended | Primary summary shown in Community Apps. |
<Project> | recommended | Homepage or source repository URL. |
<Support> | recommended | Support URL for forums, issues, or project help. |
<Beta> | advanced | Legacy beta marker. Only true survives final output projection. |
<Changes> | advanced | Changelog text read from the source template when the feed marks a changelog as present. |
<Deprecated> | advanced | Legacy deprecation marker. Deprecated source paths may also force this flag. |
<DeprecatedMaxVer> | advanced | Marks the app deprecated when the running Unraid version is greater than this version. |
<Discord> | advanced | Discord invite or community URL shown as an app or repository support link. |
<DonateLink> | advanced | Donation or sponsorship URL. |
<DonateText> | advanced | Call-to-action text paired with DonateLink. |
<ExtraSearchTerms> | advanced | Additional space-separated search terms used by legacy Community Apps search. |
<Facebook> | advanced | Facebook page URL shown as an app or repository support link. |
<Icon-azure> | advanced | Azure-theme app icon override used by legacy Community Apps. |
<Icon-black> | advanced | Black-theme app icon override used by legacy Community Apps. |
<Icon-gray> | advanced | Gray-theme app icon override used by legacy Community Apps. |
<Icon-white> | advanced | White-theme app icon override used by legacy Community Apps. |
<Licence> | advanced | Legacy spelling for license text or URL displayed in the app details popup. |
<License> | advanced | License text or URL displayed in the app details popup. |
<MaxVer> | advanced | Maximum supported Unraid version for compatibility filtering. |
<MinVer> | advanced | Minimum supported Unraid version for compatibility filtering. |
<Photo> | advanced | Optional app or repository profile image URL. |
<ReadMe> | advanced | Optional readme URL. |
<Reddit> | advanced | Reddit community URL shown as an app or repository support link. |
<Screenshot> | advanced | Optional app screenshot URL; repeat the tag to show multiple screenshots. |
<Twitter> | advanced | Twitter/X URL shown as an app or repository support link. |
<Video> | advanced | Optional app or repository profile video URL; repeat the tag to show multiple videos. |
Repository Profile Fields
Public XML tags the parser supports for ca_profile.xml repository metadata.
| Tag | Level | Parser notes |
|---|---|---|
<Profile> | minimum | Repository overview text shown for the maintainer profile. |
<Forum> | recommended | Forum thread or support landing page for the repository. |
<WebPage> | recommended | Primary repository or maintainer homepage. |
<Icon> | recommended | Icon URL for the app or maintainer profile. |
<Discord> | advanced | Discord invite or community URL shown as an app or repository support link. |
<DonateLink> | advanced | Donation or sponsorship URL. |
<DonateText> | advanced | Call-to-action text paired with DonateLink. |
<Facebook> | advanced | Facebook page URL shown as an app or repository support link. |
<Photo> | advanced | Optional app or repository profile image URL. |
<Reddit> | advanced | Reddit community URL shown as an app or repository support link. |
<Twitter> | advanced | Twitter/X URL shown as an app or repository support link. |
<Video> | advanced | Optional app or repository profile video URL; repeat the tag to show multiple videos. |