icewarptechnology/yoda-scan repository overview

⁠How to use this image

docker run --detach --env YODASCAN_FULLTEXTAPI_URL=<yoda> --env YODASCAN_DOCUMENTAPI_URL=<mundi> --volume /maildir:/maildir --publish 25795:25795 --publish 25796:25796 icewarptechnology/yoda-scan

or

docker run --detach --volume /maildir:/maildir --network yodanet --publish 25795:25795 --publish 25796:25796 icewarptechnology/yoda-scan

• YODASCAN_FULLTEXTAPI_URL must be set to running yoda service⁠.
• YODASCAN_DOCUMENTAPI_URL should be set to running mundi service⁠. Or it should be set as empty, when indexing of email and groupware attachments is not desired.
• alternatively, the defaults of yoda and mundi are set to http://yoda:25793⁠ and http://mundi:25797⁠. I.e. when containers with yoda and mundi are run on the same machine, are named appropriately and added to the same docker network (yodanet in this example), yoda-scan will connect out-of-the-box. When any of the services is installed via rpm, network yodanet is created during the installation. Otherwise the user must create this network like docker network create yodanet.
• Directory with mails to be indexed must be mounted to the same path in container as for IceWarp server. Because absolute paths are sent via API from IceWarp server to yoda-scan. Or path mapping must be configured in yoda-scan.xml.

⁠Further configuration

There's a default configuration file stored at /yoda-scan/config/yoda-scan.xml. You can copy out the config file from the image to your home directory

sudo docker run --rm -v ~:/cfg icewarptechnology/yoda-scan cp /yoda-scan/config/yoda-scan.xml /cfg

Edit it and then run the container with the modified config by passing it as argument:

docker run --detach --publish 25795:25795 --publish 25796:25796 --volume ~:/cfg icewarptechnology/yoda-scan /yoda-scan/yoda-scan --config /cfg/yoda-scan.xml

or by overlaying the directory /yoda-scan/config with host directory containing yoda-scan.xml file.