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.json when the public/private XML contract changes.
Re-run pnpm run submit:xml-spec after catalog changes.
Keep internal or moderation-only tags marked private so 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 path
recommended: strongly suggested metadata that improves review or presentation
advanced: 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.
`<Config>`	advanced	Structured configuration entries preserved with `@attributes` and `value` keys.
`<Deprecated>`	advanced	Legacy deprecation marker. Deprecated source paths may also force this flag.
`<Description>`	advanced	Legacy long description. Promoted to `Overview` when `Overview` is missing, then removed from parser output.
`<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.
`<MyIP>`	advanced	Legacy container networking placeholder. Accepted by the parser but removed from final feed projection.
`<Network>`	advanced	Legacy Docker network mode setting.
`<Privileged>`	advanced	Legacy privileged container flag.
`<ReadMe>`	advanced	Optional readme URL.
`<Registry>`	advanced	Registry homepage URL shown for Docker templates.
`<Requires>`	advanced	Requirements text preserved with raw whitespace for legacy parity formatting.
`<Shell>`	advanced	Shell used for container exec actions.
`<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.
`<Deprecated>`	advanced	Legacy deprecation marker. Deprecated source paths may also force this flag.
`<DonateLink>`	advanced	Donation or sponsorship URL.
`<DonateText>`	advanced	Call-to-action text paired with `DonateLink`.
`<ReadMe>`	advanced	Optional readme URL.

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 URL for repository support.
`<Facebook>`	advanced	Repository Facebook page link.
`<Photo>`	advanced	Optional repository profile photo or hero image URL.
`<Reddit>`	advanced	Repository Reddit community link.
`<Twitter>`	advanced	Repository Twitter/X profile link.
`<Video>`	advanced	Optional repository profile video URL.
`<DonateLink>`	advanced	Donation or sponsorship URL.
`<DonateText>`	advanced	Call-to-action text paired with `DonateLink`.