islandora/riprap repository overview

⁠Riprap

Docker image for Riprap⁠ (unreleased version) micro-service.

Built from Islandora-DevOps/isle-buildkit riprap⁠

Please refer to the Riprap Documentation⁠ for more in-depth information.

⁠Dependencies

Requires islandora/nginx Docker image to build. Please refer to the Nginx Image README⁠ for additional information including additional settings, volumes, ports, etc.

Additionally you can run with different database backends, by default it will use the bundled SQLite backend which requires no additional configuration. However if you wish to use a MySQL or PostgreSQL backend please refer to the MariaDB Image README⁠ and PostgreSQL Image README⁠ respectively, and change RIPRAP_DB_DRIVER to your selected backend, along with any other relevant settings.

⁠Ports

⁠Volumes

⁠Settings

⁠Confd Settings

You can generate your own secret using the following command:

cat /dev/urandom | base64 | head -c 32 && echo ""

What follows is configuration specific to the check fixity command. Not all configurations are applicable in all situations, they are largely dependent on which plugins you enable.

Please refer to the Riprap Plugin Overview⁠ and Riprap Plugin Documentation⁠ for more in-depth information, as well as the Riprap Plugins⁠ themselves.

If starting out fresh its recommend to use PluginFetchResourceListFromDrupalView rather than PluginFetchResourceListFromDrupal which is currently in the process of being deprecated.

⁠Database Settings

Riprap⁠ can optionally make use of different database backends. Please see the documentation in the base image⁠ for more information about the default database connection configuration.

Aside from RIPRAP_DB_DRIVER, the following settings are only used if RIPRAP_DB_DRIVER is set to mysql or postgresql.

⁠Updating

You can change the commit used for riprap by modifying the build argument COMMIT and SHA256 in the Dockerfile shown as XXXXXXXXXXXX in the following snippet:

ARG COMMIT=XXXXXXXXXXXX
#...
ARG SHA256=XXXXXXXXXXXX

You can generate the SHA256 with the following commands:

COMMIT=$(cat riprap/Dockerfile | grep -o 'COMMIT=.*' | cut -f2 -d=)
FILE=$(cat riprap/Dockerfile | grep -o 'FILE=.*' | cut -f2 -d=)
URL=$(cat riprap/Dockerfile | grep -o 'URL=.*' | cut -f2 -d=)
FILE=$(eval "echo $FILE")
URL=$(eval "echo $URL")
wget --quiet "${URL}"
shasum -a 256 "${FILE}" | cut -f1 -d' '
rm "${FILE}"

When changing either the riprap version or when the version of PHP in the nginx image this is based on changes you will also need to update the compose.lock file.

# Build required base image.
make bake TARGET=nginx
# Build the layer before installation.
docker buildx build --target download \
  --tag islandora/riprap:download \
  --build-context nginx=docker-image://islandora/nginx:local ./riprap
# Update the lock file.
docker run --rm -ti \
  -v $(pwd)/riprap/rootfs/var/www/riprap/composer.lock:/var/www/riprap/composer.lock \
  --entrypoint ash islandora/riprap:download -c \
    "cd /var/www/riprap && composer update"
# Build the image with the updated composer.lock file.
make bake target=riprap