Merge pull request #191 from selfhosters/testing

templates/paperless-ng.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<Container version="2">
+  <Name>paperless-ng</Name>
+  <Repository>jonaswinkler/paperless-ng</Repository>
+  <Registry>https://hub.docker.com/r/jonaswinkler/paperless-ng/</Registry>
+  <Network>bridge</Network>
+  <Shell>bash</Shell>
+  <Privileged>false</Privileged>
+  <Support>https://forums.unraid.net/topic/87798-support-selfhostersnets-template-repository/</Support>
+  <Project>https://github.com/jonaswinkler/paperless-ng</Project>
+  <Overview>
+  Index and archive all of your scanned paper documents. Paperless-ng is a fork of paperless, adding a new interface and many other changes under the hood.[br][br]
+  [b]Requirements:[/b] Paperless-ng requires Redis as external service. See configuration below.
+  [b]Setup:[/b] Create a user account after this container is created i.e. from Unraids Docker UI, click the paperless-ng icon and choose Console. Then enter "python3.7 manage.py createsuperuser" in the prompt and follow the instructions.
+  [b]Paperless-ng Documentation:[/b] https://paperless-ng.readthedocs.io/en/latest/
+  [b]Additional Template Variables:[/b] https://paperless-ng.readthedocs.io/en/latest/configuration.html
+  </Overview>
+  <Beta>True</Beta>
+  <Category>Productivity:</Category>
+  <WebUI>http://[IP]:[PORT:8000]</WebUI>
+  <TemplateURL>https://raw.githubusercontent.com/selfhosters/unRAID-CA-templates/master/templates/paperless-ng.xml</TemplateURL>
+  <Icon>https://raw.githubusercontent.com/selfhosters/unRAID-CA-templates/master/templates/img/paperless.png</Icon>
+  <Config Name="Port" Target="8000" Default="8000" Mode="tcp" Description="Container Port: 8000" Type="Port" Display="always" Required="false" Mask="false"/>
+  <Config Name="Data" Target="/usr/src/paperless/data" Default="/mnt/user/appdata/paperless-ng/data" Mode="rw" Description="Container Path: /usr/src/paperless/data . &#13;&#10;This contains the paperless database. Should be in appdata." Type="Path" Display="always" Required="true" Mask="false"/>
+  <Config Name="Media" Target="/usr/src/paperless/media" Default="" Mode="rw" Description="Container Path: /usr/src/paperless/media . &#13;&#10;Once consumed, files will be stored here." Type="Path" Display="always" Required="true" Mask="false"/>
+  <Config Name="Consumption" Target="/usr/src/paperless/consume" Default="" Mode="rw" Description="Container Path: /usr/src/paperless/consume . &#13;&#10;Files placed here will be consumed by paperless." Type="Path" Display="always" Required="true" Mask="false"/>
+  <Config Name="Export" Target="/usr/src/paperless/export" Default="" Mode="rw" Description="Container Path: /usr/src/paperless/export . &#13;&#10;Location for files used by the exporter utility.&#13;&#10;See https://paperless-ng.readthedocs.io/en/latest/administration.html?#document-exporter" Type="Path" Display="always" Required="false" Mask="false"/>
+  <Config Name="PAPERLESS_REDIS" Target="PAPERLESS_REDIS" Default="redis://[IP]:6379" Mode="" Description="Container Variable: PAPERLESS_REDIS . This is required for processing scheduled tasks such as email fetching, index optimization and for training the automatic document matcher." Type="Variable" Display="always" Required="true" Mask="false"/>
+  <Config Name="PAPERLESS_OCR_LANGUAGE" Target="PAPERLESS_OCR_LANGUAGE" Default="eng" Mode="" Description="Container Variable: PAPERLESS_OCR_LANGUAGE . The default language to use for OCR. Set this to the language most of your documents are written in. Use a 3-letter language code consistent with ISO 639: https://www.loc.gov/standards/iso639-2/php/code_list.php. This can be a combination of multiple languages such as deu+eng, in which case tesseract will use whatever language matches best." Type="Variable" Display="always" Required="false" Mask="false"/>
+  <Config Name="PAPERLESS_OCR_LANGUAGES" Target="PAPERLESS_OCR_LANGUAGES" Default="" Mode="" Description="Container Variable: PAPERLESS_OCR_LANGUAGES . Additional languages to install for text recognition. The container installs English, German, Italian, Spanish and French by default. Use a space separated list of 3-letter language codes consistent with ISO 639: https://www.loc.gov/standards/iso639-2/php/code_list.php" Type="Variable" Display="always" Required="false" Mask="false"/>
+  <Config Name="PAPERLESS_FILENAME_FORMAT" Target="PAPERLESS_FILENAME_FORMAT" Default="{created}-{correspondent}-{title}" Mode="" Description="Specify a filename format for the document (directories are supported). Use the following placeholders: {correspondent}, {title}, {created}, {added}, {tags[KEY]} If your tags conform to key_value or key-value, {tags[INDEX]} If your tags are strings, select the tag by index. Uniqueness of filenames is ensured, as an incrementing counter is attached." Type="Variable" Display="always" Required="false" Mask="false"/>
+  <Config Name="PAPERLESS_TIME_ZONE" Target="PAPERLESS_TIME_ZONE" Default="America/Los_Angeles" Mode="" Description="Container Variable: PAPERLESS_TIME_ZONE . Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC." Type="Variable" Display="always" Required="false" Mask="false"/>
+  <Config Name="PAPERLESS_CONSUMER_POLLING" Target="PAPERLESS_CONSUMER_POLLING" Default="0" Mode="" Description="Container Variable: PAPERLESS_CONSUMER_POLLING . If set to a value n greater than 0, inotify is disabled and the directory is polled every n seconds. This option is useful when inotify doesn't fire events like when the consume folder is a NFS share" Type="Variable" Display="advanced" Required="false" Mask="false"/>
+  <Config Name="PUID" Target="USERMAP_UID" Default="99" Mode="" Description="Container Variable: USERMAP_UID" Type="Variable" Display="advanced" Required="false" Mask="false"/>
+  <Config Name="PGID" Target="USERMAP_GID" Default="100" Mode="" Description="Container Variable: USERMAP_GID" Type="Variable" Display="advanced" Required="false" Mask="false"/>
+</Container>