catdv/worker repository overview

⁠How to use this image

This image is currently available for beta testing, not for production use

You can download the latest image by running

$docker pull catdv/worker:latest

or a specific version as follows:

$docker pull catdv/worker:8.1.0

You will require a valid CatDV Worker licence code to use the image.

This image requires that some environment variables be set in order for it to start correctly. They are as follows:

WORKERID=Node1 [unique name of this instance]
SERVERHOST=http://hostname.of.my.catdv.server:8000  [url of the CatDV server]
SERVERUSER=Worker [username to connect to the CatDV server]
SERVERPASSWORD=Password [password to connect to the CatDV server]
CONFIGNAME=ProxyGenerator [config set to load from the server]
REGUSER=Registered Name
REGCODE=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
SERVICEPASSWORD=Password [the password used to enable remote management of the worker instance]

we can use the following in our docker compose to set the log location and also to host any plugins scripts etc we want the worker to run ( this could include your own scripts)

      - "/Volumes/StorNext/.catdv/logs/catdvWorker:/var/log/catdvWorker"
      - "/Volumes/StorNext/.catdv/worker-plugins:/usr/local/catdvWorker/extensions"

The way to set these environment variables differs depending on which container provider you are using. If you are running on a local machine you can put these variables into a text file, for example env.list, then start the container from the directory containing your text file follows:

$docker run --env-file=./env.list catdv/worker:latest

You could also start up a CatDV worker node using Docker Compose by adding an entry to your docker-compose.yml as follows:

  worker:
    image: catdv/worker:latest
    ports:
    - "8001:8889"
    environment:
    - WORKERID: Node1
    - SERVERHOST: http://hostname.of.my.catdv.server:8000
    - SERVERUSER: Worker
    - SERVERPASSWORD: Password
    - CONFIGNAME: ProxyGenerator
    - REGUSER: Registered Name
    - REGCODE: XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
    - SERVICEPASSWORD: Password

The container will start up a REST endpoint on port 8889 (unless you have overridden it) when it initialises. The Worker will then try to connect to the CatDV server specified in your environment variables and load the configuration set specified.

⁠Binding to a different external port

If you wish the container to map to a different external port you could run:

$docker run --env-file=./env.list -p 8000:8889 catdv/worker:latest

⁠Where to get help

⁠License

By downloading and using this image you agree to accept the EULA which you can read here⁠.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Centos7 etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.