Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
127 commits
Select commit Hold shift + click to select a range
d21385b
141151: Adjust cc license section to expect i18n tags, cc license dro…
ConfusionOrb221 May 27, 2026
9cb0818
QREPO-405 extending translate loader to use theme inheritence
kanasznagyzoltan May 13, 2026
6add72c
QREPO-405 fixing problems reported by lint
kanasznagyzoltan May 13, 2026
286bb5b
QREPO-405 moving resolveThemeLoadOrder into a separate util and makin…
kanasznagyzoltan Jun 3, 2026
8143bf2
QREPO-405 using active theme chain for determining theme order
kanasznagyzoltan Jun 4, 2026
c594b07
QREPO-405 fix type cast for getDefaultThemeConfig in server loader
kanasznagyzoltan Jun 4, 2026
11cf30e
143742: Fix hideReturnButton not being configurable on nested routes
alexandrevryghem Jul 23, 2026
03fae7f
Merge branch 'fix-hide-return-button-for-edit-dso-pages_contribute-7.6'
alexandrevryghem Jul 24, 2026
ee02631
143742: Added aria-hidden attributes to FontAwesome icons
alexandrevryghem Jul 30, 2026
fe33f31
fix(cookies): skip Orejime init when consent popup is disabled
Hashim1999164 Jul 31, 2026
2f7254a
Merge remote-tracking branch 'upstream/main' into QREPO-405-Runtime-i…
kanasznagyzoltan Aug 27, 2026
35c3bac
QREPO-405 adding documentation for theme-specific runtime translations
kanasznagyzoltan Aug 27, 2026
299ec45
fixing spacing between submit button and accessiblity card in the pro…
bsarnii Sep 7, 2026
21ab7d3
fix: using new eperson and group on init page instead of cashed
Emil-Domagala-pcg Sep 8, 2026
f4a9fc4
src/app/item-page: adjust grid in simple item view
alanorth Sep 12, 2025
c691861
src/app/entity-groups: adjust grid in entity item pages
alanorth Feb 24, 2026
2bb498c
src/styles: set max-width on item page fields
alanorth Feb 27, 2026
ec77307
Skip authenticated-only authorization checks for anonymous visitors
bram-atmire Sep 20, 2026
0a36bb0
Batch anonymous authorization checks per object
bram-atmire Sep 26, 2026
58d213e
prevent SSR'ing of header login form
saschaszott Sep 28, 2026
ae6b6e6
disable SSR and SSR caching for authenticated users
saschaszott Sep 29, 2026
83c9b1b
Merge remote-tracking branch 'upstream/main' into QREPO-405-Runtime-i…
kanasznagyzoltan Sep 30, 2026
3a45c31
Avoid repeated anonymous authorization feature scans
bram-atmire Oct 2, 2026
665aa5d
fix(item-versions): hide version history table when only one version …
biggdawg320 Oct 2, 2026
d116488
build(deps): bump http-cache-semantics from 4.2.0 to 4.3.0
dependabot[bot] Oct 4, 2026
ffae85c
build(deps): bump hono from 4.13.5 to 4.13.13
dependabot[bot] Oct 4, 2026
0766e67
Fix authorization service import lint
bram-atmire Oct 5, 2026
833726f
Stub AuthorizationDataService in FileSectionComponent spec
bram-atmire Oct 9, 2026
3ac0ffd
Merge remote-tracking branch 'upstream/main' into item-page-request-r…
bram-atmire Oct 9, 2026
78efbe6
Merge pull request #6193 from Emil-Domagala-pcg/fix/issue-6192
tdonohue Oct 12, 2026
13e96c9
build(deps): bump ip-address from 10.5.0 to 10.7.4
dependabot[bot] Oct 13, 2026
4f45943
build(deps): bump proxy-addr from 2.0.7 to 2.0.8
dependabot[bot] Oct 13, 2026
0c5ea1a
build(deps): bump uuid from 14.0.2 to 14.0.3
dependabot[bot] Oct 13, 2026
140e56a
Update cache ssr responses
Oct 13, 2026
5ba5501
Added new config settings.
EikLoe Apr 9, 2026
4a0a5a3
Added config based conditions to home-news and home-header
EikLoe Apr 9, 2026
056d433
Added missing test-environment defaults.
EikLoe Apr 9, 2026
fab0d32
Removing not-displayed cms metadata from dropdown and hide edit-cms-m…
EikLoe Apr 9, 2026
9e100b8
Fixed linter in home-page.component.ts
EikLoe Apr 9, 2026
c468aef
Corrected typo in edit-cms-metadata.menu.ts
EikLoe Oct 13, 2026
3329984
build(deps): bump shell-quote from 1.10.0 to 1.12.0
dependabot[bot] Oct 13, 2026
847e90e
Merge pull request #6274 from saschaszott/saschaszott-patch-26
tdonohue Oct 15, 2026
516aeed
Merge pull request #6360 from dataquest-dev/fix/cache-only-200-ssr-re…
tdonohue Oct 15, 2026
5dd6ed6
Fix COAR Notify not rendering logs (#4867)
alexandrevryghem Oct 15, 2026
e5d1a4b
Merge pull request #6359 from DSpace/dependabot/npm_and_yarn/uuid-14.0.3
alanorth Oct 16, 2026
8d270a3
On failure in GitHub CI, export the logs from the backend running in …
tdonohue Oct 16, 2026
d4abe55
Switch to using "Chrome for Testings" for e2e tests, as recommended b…
tdonohue Oct 16, 2026
cf9fc36
Merge pull request #6378 from tdonohue/export_backend_logs_on_failure
tdonohue Oct 16, 2026
683f7d1
build(deps-dev): bump the eslint group with 4 updates
dependabot[bot] Oct 16, 2026
f7f69e8
build(deps): bump cypress-io/github-action from 7.4.4 to 7.4.6
dependabot[bot] Oct 16, 2026
77609b5
build(deps): bump korthout/backport-action from 4.6.1 to 4.7.0
dependabot[bot] Oct 16, 2026
108ba36
build(deps): bump the angular group across 1 directory with 13 updates
dependabot[bot] Oct 16, 2026
b86bbed
build(deps): bump source-map-js from 1.2.1 to 1.2.2
dependabot[bot] Oct 19, 2026
fb58268
Merge branch 'main' into saschaszott-patch-27
saschaszott Oct 19, 2026
3285ef5
build(deps): bump compression from 1.8.1 to 1.8.2
dependabot[bot] Oct 19, 2026
5b06bc9
add deferred rendering to lang-switch component
saschaszott Oct 20, 2026
728ddbb
refactor CommonEngine instantiation to occur only once at startup
saschaszott Oct 20, 2026
c9c1c6d
build(deps): bump follow-redirects from 1.16.0 to 1.16.1
dependabot[bot] Oct 20, 2026
db86386
Merge pull request #6272 from saschaszott/saschaszott-patch-25
alanorth Oct 21, 2026
22c1981
Merge pull request #6381 from DSpace/dependabot/npm_and_yarn/eslint-a…
alanorth Oct 21, 2026
7bb7af4
build(deps): bump markdown-it from 14.3.1 to 14.3.3
dependabot[bot] Oct 21, 2026
570820a
Merge pull request #6352 from saschaszott/saschaszott-patch-31
alanorth Oct 22, 2026
8a115ef
feat(ssr-cache): add Redis-based server-side rendering cache with tes…
pcg-kk Oct 11, 2026
edd9ce3
fix(ssr-cache): remove unused specs and improve coverage for cache se…
pcg-kk Oct 11, 2026
a3f28a8
fix(server): clean up imports and improve server configuration readab…
pcg-kk Oct 11, 2026
122cbac
Merge pull request #5457 from dspace-unimr/fix/ds-5342-making-cms-edi…
tdonohue Oct 23, 2026
6c71f5e
Merge pull request #6419 from DSpace/dependabot/npm_and_yarn/markdown…
tdonohue Oct 23, 2026
beec5fc
Merge pull request #6363 from DSpace/dependabot/npm_and_yarn/shell-qu…
tdonohue Oct 23, 2026
bf5e697
Merge pull request #6415 from DSpace/dependabot/npm_and_yarn/follow-r…
tdonohue Oct 23, 2026
caef38a
build(deps): bump dompurify from 3.4.16 to 3.4.17
dependabot[bot] Oct 23, 2026
f989cad
Merge pull request #6357 from DSpace/dependabot/npm_and_yarn/ip-addre…
tdonohue Oct 23, 2026
2408496
Merge pull request #6374 from DSpace/dependabot/npm_and_yarn/source-m…
tdonohue Oct 23, 2026
125a1fa
Merge pull request #6358 from DSpace/dependabot/npm_and_yarn/proxy-ad…
tdonohue Oct 23, 2026
89c07d7
Merge pull request #6328 from DSpace/dependabot/npm_and_yarn/hono-4.1…
tdonohue Oct 23, 2026
fd36458
Merge pull request #6327 from DSpace/dependabot/npm_and_yarn/http-cac…
tdonohue Oct 23, 2026
ba2f112
Merge pull request #6431 from DSpace/dependabot/npm_and_yarn/dompurif…
tdonohue Oct 23, 2026
2eb9fc7
QREPO-405 only request theme i18n files that are present in the build
kanasznagyzoltan Oct 26, 2026
28d05cd
Merge remote-tracking branch 'upstream/main' into QREPO-405-Runtime-i…
kanasznagyzoltan Oct 26, 2026
ee3cc88
Bump all Angular dependencies to 20.3.34
tdonohue Oct 26, 2026
9e72d1b
Merge pull request #6304 from DSpace/dependabot/npm_and_yarn/angular-…
tdonohue Oct 26, 2026
4b2fd7f
build(deps): bump body-parser from 1.20.6 to 1.20.9
dependabot[bot] Oct 26, 2026
9092aaa
build(deps): bump undici from 6.29.0 to 6.29.1
dependabot[bot] Oct 26, 2026
e2e3b2e
build(deps-dev): bump fast-uri from 3.1.7 to 3.1.9
dependabot[bot] Oct 26, 2026
cd6b8a4
build(deps): bump postcss-selector-parser from 6.1.4 to 6.1.5
dependabot[bot] Oct 26, 2026
019e69a
Merge pull request #6446 from DSpace/dependabot/npm_and_yarn/postcss-…
tdonohue Oct 26, 2026
3453f5c
Merge pull request #6445 from DSpace/dependabot/npm_and_yarn/fast-uri…
tdonohue Oct 26, 2026
43bbea9
Merge pull request #6444 from DSpace/dependabot/npm_and_yarn/undici-6…
tdonohue Oct 26, 2026
cab8122
Merge pull request #6443 from DSpace/dependabot/npm_and_yarn/body-par…
tdonohue Oct 26, 2026
986ca03
Merge pull request #6383 from DSpace/dependabot/github_actions/cypres…
tdonohue Oct 27, 2026
468e654
Merge pull request #6386 from DSpace/dependabot/github_actions/kortho…
tdonohue Oct 27, 2026
e3836cf
Merge pull request #6377 from DSpace/dependabot/npm_and_yarn/compress…
tdonohue Oct 27, 2026
20a50c1
141151: Adjusted CC license section to restore its previous state, th…
ConfusionOrb221 Oct 27, 2026
dd495bb
DURACOM-416 Created fallback logic when user reaches an out of bound …
Sondissimo Oct 29, 2026
250d6ba
141151: Fix duplicate CC license remove on reselect and add CC option…
ConfusionOrb221 Oct 29, 2026
7562344
Merge remote-tracking branch 'community/main' into w2p-141151_feature…
Oct 29, 2026
fa8e5cc
exclude community and collection search from ssr (#6344)
tinsch Oct 30, 2026
571e121
Merge pull request #4720 from alanorth/simple-item-view
tdonohue Oct 30, 2026
6f52262
Simplify anonymous authorization batching
bram-atmire Oct 31, 2026
47c1323
build(deps): bump http-proxy-middleware from 2.0.10 to 2.0.11
dependabot[bot] Nov 1, 2026
c18737e
build(deps): bump cypress-io/github-action from 7.4.6 to 7.4.7
dependabot[bot] Nov 1, 2026
e6ca109
Merge pull request #6495 from DSpace/dependabot/github_actions/cypres…
alanorth Nov 1, 2026
45095b6
build(deps): bump follow-redirects from 1.16.1 to 1.16.2
dependabot[bot] Nov 1, 2026
b1f812b
build(deps): bump systeminformation from 5.33.1 to 5.33.19
dependabot[bot] Nov 1, 2026
990cd21
Merge pull request #6502 from DSpace/dependabot/npm_and_yarn/systemin…
tdonohue Nov 2, 2026
4be43ca
Merge pull request #6501 from DSpace/dependabot/npm_and_yarn/follow-r…
tdonohue Nov 2, 2026
47ff474
Merge pull request #6492 from DSpace/dependabot/npm_and_yarn/http-pro…
tdonohue Nov 2, 2026
2f0820f
Merge pull request #5735 from atmire/w2p-141151_feature-cc-license-csv
tdonohue Nov 4, 2026
873c4b2
146855: remove spacing after metadata value
bram-maegerman Nov 5, 2026
e5f99bd
fix(item-versions): keep single-version row visible in edit view
biggdawg320 Nov 5, 2026
aab56ff
Merge pull request #5988 from alexandrevryghem/fix-hide-return-button…
tdonohue Nov 6, 2026
81ebb74
test(item-versions): cover displayWhenEmpty=true with single draft ve…
biggdawg320 Nov 9, 2026
ecfa0fa
Merge pull request #6013 from Hashim1999164/fix/6009-skip-orejime-whe…
tdonohue Nov 9, 2026
5d28816
QREPO-405 log a warning when an i18n file fails to load in the browser
kanasznagyzoltan Nov 11, 2026
9f31e5d
Merge pull request #6191 from bsarnii/profile-page-spacing-fix
tdonohue Nov 11, 2026
57f9dc9
Cache only HTTP 200 responses in Redis
pcg-kk Nov 11, 2026
e36a920
Improve Redis cache failure logging safety
pcg-kk Nov 11, 2026
0673b76
QREPO-405 update the theme translation docs to the current behaviour
kanasznagyzoltan Nov 12, 2026
d6af560
Merge pull request #5653 from qultoltd/QREPO-405-Runtime-i18n-Loading…
alanorth Nov 12, 2026
7169e23
Merge pull request #6325 from biggdawg320/jobscout/6262-item-with-a-d…
tdonohue Nov 12, 2026
db37a90
Merge pull request #6257 from bram-atmire/item-page-request-reduction
tdonohue Nov 13, 2026
83d9e6f
Merge pull request #6276 from saschaszott/saschaszott-patch-27
tdonohue Nov 13, 2026
24a274d
Includes a redirect to the 404 page when accessing community, collect…
DanGastardelli Nov 13, 2026
13d81a3
Merge pull request #6517 from atmire/w2p-146855_remove-spacing-after-…
alanorth Nov 15, 2026
1cee7a1
feat(ssr-cache): add optional HTML compression for Redis
pcg-kk Nov 16, 2026
2a9cdd7
feat(ssr-cache): configure Redis memory limits and eviction policy
pcg-kk Nov 16, 2026
bf82ee8
fix(ssr-cache): configure Redis memory limit in MiB
pcg-kk Nov 16, 2026
8c10595
Merge main into redis and resolve SSR cache conflict
pcg-kk Nov 16, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ updates:
# via a major version tag which automatically uses the latest minor/patch version (e.g. "actions/checkout@v6")
- dependency-name: "actions/*"
update-types: [ "version-update:semver-minor", "version-update:semver-patch"]
- dependency-name: "browser-actions/*"
update-types: [ "version-update:semver-minor", "version-update:semver-patch"]
- dependency-name: "github/*"
update-types: [ "version-update:semver-minor", "version-update:semver-patch"]
- dependency-name: "docker/*"
Expand Down Expand Up @@ -238,6 +240,8 @@ updates:
# via a major version tag which automatically uses the latest minor/patch version (e.g. "actions/checkout@v6")
- dependency-name: "actions/*"
update-types: [ "version-update:semver-minor", "version-update:semver-patch"]
- dependency-name: "browser-actions/*"
update-types: [ "version-update:semver-minor", "version-update:semver-patch"]
- dependency-name: "github/*"
update-types: [ "version-update:semver-minor", "version-update:semver-patch"]
- dependency-name: "docker/*"
Expand Down Expand Up @@ -357,6 +361,8 @@ updates:
# via a major version tag which automatically uses the latest minor/patch version (e.g. "actions/checkout@v6")
- dependency-name: "actions/*"
update-types: [ "version-update:semver-minor", "version-update:semver-patch"]
- dependency-name: "browser-actions/*"
update-types: [ "version-update:semver-minor", "version-update:semver-patch"]
- dependency-name: "github/*"
update-types: [ "version-update:semver-minor", "version-update:semver-patch"]
- dependency-name: "docker/*"
Expand Down Expand Up @@ -478,6 +484,8 @@ updates:
# via a major version tag which automatically uses the latest minor/patch version (e.g. "actions/checkout@v6")
- dependency-name: "actions/*"
update-types: [ "version-update:semver-minor", "version-update:semver-patch"]
- dependency-name: "browser-actions/*"
update-types: [ "version-update:semver-minor", "version-update:semver-patch"]
- dependency-name: "github/*"
update-types: [ "version-update:semver-minor", "version-update:semver-patch"]
- dependency-name: "docker/*"
Expand Down
53 changes: 31 additions & 22 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,6 @@ jobs:
CYPRESS_BASE_URL: http://127.0.0.1:4000
# Disable the cookie consent banner in e2e tests to avoid errors because of elements hidden by it
DSPACE_INFO_ENABLECOOKIECONSENTPOPUP: false
# When Chrome version is specified, we pin to a specific version of Chrome
# Comment this out to use the latest release
#CHROME_VERSION: "90.0.4430.212-1"
# Bump Node heap size (OOM in CI after upgrading to Angular 15)
NODE_OPTIONS: '--max-old-space-size=4096'
# Project name to use when running "docker compose" prior to e2e tests
Expand Down Expand Up @@ -85,22 +82,6 @@ jobs:
with:
node-version: ${{ matrix.node-version }}

# If CHROME_VERSION env variable specified above, then pin to that version.
# Otherwise, just install latest version of Chrome.
- name: Install Chrome (for e2e tests)
run: |
if [[ -z "${CHROME_VERSION}" ]]
then
echo "Installing latest stable version"
sudo apt-get update
sudo apt-get --only-upgrade install google-chrome-stable -y
else
echo "Installing version ${CHROME_VERSION}"
wget -q "https://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_${CHROME_VERSION}_amd64.deb"
sudo dpkg -i "google-chrome-stable_${CHROME_VERSION}_amd64.deb"
fi
google-chrome --version

# https://github.com/actions/cache/blob/main/examples.md#node---npm
- name: Get NPM cache directory
id: npm-cache-dir
Expand Down Expand Up @@ -135,6 +116,9 @@ jobs:
- name: Run specs (unit tests)
run: npm run test:headless

- name: Run SSR cache unit tests
run: npm run test:ssr-cache

# Upload code coverage report to artifact (for one version of Node only),
# so that it can be shared with the 'codecov' job (see below)
# NOTE: Angular CLI only supports code coverage for specs. See https://github.com/angular/angular-cli/issues/6286
Expand Down Expand Up @@ -167,14 +151,23 @@ jobs:
docker compose -f ./docker/cli.yml -f ./docker/cli.assetstore.yml run --rm dspace-cli
docker container ls

# Installs "Chrome for Testing" which is a version of Chrome stabilized for automated testing
# Cypress recommends using Chrome For Testing for reliable, reproducible runs
# https://docs.cypress.io/app/references/launching-browsers
- name: Install Chrome For Testing (for e2e tests)
uses: browser-actions/setup-chrome@v2
# To pin to a specific version of Chrome, uncomment this parameter
#with:
# chrome-version: 154

# Run integration tests via Cypress.io
# https://github.com/cypress-io/github-action
# (NOTE: to run these e2e tests locally, just use 'ng e2e')
- name: Run e2e tests (integration tests)
uses: cypress-io/github-action@v7.4.4
uses: cypress-io/github-action@v7.4.7
with:
# Run tests in Chrome, headless mode (default)
browser: chrome
# Run tests in Chrome for Testing
browser: chrome-for-testing
# Start app before running tests (will be stopped automatically after tests finish)
start: npm run serve:ssr
# Wait for backend & frontend to be available
Expand Down Expand Up @@ -335,6 +328,22 @@ jobs:
- name: Stop running app
run: kill -9 $(lsof -t -i:4000)


# If any prior step errors out, export the backend logs for help with debugging issues
- name: Export backend logs (on failure only)
if: failure()
run: |
docker compose -f ./docker/docker-compose-ci.yml logs > backend-logs-${{ matrix.node-version }}.txt

# If any prior step errors out, upload backend logs to artifact
- name: Upload backend logs to artifact (on failure only)
uses: actions/upload-artifact@v7
if: failure()
with:
name: backend-logs-${{ matrix.node-version }}
path: backend-logs-${{ matrix.node-version }}.txt
retention-days: 14

- name: Shutdown Docker containers
run: docker compose -f ./docker/docker-compose-ci.yml down

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/port_merged_pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
# Port PR to other branch (ONLY if labeled with "port to")
# See https://github.com/korthout/backport-action
- name: Create backport pull requests
uses: korthout/backport-action@v4.6.1
uses: korthout/backport-action@v4.7.0
with:
# Trigger based on a "port to [branch]" label on PR
# (This label must specify the branch name to port to)
Expand Down
101 changes: 100 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,104 @@ These configuration sources are collected **at run time**, and written to `dist/

The configuration file can be externalized by using environment variable `DSPACE_APP_CONFIG_PATH`.

#### Shared SSR cache with Redis

To share cached SSR pages across frontend processes, enable `cache.serverSide.redis.enabled` in
`config/config.prod.yml`, or set `DSPACE_CACHE_SERVERSIDE_REDIS_ENABLED=true`. Redis replaces both
in-memory SSR caches for anonymous users and bots. It requires production mode and `ssr.enabled=true`;
authenticated requests, logout reloads and routes excluded from SSR bypass the cache.

Set `DSPACE_CACHE_SERVERSIDE_REDIS_URL` to the Redis connection URL, for example
`redis://localhost:6379/0` or `rediss://username:password@host:6379/0` for TLS. Connection settings
remain server-side and are excluded from the browser configuration. Use a dedicated Redis instance
with a memory limit and an appropriate eviction policy. The LRU `max` settings do not
limit Redis memory.

To let the frontend configure a dedicated Redis instance, set:

```yaml
cache:
serverSide:
redis:
maxMemory: 512 # MiB (1024 * 1024 bytes)
evictionPolicy: allkeys-lfu # or allkeys-lru
```

`allkeys-lfu` removes the least frequently read entries; `allkeys-lru` removes the least recently
read entries. Redis uses approximate rankings and may evict entries before their TTL expires.
LRU does not mean the oldest entry by creation date. These are memory limits, not entry counts.

`maxMemory` is a whole number of MiB, converted to bytes internally. It defaults to `0`, which
leaves the Redis server settings unchanged. A positive value
applies both settings using `CONFIG SET` after every connection, including reconnects. This requires
Redis 7+ and permission to run `CONFIG SET`. Cache operations are skipped until configuration succeeds;
on failure or timeout, requests render without caching until the next successful reconnect.
All frontend instances sharing Redis must use the same settings. Returning `maxMemory` to `0`
does not undo previously applied settings. The frontend does not persist them with `CONFIG REWRITE`.

These settings affect the entire Redis instance, across all logical databases and key prefixes,
and can evict other applications' data and refresh locks. Evicted locks may allow concurrent refreshes.
Use a dedicated cache instance. For managed services or accounts without `CONFIG SET` permission,
leave `maxMemory: 0` and configure `maxmemory` and `maxmemory-policy` on the Redis server instead.
See the [Redis eviction documentation](https://redis.io/docs/latest/develop/reference/eviction/).

Set `cache.serverSide.redis.compressHtml: true` to gzip HTML before storing it in Redis.
This is disabled by default. Compressed HTML is stored as base64 alongside the headers and status,
and decompressed on read, even if compression has since been disabled. Existing uncompressed entries
remain readable. Deploy this version to all frontend instances before enabling compression;
older versions cannot read compressed entries. This setting does not change HTTP response compression.

Only routes explicitly listed in `routes` are cached. There are no global TTLs or built-in page
rules. Use `*` to opt into caching all eligible SSR pages, with more specific overrides:

```yaml
cache:
serverSide:
redis:
routes:
- pattern: '*'
timeToLive: 900000
refreshWhenTimeBelow: 300000
- pattern: '/entities/*'
timeToLive: 30000
refreshWhenTimeBelow: 10000
- pattern: '/entities/service'
timeToLive: 60000
refreshWhenTimeBelow: 20000
- pattern: '/entities/service/*'
timeToLive: 60000
refreshWhenTimeBelow: 20000
```

Patterns match the entire router-relative path without the UI namespace or query parameters.
`*` matches any characters, including `/`; all other characters are literal and case-sensitive.
Thus `/entities/service` matches that exact path, while `/entities/service/*` matches its descendants.
Exact paths take precedence. For wildcard patterns, the longest literal prefix before the first
`*` wins, followed by more literal characters, then fewer wildcards. Equal specificity uses the
first configured rule. Reordering rules with different specificity does not change their priority.

Each rule requires `timeToLive` in milliseconds. Omitted `refreshWhenTimeBelow` means no background
refreshing; values are never inherited from a broader matching rule. A zero TTL bypasses reads
and writes, including previously stored entries. Unmatched paths and an empty rules list also
bypass Redis. Rules do not override SSR exclusions. Patterns are compiled and durations validated
during cache initialization. Invalid rules disable the Redis cache with a warning while requests
continue to render. See `config/config.example.yml` for all Redis settings.

On a cache hit near expiry, one worker refreshes the page in the background while the cached page
is returned immediately. Expired pages are not served. Only responses with HTTP status 200 are cached.
HTML, configured response headers (such as signposting `Link`) and the status code are stored together.
Keys isolate deployments, language preferences and full URLs, including query strings. Choose a unique `keyPrefix` for each
deployment and change it when deploying changes that should invalidate existing cached pages.

Redis is disabled by default. When enabled but unavailable, requests are rendered without caching;
connection retries run in the background and cache operations have a bounded wait time. Disable
Redis to use the existing in-memory caches again. Set route durations according to how quickly
anonymous users need to see updates.

Run `npm run test:ssr-cache` for the server cache unit tests. To also run integration tests against
an isolated Redis instance, use `DSPACE_TEST_REDIS_URL=redis://localhost:6379 npm run test:ssr-cache`.
The integration tests use unique temporary key prefixes and remove their keys afterward.

#### Buildtime Configuring

Buildtime configuration must defined before build in order to include in transpiled JavaScript. This is primarily for the server. These settings can be found under `src/environment/` folder.
Expand Down Expand Up @@ -414,7 +512,8 @@ dspace-angular
│ ├── docker-compose.yml *
│ └── README.md *
├── docs * Folder for documentation
│ └── Configuration.md * Configuration documentation
│ ├── Configuration.md * Configuration documentation
│ └── ThemeTranslations.md * Theme-specific translations documentation
├── scripts *
│ ├── merge-i18n-files.ts *
│ ├── serve.ts *
Expand Down
1 change: 1 addition & 0 deletions angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,7 @@
"src/**/*.html",
"src/**/*.json5",
"scripts/**/*.ts",
"server/**/*.ts",
"webpack/**/*.ts"
]
}
Expand Down
52 changes: 50 additions & 2 deletions config/config.example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ ssr:
# may NOT be indexable by search engine crawlers (like Google Scholar). For search engine crawlers to fully index your site,
# this "excludePathPatterns" should NEVER exclude SSR from the homepage, community/collection pages or item/entity pages.
excludePathPatterns:
- pattern: "^/communities/[a-fA-F0-9-]{36}/browse(/.*)?$"
- pattern: "^/collections/[a-fA-F0-9-]{36}/browse(/.*)?$"
- pattern: "^/(communities|collections)/[a-fA-F0-9-]{36}/(browse|search)"
- pattern: "^/browse/"
- pattern: "^/search$"
- pattern: "^/community-list$"
Expand Down Expand Up @@ -112,6 +111,51 @@ cache:
serverSide:
# Set to true to see all cache hits/misses/refreshes in your console logs. Useful for debugging SSR caching issues.
debug: false
# Shared cache for anonymous SSR pages (including bots), replacing both LRU caches below.
# Only active with production mode and ssr.enabled=true. Disabled by default.
# Redis outages cause uncached SSR; the in-memory caches are used when Redis is disabled.
redis:
enabled: false
# Supports redis:// and rediss:// (TLS), credentials and a database number.
# Prefer DSPACE_CACHE_SERVERSIDE_REDIS_URL for connection credentials.
url: redis://localhost:6379
# Use a unique prefix per deployment; change it after deploying incompatible page changes.
keyPrefix: 'dspace:ssr:'
# Gzip HTML stored in Redis; decompressed before serving. Disabled by default.
compressHtml: false
# Applies to the ENTIRE Redis instance, including other databases and prefixes.
# Use only with a dedicated cache instance and CONFIG SET permission (Redis 7+).
# MiB (1024 * 1024 bytes). 0 leaves Redis settings unchanged; e.g. 512 = 512 MiB.
maxMemory: 0
# Used when maxMemory > 0. LFU removes least frequently read entries;
# LRU removes least recently read entries. Both may evict entries before TTL expires.
evictionPolicy: allkeys-lfu # or allkeys-lru
connectTimeout: 1000 # milliseconds
commandTimeout: 1000 # maximum time to wait for a cache operation, in milliseconds
refreshLockTimeToLive: 60000 # milliseconds; should exceed the longest SSR render
# Only explicitly configured routes are cached. Empty or unmatched routes bypass Redis.
# Patterns match the entire router-relative path, without namespace or query parameters.
# '*' matches any characters, including '/'; other characters are literal and case-sensitive.
# Exact paths win, then the longest literal prefix before '*', then more literal characters,
# then fewer wildcards. Equal specificity uses the first configured rule.
# Each route requires timeToLive (milliseconds). Zero bypasses cache reads and writes.
# refreshWhenTimeBelow is in milliseconds; omitted or zero disables background refreshing.
# Rules do not override ssr.excludePathPatterns.
routes: []
# Example (replace the empty list above to enable):
# routes:
# - pattern: '*' # optional catch-all; all eligible SSR pages
# timeToLive: 900000
# refreshWhenTimeBelow: 300000
# - pattern: '/entities/*'
# timeToLive: 30000
# refreshWhenTimeBelow: 10000
# - pattern: '/entities/service' # exact path; takes precedence over /entities/*
# timeToLive: 60000
# refreshWhenTimeBelow: 20000
# - pattern: '/entities/service/*' # service pages below this path
# timeToLive: 60000
# refreshWhenTimeBelow: 20000
# When enabled (i.e. max > 0), known bots will be sent pages from a server side cache specific for bots.
# (Keep in mind, bot detection cannot be guaranteed. It is possible some bots will bypass this cache.)
botCache:
Expand Down Expand Up @@ -406,6 +450,10 @@ homePage:
pageSize: 5
# Enable or disable the Discover filters on the homepage
showDiscoverFilters: false
# Disable if you don't want users to edit the homeNews section on your home-page.
editHomeNews: true
# Disable if you don't want users to edit the home header.
editHomeHeader: true

# Item Config
item:
Expand Down
Loading