eikek / docspell

Assist in organizing your piles of documents, resulting from scanners, e-mails and other sources with miminal effort.
https://docspell.org
GNU Affero General Public License v3.0
1.52k stars 116 forks source link

Unraid support #257

Closed eikek closed 3 years ago

eikek commented 3 years ago

There have been requests for unraid templates. I'm not familiar with unraid, it seems to me that it is possible to convert the docker-compose.yml file into some xml or other format, that is supported on unraid.

ministryofsillywalks commented 3 years ago

Here is the info on how to create an unraid template and how to publish that to the community applications store. https://forums.unraid.net/topic/57181-docker-faq/#comment-566084

eikek commented 3 years ago

Thanks a lot for the pointer! I searched the forums the other day but was not able to find this page. But reading it shows that it is a lot of work and requires commitment/engaging in unraid forums and also a running unraid server as it seems. Well, this is just too much for me, I simply don't have enough time. If someone else wants to do it, I'm glad to help.

ministryofsillywalks commented 3 years ago

I might be able to create the template but I sure as hell am not the right person to be in charge of a support thread. I barely get things working myself. ;)

eikek commented 3 years ago

Yeah same for me:) I think this makes only sense to someone that actively uses unraid and docspell… so this is going to take a while :)

ministryofsillywalks commented 3 years ago

Just looked at the compose file and noticed that various containers are needed in order to run this. That is definitely beyond me in terms of unraid template. I'm not even sure unraid templates can handle such a "complex" setup of multiple containers. Hopefully someone more knowledgeable than me comes along ;)

eikek commented 3 years ago

Ah ok, thanks for trying. Docspell indeed needs several processes, it could be less than in the compose file, but this would be a good setup.

vakilando commented 3 years ago

Hi, I'm a dms-searching Unraid user. I want to run the dms as a docker if possible to avoid installing a dedicated vm. I have tried many docker-based dms systems on unraid and in the end Teedy, Paperless-ng and Mayan EDMS remained.

Docspell made such a good impression to me that I've tested it on a VM under Unraid via docker-compose, as there were no Docker templates for Unraid. Since I liked it very much, I took a closer look at the docker-compose file. After a few tests, I built various templates and wrote instructions on how to install them. Sorry, the instructions are in german but I may translate them later. You can find them here: https://github.com/vakilando/unraid-docker-templates You can try them. They are for my personal use and not part of the unraid community-apps and I do not have a support thread for them (yet).

eikek commented 3 years ago

@vakilando that is so great, thank you! I think I could link your repo somewhere in the docs as a pointer for people using unraid?

vakilando commented 3 years ago

yes, you can link it if you want. I just must take care to update my repo and instructions when docspell gets updated and things get changed like:

About the docker images/tags: I use the tags "-LATEST" in my repo, shoud I change them to to the latest available ("-v0.17.1 docker pull eikek0/docspell:joex-v0.17.1")?

eikek commented 3 years ago

Don't worry too much about keeping it up to date. I think it will help a lot nevertheless and can be updated by others as well (once they use it). I usually summarize changes to the config at each release; most of the time there are additions only rarely the structure changes (but it may happen).

The "-LATEST" tag is fine. It always points to the latest release. Whereas "-SNAPSHOT" is a build of the current master branch.

vakilando commented 3 years ago

ok, thanks! ...translation done!

eikek commented 3 years ago

I think this can be closed, as there is now a way for people to use docspell with unraid. As always, if something can be done to make providing support for it simpler, let us know. Also, feel free to reopen or create new issues if things don't work as expected.