catdv/service 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/service:2.1.0

You will require a valid CatDV Service license code to use the image.

⁠Setting runtime configuration, such as license codes

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

REGUSER=Registered Name
REGCODE=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
CATDV_SERVER_URL=CatDV Server URL e.g. http(s)://catdv_server_host
CATDV_SERVER_USER=CatDV Server User Account
CATDV_SERVER_PWD=CatDV Server User Account Password

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/service:2.1.0

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

  server:
    image: catdv/service:2.1.0
    ports:
    - "80:80"
    environment:
    - REGUSER=Registered Name
    - REGCODE=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
    - CATDV_SERVER_URL=http://catdv_server_host
    - CATDV_SERVER_USER=rest_user
    - CATDV_SERVER_PWD=password123

The container will start up a webserver on port 80 when it initializes. The CatDV Service will then try to connect to the CatDV Server you have specified in your environment variables.

⁠Using a secrets file

It is not best practice to pass secret information (such as registration codes and database connection strings) into a docker image via environment variables, as they may be printed out in log files and diagnostic information, this is especially of concern if you are running your containers on a platform that you do not manage yourself. We have therfore provided a mechanism to pass in a secrets file.

You will need to set an environment variable to tell the CatDV server where to find the secrets file, e.g.

SECRETS=/mnt/secrets/secrets.properties

You can then use a mechanism, such as a bind mount or docker secret to add that file into the container e.g.

--secret src=catdv-secrets,target=/mnt/secrets/secrets.properties

The contents of the secrets file should look as follows

# Additional catdv.properties containing secrets such as credentials
reg.user=Registered Name
reg.code=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
catdv.server.url=http\://localhost\:8080/
catdv.server.username=Administrator
catdv.server.password=catdv
http.hostname=localhost
http.port=8080

# Archive Plugin License codes
catdv.s3archive_service.licence_code=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX

As you can see, you can set registration codes, db connection strings and passwords.

⁠Adding server plugins to the image

-v /data/plugins/service:/usr/local/catdvService/plugins/external

Where /data/plugins/service contains all the CatDV Server plugins you wish to add to the container.

⁠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:80 catdv/service:2.0.1

Then you could visit http://localhost:8000⁠ or http://host-ip:8000⁠ in your browser.