CrossLink project provides software services for the implementation of Inter-Library Loan (ILL) solutions. It was developed by Index Data, led by the IDS Project, and supported by the Institute of Museum and Library Services.
See individual components docs for details:
The CrossLink project improves the efficiency and reduces the cost of resource sharing by fostering interoperability between library systems, including facilitating cross-consortial lending. It focuses on promoting technology that allows libraries to engage in consortial resource sharing while maintaining flexible local ILL workflows. For all integration points, the project leverages various library IT standards, including ISO18626, SRU (Search/Retrieve via URL), and NCIP (NISO Circulation Interchange Protocol). The project improves the current state by encouraging vendors to implement new functionality and by providing middleware that helps libraries utilize existing systems more effectively. A central component is a broker system that receives requests, identifies suitable suppliers, and routes requests to them, supporting a wide range of automation and service levels for resource sharing. Another key component is an ILL mock service. This service provides a way to test and verify the compliance of existing systems with ILL standards.
See the diagram below for an illustration of the platform's architecture:
Figure 1: High-level architecture of the CrossLink platform showing component interactions
go CLI requires additional config to resolve private module dependencies for this repo.
- Add the following to your env:
export GOPRIVATE="github.com/indexdata/*"
this ensures go will fetch private modules without the public proxy.
- Add the following to you
~/.gitconfig:
[url "[email protected]:indexdata"]
insteadOf = https://github.com/indexdata
this ensures go will fetch modules using SSH and rely on your imported GitHub keys.
Note that, to avoid failures for auto-generated package dependencies when tidying use go mod tidy -e
The broker is available at: https://broker.crosslink-dev.indexdata.com.
The illmock and the submit form is available at: https://illmock.crosslink-dev.indexdata.com/form.
All containers and Helm charts from this repository are published to the GitHub Container Registry,
ghcr.io/indexdata.
The registry, like the repository, is private and you will need a GitHub classic
Personal Access Token (PAT) with read:packages scope for access.
Go to your Profile Settings > Developer Settings to get it and save it a file called TOKEN.
Once the token is issued, login to the registry with with the docker CLI:
cat TOKEN | docker login ghcr.io --password-stdin --username $
Run the container for a given application in this repository with (replace {appName} with e.g. crosslink-broker):
docker run ghcr.io/indexdata/{appName}:main
Only main tag is available.
If you're running on a platform that is not linux/amd64, make sure to pass the --platform linux/amd64 flag to docker pull/run.
Only amd64 images are published from this repository.
When deploying on Kubernetes, use the Helm charts published from this repo under ghcr.io/indexdata/charts.
To login to the GitHub OCI registry with Helm use the same GitHub PAT generate earlier:
cat TOKEN | helm registry login ghcr.io -u $ --password-stdin
Now you can install the chart to your current cluster context/namespace with (replace {releaseName} and {appName} with appropriate values):
helm install {releaseName} oci://ghcr.io/indexdata/charts/{appName} --devel
but first you need to ensure the cluster has the TOKEN deployed as a secret called
ghcr-secret to allow the chart to successfully pull the image:
kubectl create secret docker-registry ghcr-secret --docker-server=https://ghcr.io --docker-username=$ --docker-password=$(cat TOKEN)
You can configure environment variables during helm install with:
--set env.{PARAMETER}={value}
Charts use the LoadBalancer service type by default, you can change this during installation:
--set service.type=ClusterIP