Unraid Community Apps
Community Apps

Repository XML Format

Format Docker templates and plugin wrappers so the Community Apps submission pipeline can scan and review them successfully.

Your repository must contain valid template XML files. For scan success, each app entry must include either a <Repository> tag for Docker applications or a <PluginURL> tag for plugins.

If you are starting from scratch, begin with the starter repository and then replace every placeholder value before submitting.

For a parser-backed list of public XML tags beyond the starter examples, use the generated XML field reference.

Docker app template minimum

  • Use one XML file per app template.
  • Ensure <Repository> points to a valid image repository.
  • Include readable <Name> and <Overview> content so moderators can review the submission quickly.
<Container version="2">
  <!-- Delete this file if your repository does not ship Docker apps. -->
  <Name>Example App</Name>
  <Repository>ghcr.io/YOUR_GITHUB_USERNAME/example-app:latest</Repository>
  <Registry>https://ghcr.io</Registry>
  <Network>bridge</Network>
  <MyIP/>
  <Shell>bash</Shell>
  <Privileged>false</Privileged>
  <Support>https://forums.unraid.net/topic/YOUR_SUPPORT_TOPIC</Support>
  <Project>https://github.com/YOUR_GITHUB_USERNAME/YOUR_REPO_NAME</Project>
  <Overview>Short summary shown in Community Apps.</Overview>
  <Description>Longer markdown or HTML description shown in Community Apps.</Description>
  <Category>Tools:Utilities</Category>
  <WebUI>http://[IP]:[PORT:8080]</WebUI>
  <TemplateURL>https://raw.githubusercontent.com/YOUR_GITHUB_USERNAME/YOUR_REPO_NAME/main/templates/example-app.xml</TemplateURL>
</Container>

Plugin template minimum

  • Plugin entries need a valid <PluginURL> pointing to the plugin manifest.
  • Add support and project links so moderators can review provenance quickly.
  • Plugin submissions are always manually reviewed during submission.
<Plugin>
  <!-- Delete this file if your repository does not ship plugins. -->
  <Name>Example Plugin</Name>
  <PluginURL>https://raw.githubusercontent.com/YOUR_GITHUB_USERNAME/YOUR_PLUGIN_REPO/main/example-plugin.plg</PluginURL>
  <Support>https://forums.unraid.net/topic/YOUR_SUPPORT_TOPIC</Support>
  <Project>https://github.com/YOUR_GITHUB_USERNAME/YOUR_PLUGIN_REPO</Project>
  <Overview>Explain what this plugin does and why users should install it.</Overview>
  <Category>Tools:Utilities</Category>
</Plugin>

Validation tip

After every meaningful XML change, run Validate and then Scan in the submission flow at /submit.