Deep Blue Documents

See also: https://github.com/mlibrary/dspace-angular and https://github.com/mlibrary/deepblue-documents-kube (private)

DSpace backend services.

GitHub Actions workflows to produce Docker images of DSpace 7.6 backend services.

Dockerfile	Image	Description
frontend.dockerfile	dspace-frontend	Angular frontend for DSpace backend service *
dependencies.dockerfile	dspace-dependencies	Dependencies for DSpace backend service
backend.dockerfile	dspace-backend	DSpace backend service
db.dockerfile	dspace-db	PostgreSQL database for DSpace
solr.dockerfile	dspace-solr	Solr search engine for DSpace
express.dockerfile	dspace-express	Express server for Prometheus metrics

• The frontend image is built from the mlibrary/dspace-angular repository.

Building and running locally

docker build -f dependencies.dockerfile -t dspace-dependencies:main .

The compose.yml file is configured for local development and testing (docker-compose.yml is the upstream DSpace docker compose file).

docker compose up -d

Service URLs

URL	Container	Comments
http://localhost:4000/	frontend	Angular GUI (SSR app shell; Angular router handles /home etc. client-side)
http://localhost:8080/server/api	backend	Server API
http://localhost:8080/rest	backend	REST (Deprecated) Used by Perl Scripts
http://localhost:8983/solr	solr	Solr GUI
jdbc:postgresql://localhost:5432/dspace	db	PostgreSQL (user: dspace, password: dspace)
http://localhost:3000/metrics	express	Prometheus metrics endpoint (optional)

Notes

• The backend container exposes port 8000 (JDWP remote debugger — root backend.dockerfile for local dev only) and port 8009 (AJP connector). Neither is mapped in compose.yml by default. Add a port mapping to compose.yml if you need to attach a remote debugger locally.
• Backend configuration is supplied entirely via environment: variables in compose.yml. Key local-dev overrides: plugin__P__sequence__P__org__P__dspace__P__authenticate__P__AuthenticationMethod disables OIDC and enables password auth; ip__P__bioIPsRange1 / ip__P__bioIPsRange2 are set to non-routable CIDR placeholders (192.0.2.0/24) so that OidcAuthenticationBean — which calls String.split() on those properties unconditionally at startup — does not throw a NullPointerException on every /server/api request.

Integration Testing

A shell-based smoke test suite lives in tests/. It requires only bash and curl.

Quick run (stack already up)

bash tests/smoke.sh

Full run (start → wait → test)

make test

This is equivalent to:

make up                     # docker compose up -d
bash tests/wait-for-stack.sh  # poll until backend/solr/frontend are ready
bash tests/smoke.sh           # run all assertions

What is tested

Layer	Endpoint	Assertion
Backend API	GET /server/api	HTTP 200, HAL _links present
Backend API	GET /server/api	dspaceVersion and dspaceServer fields present
Backend API	GET /server/api/core/communities	HTTP 200
Backend API	GET /server/api/core/collections	HTTP 200
Backend API	GET /server/api/authn/status	HTTP 200, "authenticated":false
Backend Actuator	GET /server/actuator/health	"status":"UP" or "UP_WITH_ISSUES"
Solr	GET /solr/admin/info/system	HTTP 200, version info present
Solr	GET /solr/admin/cores	All four DSpace cores present (authority, oai, search, statistics)
Solr	GET /solr/search/admin/ping	HTTP 200
Frontend	GET /	HTTP 200, no ng-error boundary
Frontend (SSR)	GET /communities/	HTTP 200, ds-root element present, DSpace title present

CI (GitHub Actions)

The workflow .github/workflows/ci.yml is the primary CI workflow. It runs automatically on:

• Direct pushes to main — validates the branch after a merge.
• Pull requests targeting main — validates every push to a PR branch before it lands.