Squid Posted May 30, 2015 Share Posted May 30, 2015 EDIT: It looks like all/most of the links within this post are not functional. However, they would all either link to another post within this thread or to a post within the Application Categorizer plugin support thread or to a post within CA. Reply to this thread if you have any questions about the optional tags. CA relies upon a third party parser and hosting of the template author's xml files that is out of the author of CAs control. Because of this, the only supported XML format is that which is generated by unRaid's docker tab when hitting SAVE on the template. Any manual editing of the XML files may present compatibility issues for CA and if they turn out to be incompatible, will result in the template being blacklisted within CA until brought into conformity with the dockerMan generated files. As an example, the extra spacing on the various Config element attributes is incompatible with the third party parser and will result in either errors or incorrect entries being made when adding the container through CA. dockerMan does not generate the extra spacing as listed below, and CA has no problem with dockerMan's generated files. With the changes to the docker template XML being introduced by the Community Repositories and Community Applications plugins, I figured that those changes should be documented somewhere rather than being buried in various threads. The official XML (as generated by dockerMan) is as follows: (probably described somewhere in this thread: http://lime-technology.com/forum/index.php?topic=33965.0 - TLDR <?xml version="1.0" encoding="utf-8"?> <Container> <Name>Pints</Name> <Description>Raspberry Pints, beer tap display app[br]IMPORTANT :- YOU MUST CHANGE THE HOST PORT BELOW</Description> <Registry>https://registry.hub.docker.com/u/sparklyballs/pints/</Registry> <Repository>sparklyballs/pints</Repository> <BindTime>true</BindTime> <Privileged>false</Privileged> <Environment/> <Networking> <Mode>bridge</Mode> <Publish> <Port> <HostPort>81</HostPort> <ContainerPort>80</ContainerPort> <Protocol>tcp</Protocol> </Port> </Publish> </Networking> <Data> <Volume> <HostDir>/mnt/cache/appdata/pints/www</HostDir> <ContainerDir>/var/www/Pints</ContainerDir> <Mode>rw</Mode> </Volume> <Volume> <HostDir>/mnt/cache/appdata/pints/config</HostDir> <ContainerDir>/config</ContainerDir> <Mode>rw</Mode> </Volume> </Data> <Version>05616fd2</Version> <WebUI>http://[iP]:[PORT:80]/</WebUI> <Banner>http://whatsmybeeragain.com/wp-content/uploads/2013/12/Whats-My-Beer-Logo-Banner-2-01-e1318366883801.png</Banner> <Icon>http://fullersbarbeerfest.co.uk/files/6113/8705/6693/light-beer.png</Icon> <ExtraParams></ExtraParams> </Container> EDIT: the above is the v1 specification Unraid versions 6.2+ support v2 which have the ports and paths defined via <Config> entries and take precedence over v1. Unraid 6.10+ no longer will generate the legacy v1 entries (although when installing an app it will read them) Note that for CA / Apps Tab, either <Description> or <Overview> must be present and not empty. IE: Its required. Additionally, there are also some (currently) unofficial entries. <Support> Contains a link to a support thread for the container. http://lime-technology.com/forum/index.php?topic=39106.msg365627#msg365627 <Overview> This is the same thing as <Description> if <Overview> is present, then <Description> is completely ignored <Beta>, <Category> (Both optional but highly recommended). These entries are created by this plugin: http://lime-technology.com/forum/index.php?topic=40111.0 <Date> This entry contains the date the container has been created and/or updated http://lime-technology.com/forum/index.php?topic=40111.msg381735#msg381735. If this tag is not present, but the <DateInstalled> tag is present, then the latter is used. <Changes> This entry contains a changelog for the container. http://lime-technology.com/forum/index.php?topic=40111.msg379576#msg379576 <Project> The entry contains a url to the project page (home page) for the container (eg: https://plex.tv) http://lime-technology.com/forum/index.php?topic=40299.msg394762#msg394762 <Licence> or <License> Optionally displays licence information for the app http://lime-technology.com/forum/index.php?topic=40262.msg444243#msg444243 <Branch> (docker app only) will allow CA to ask the user which branch of the application to install. See here: http://lime-technology.com/forum/index.php?topic=40299.msg495429#msg495429 <ExtraSearchTerms> extra search terms to use for the app see https://forums.unraid.net/topic/38619-docker-template-xml-schema/page/3/?tab=comments#comment-941891 <Requires> any additional requirements on the user's system the app may require https://forums.unraid.net/topic/38619-docker-template-xml-schema/page/3/?tab=comments#comment-1015826 Unraid 6.10 includes this entry when editing / creating a template in authoring mode <ReadMe> https://forums.unraid.net/topic/38619-docker-template-xml-schema/page/4/?tab=comments#comment-1051557 Unraid 6.10-rc3+ includes this entry when editing / creating a template in authoring mode <Screenshot> https://forums.unraid.net/topic/38619-docker-template-xml-schema/page/4/?tab=comments#comment-1051850 This specifies a screenshot (or multiple screenshots) to include in the sidebar for the app Additionally, CA supports placing an optional donate button at the bottom of the popup changelogs and full descriptions. The tags associated with this are: <DonateText> A short blurb of why to donate (eg: Server's Cost Money, I'm paying for a divorce, I'm out of beer, etc <DonateLink> A link to take you to the actual website where the donations are handled 2/21/21 - Donation links within templates are now deprecated, in favour of the links being present in the profiles. This means that all you have to do is fill out the appropriate links within the CA profile and those links will get carried over to the templates automatically. NOTE that & are disallowed in entries. You will need to replace them with this: & Failure to do this will result in your application not displaying within CA (And not being able to be installed via dockerMan <DonateText> is optional, but both <DonateLink> and <DonateImg> are mandatory for this to appear (One or the other missing will result in the button not appearing) Side Note Only the tags which are listed in this thread (and the companion PluginXML thead)are official / semi-official / unofficial. If you happen to look at the XML's which are generated by CA and passed through to dockerMan at installation, there are many other tags that are contained within that are utilized only for CA's internal purposes. Do not utilize them. Quote Link to comment
Posted by Squid,
Go to this post
Join the conversation
You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.