hyrax 5.2.0 → 5.3.0

data/config/routes.rb

@@ -6,12 +6,16 @@ Hyrax::Engine.routes.draw do
   # Route the home page as the root
   root to: 'homepage#index'
 
+  get '/robots', to: 'homepage#robots'
+
   # Handle routes that existed in Hyrax < 7
   #   e.g. https://scholarsphere.psu.edu/files/gm80hv36p
   get '/files/:id', to: redirect('/concern/generic_works/%{id}')
 
   resources :downloads, only: :show
 
+  get 'transcripts/:id.:file_ext', to: 'transcripts#show', as: :transcript
+
   # ResourceSync routes
   get '/.well-known/resourcesync' => 'resource_sync#source_description', as: :source_description
   get '/capabilitylist' => 'resource_sync#capability_list', as: :capability_list
@@ -245,6 +249,11 @@ Hyrax::Engine.routes.draw do
     resource :appearance
     resources :collection_types, except: :show
     resources :collection_type_participants, only: [:create, :destroy]
+    # Metadata profiles routes
+    resources :metadata_profiles, except: [:update, :show, :destroy] do
+      collection { post :import }
+      get 'export'
+    end
   end
 
   resources :content_blocks, only: [] do

data/docker-compose-allinson.yml

@@ -0,0 +1,176 @@
+# Requires Docker Compose v2
+name: allinson
+services:
+  web:
+    build:
+      context: .
+      target: hyrax-engine-dev
+      args:
+        - EXTRA_APK_PACKAGES=git less
+        - BUNDLE_GEMFILE=Gemfile.allinson
+    image: ghcr.io/samvera/hyrax-dev:${GITHUB_SHA:-latest}
+    command: sh -c 'bundle exec puma -v -b tcp://0.0.0.0:3000'
+    stdin_open: true
+    tty: true
+    user: root
+    env_file:
+      - .koppie/.env
+    environment:
+      - APP_NAME=allinson
+      - RAILS_ROOT=/app/samvera/hyrax-webapp
+      - HYRAX_FLEXIBLE=true
+      - HYRAX_FLEXIBLE_CLASSES=Hyrax::AdministrativeSet,CollectionResource,FileSet,GenericWork,Monograph
+      - HYRAX_DISABLE_INCLUDE_METADATA=true
+    depends_on:
+      - worker
+      - chrome
+      - fits
+      - memcached
+      - postgres
+      - redis
+      - solr
+    ports:
+      - 3003:3000
+      - 9879:9876
+      - 1051:1048
+    volumes:
+      - ./bin:/app/samvera
+      - .koppie:/app/samvera/hyrax-webapp
+      - .:/app/samvera/hyrax-engine
+      - bundle:/app/bundle
+      - clamav:/var/lib/clamav
+      - hyrax-storage:/app/samvera/hyrax-webapp/storage
+      - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
+      - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
+      - rails-public:/app/samvera/hyrax-webapp/public
+      - rails-tmp:/app/samvera/hyrax-webapp/tmp
+    networks:
+      - allinson
+
+  worker:
+    image: ghcr.io/samvera/hyrax-dev:${GITHUB_SHA:-latest}
+    entrypoint: worker-entrypoint.sh
+    command: sh -c 'bundle exec sidekiq'
+    user: root
+    env_file:
+      - .koppie/.env
+    environment:
+      - APP_NAME=allinson
+      - RAILS_ROOT=/app/samvera/hyrax-webapp
+      - HYRAX_FLEXIBLE=true
+      - HYRAX_FLEXIBLE_CLASSES=Hyrax::AdministrativeSet,CollectionResource,FileSet,GenericWork,Monograph
+      - HYRAX_DISABLE_INCLUDE_METADATA=true
+    depends_on:
+      - fits
+      - memcached
+      - postgres
+      - redis
+      - solr
+    volumes:
+      - ./bin:/app/samvera
+      - .koppie:/app/samvera/hyrax-webapp
+      - .:/app/samvera/hyrax-engine
+      - bundle:/app/bundle
+      - clamav:/var/lib/clamav
+      - hyrax-storage:/app/samvera/hyrax-webapp/storage
+      - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
+      - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
+      - rails-public:/app/samvera/hyrax-webapp/public
+      - rails-tmp:/app/samvera/hyrax-webapp/tmp
+    networks:
+      - allinson
+
+  chrome:
+    image: selenium/standalone-chromium:4
+    environment:
+      #      - START_XVFB=false
+      - SE_NODE_SESSION_TIMEOUT=800
+      - SE_ENABLE_TRACING=false
+      - SE_ENABLE_BROWSER_LEFTOVERS_CLEANUP=true
+      - SE_BROWSER_ARGS_DISABLE_DSHM=--disable-dev-shm-usage
+      - SE_BROWSER_ARGS_HEADLESS=--headless=new
+    #    logging:
+    #      driver: none
+    volumes:
+      - /dev/shm:/dev/shm
+    shm_size: 2g
+    ports:
+      - "4448:4444"
+      - "5963:5900"
+      - "7963:7900"
+    networks:
+      - allinson
+
+  postgres:
+    image: postgres:15-alpine
+    env_file:
+      - .koppie/.env
+    ports:
+      - "5435:5432"
+    volumes:
+      - db:/var/lib/postgresql/data
+    networks:
+      - allinson
+
+  fits:
+    image: ghcr.io/samvera/fitsservlet:1.6.0
+    ports:
+      - 8080
+    networks:
+      - allinson
+
+  memcached:
+    image: bitnamilegacy/memcached
+    ports:
+      - "11214:11211"
+    networks:
+      - allinson
+
+  redis:
+    image: bitnamilegacy/redis:6.2
+    env_file:
+      - .koppie/.env
+    volumes:
+      - redis:/bitnamilegacy/redis/data
+    networks:
+      - allinson
+
+  solr:
+    image: solr:9.9
+    env_file:
+      - .koppie/.env
+    ports:
+      - 8986:8983
+    command:
+      - sh
+      - "-c"
+      - "precreate-core koppie-test /opt/solr/server/configsets/hyraxconf; solr-precreate koppie /opt/solr/server/configsets/hyraxconf"
+    volumes:
+      - solr_home:/var/solr:cached
+      - .koppie/solr:/opt/solr/server/configsets/hyraxconf
+    ulimits:
+      nofile:
+        soft: 65536
+        hard: 524288
+    networks:
+      - allinson
+
+volumes:
+  bundle:
+  clamav:
+  db:
+  hyrax-storage:
+  hyrax-derivatives:
+  hyrax-uploads:
+  rails-public:
+  rails-tmp:
+  redis:
+  sidekiq-public:
+  sidekiq-tmp:
+  solr_home:
+
+networks:
+  allinson:
+    driver: bridge
+    driver_opts:
+      com.docker.network.bridge.name: br-allinson

data/docker-compose-dassie.yml

@@ -15,6 +15,9 @@ services:
       - .dassie/.env
     environment:
       - RAILS_ROOT=/app/samvera/hyrax-webapp
+      - HYRAX_FLEXIBLE=false
+      - HYRAX_FLEXIBLE_CLASSES=
+      - HYRAX_DISABLE_INCLUDE_METADATA=false
     depends_on:
       - worker
       - chrome
@@ -32,6 +35,7 @@ services:
       - .dassie:/app/samvera/hyrax-webapp
       - .:/app/samvera/hyrax-engine
       - bundle:/app/bundle
+      - clamav:/var/lib/clamav
       - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
       - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
       - rails-public:/app/samvera/hyrax-webapp/public
@@ -58,6 +62,7 @@ services:
       - .dassie:/app/samvera/hyrax-webapp
       - .:/app/samvera/hyrax-engine
       - bundle:/app/bundle
+      - clamav:/var/lib/clamav
       - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
       - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
       - rails-public:/app/samvera/hyrax-webapp/public
@@ -116,23 +121,25 @@ services:
       - hyrax
 
   memcached:
-    image: bitnami/memcached
+    image: bitnamilegacy/memcached
     ports:
       - "11211:11211"
     networks:
       - hyrax
 
   redis:
-    image: bitnami/redis:6.2
+    image: bitnamilegacy/redis:6.2
     env_file:
       - .dassie/.env
     volumes:
-      - redis:/bitnami/redis/data
+      - redis:/bitnamilegacy/redis/data
     networks:
       - hyrax
 
   solr:
-    image: solr:8.11
+    image: solr:9.9
+    env_file:
+      - .dassie/.env
     ports:
       - 8983:8983
     command:
@@ -140,8 +147,8 @@ services:
       - "-c"
       - "precreate-core hyrax_test /opt/solr/server/configsets/hyraxconf; precreate-core hyrax-valkyrie-test /opt/solr/server/configsets/hyraxconf; precreate-core hyrax-valkyrie-dev /opt/solr/server/configsets/hyraxconf; solr-precreate hyrax /opt/solr/server/configsets/hyraxconf"
     volumes:
-      - solr_home:/var/solr/data:cached
-      - .dassie/solr/conf:/opt/solr/server/configsets/hyraxconf
+      - solr_home:/var/solr:cached
+      - .dassie/solr:/opt/solr/server/configsets/hyraxconf
     ulimits:
       nofile:
         soft: 65536
@@ -151,6 +158,7 @@ services:
 
 volumes:
   bundle:
+  clamav:
   db:
   fcrepo:
   hyrax-derivatives:

data/docker-compose-koppie.yml

@@ -17,6 +17,9 @@ services:
       - .koppie/.env
     environment:
       - RAILS_ROOT=/app/samvera/hyrax-webapp
+      - HYRAX_FLEXIBLE=false
+      - HYRAX_FLEXIBLE_CLASSES=
+      - HYRAX_DISABLE_INCLUDE_METADATA=false
     depends_on:
       - worker
       - chrome
@@ -34,6 +37,7 @@ services:
       - .koppie:/app/samvera/hyrax-webapp
       - .:/app/samvera/hyrax-engine
       - bundle:/app/bundle
+      - clamav:/var/lib/clamav
       - hyrax-storage:/app/samvera/hyrax-webapp/storage
       - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
       - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
@@ -60,6 +64,7 @@ services:
       - .koppie:/app/samvera/hyrax-webapp
       - .:/app/samvera/hyrax-engine
       - bundle:/app/bundle
+      - clamav:/var/lib/clamav
       - hyrax-storage:/app/samvera/hyrax-webapp/storage
       - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
       - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
@@ -71,14 +76,14 @@ services:
   chrome:
     image: selenium/standalone-chromium:4
     environment:
-#      - START_XVFB=false
+      #      - START_XVFB=false
       - SE_NODE_SESSION_TIMEOUT=800
       - SE_ENABLE_TRACING=false
       - SE_ENABLE_BROWSER_LEFTOVERS_CLEANUP=true
       - SE_BROWSER_ARGS_DISABLE_DSHM=--disable-dev-shm-usage
       - SE_BROWSER_ARGS_HEADLESS=--headless=new
-#    logging:
-#      driver: none
+    #    logging:
+    #      driver: none
     volumes:
       - /dev/shm:/dev/shm
     shm_size: 2g
@@ -108,23 +113,25 @@ services:
       - koppie
 
   memcached:
-    image: bitnami/memcached
+    image: bitnamilegacy/memcached
     ports:
-      - '11212:11211'
+      - "11212:11211"
     networks:
       - koppie
 
   redis:
-    image: bitnami/redis:6.2
+    image: bitnamilegacy/redis:6.2
     env_file:
       - .koppie/.env
     volumes:
-      - redis:/bitnami/redis/data
+      - redis:/bitnamilegacy/redis/data
     networks:
       - koppie
 
   solr:
-    image: solr:8.11
+    image: solr:9.9
+    env_file:
+      - .koppie/.env
     ports:
       - 8984:8983
     command:
@@ -132,8 +139,8 @@ services:
       - "-c"
       - "precreate-core koppie-test /opt/solr/server/configsets/hyraxconf; solr-precreate koppie /opt/solr/server/configsets/hyraxconf"
     volumes:
-      - solr_home:/var/solr/data:cached
-      - .koppie/solr/conf:/opt/solr/server/configsets/hyraxconf
+      - solr_home:/var/solr:cached
+      - .koppie/solr:/opt/solr/server/configsets/hyraxconf
     ulimits:
       nofile:
         soft: 65536
@@ -143,6 +150,7 @@ services:
 
 volumes:
   bundle:
+  clamav:
   db:
   hyrax-storage:
   hyrax-derivatives:

data/docker-compose-sirenia.yml

@@ -23,6 +23,7 @@ services:
     depends_on:
       - worker
       - chrome
+      - fcrepo
       - fits
       - memcached
       - postgres
@@ -37,6 +38,7 @@ services:
       - .koppie:/app/samvera/hyrax-webapp
       - .:/app/samvera/hyrax-engine
       - bundle:/app/bundle
+      - clamav:/var/lib/clamav
       - hyrax-storage:/app/samvera/hyrax-webapp/storage
       - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
       - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
@@ -57,7 +59,11 @@ services:
       - RAILS_ROOT=/app/samvera/hyrax-webapp
       - VALKYRIE_METADATA_ADAPTER=fedora_metadata
       - VALKYRIE_STORAGE_ADAPTER=fedora_storage
+      - HYRAX_FLEXIBLE=false
+      - HYRAX_FLEXIBLE_CLASSES=
+      - HYRAX_DISABLE_INCLUDE_METADATA=false
     depends_on:
+      - fcrepo
       - fits
       - memcached
       - postgres
@@ -68,6 +74,7 @@ services:
       - .koppie:/app/samvera/hyrax-webapp
       - .:/app/samvera/hyrax-engine
       - bundle:/app/bundle
+      - clamav:/var/lib/clamav
       - hyrax-storage:/app/samvera/hyrax-webapp/storage
       - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
       - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
@@ -79,14 +86,14 @@ services:
   chrome:
     image: selenium/standalone-chromium:4
     environment:
-#      - START_XVFB=false
+      #      - START_XVFB=false
       - SE_NODE_SESSION_TIMEOUT=800
       - SE_ENABLE_TRACING=false
       - SE_ENABLE_BROWSER_LEFTOVERS_CLEANUP=true
       - SE_BROWSER_ARGS_DISABLE_DSHM=--disable-dev-shm-usage
       - SE_BROWSER_ARGS_HEADLESS=--headless=new
-#    logging:
-#      driver: none
+    #    logging:
+    #      driver: none
     volumes:
       - /dev/shm:/dev/shm
     shm_size: 2g
@@ -134,23 +141,25 @@ services:
       - sirenia
 
   memcached:
-    image: bitnami/memcached
+    image: bitnamilegacy/memcached
     ports:
-      - '11213:11211'
+      - "11213:11211"
     networks:
       - sirenia
 
   redis:
-    image: bitnami/redis:6.2
+    image: bitnamilegacy/redis:6.2
     env_file:
       - .koppie/.env
     volumes:
-      - redis:/bitnami/redis/data
+      - redis:/bitnamilegacy/redis/data
     networks:
       - sirenia
 
   solr:
-    image: solr:8.11
+    image: solr:9.9
+    env_file:
+      - .koppie/.env
     ports:
       - 8985:8983
     command:
@@ -158,8 +167,8 @@ services:
       - "-c"
       - "precreate-core koppie-test /opt/solr/server/configsets/hyraxconf; solr-precreate koppie /opt/solr/server/configsets/hyraxconf"
     volumes:
-      - solr_home:/var/solr/data:cached
-      - .koppie/solr/conf:/opt/solr/server/configsets/hyraxconf
+      - solr_home:/var/solr:cached
+      - .koppie/solr:/opt/solr/server/configsets/hyraxconf
     ulimits:
       nofile:
         soft: 65536
@@ -189,6 +198,7 @@ services:
 
 volumes:
   bundle:
+  clamav:
   db:
   fcrepo:
   hyrax-storage:

data/documentation/copy_permalink.md

@@ -0,0 +1,29 @@
+# Copy permalink button
+
+A "Copy permalink" button on the show pages for works and collections lets a viewer copy the record's canonical, UUID-based URL to their clipboard. The canonical URL is the form `…/concern/<work_type>/<uuid>` (for works) or `…/collections/<uuid>` (for collections) — the stable URL that always identifies the record, regardless of any aliases registered for it.
+
+## Why
+
+When the redirects feature is in use, the show page commonly renders at a registered alias (e.g. `/handle/12345/678`) rather than at the canonical UUID URL. The browser address bar shows the alias. A user who copies that URL is copying the alias, which could later be edited or removed. The permalink button gives one-click access to the canonical URL so the copied link will keep working as long as the record itself exists.
+
+The button has value even without redirects enabled, because the canonical URL is the long-term stable form of the address.
+
+## Feature flag
+
+The button is gated by a Flipflop feature, `copy_permalink_button`, defaulting to **off**. Enable it per environment (via the YAML strategy) or per tenant (via the database strategy) like any other Flipflop feature. When the feature is off, no button is rendered.
+
+The feature is independent of the `redirects` feature flag — the permalink button can be enabled standalone.
+
+## What appears
+
+On a work show page, the button appears in the citations block in the left-hand column. On a collection show page, it appears in the title header next to the collection-type and permission badges. In both cases the button is visible to all users, including anonymous visitors.
+
+The button uses ClipboardJS (already a Hyrax dependency) and shows a brief Bootstrap tooltip on successful copy.
+
+## Canonical URL in the page head
+
+The work and collection show pages also include a `<link rel="canonical" href="...">` tag in the `<head>` regardless of the feature flag. This helps search engines treat the UUID-based URL as authoritative when the same record is reachable via multiple alias paths, avoiding duplicate-content penalties.
+
+## Related
+
+- [`documentation/redirects.md`](redirects.md) — the redirect aliases feature that motivates the canonical/alias distinction.

data/documentation/developing-your-hyrax-based-app.md

@@ -32,7 +32,7 @@ You can also try [Running Hyrax-based application in local VM](https://github.co
 During development, running only the dependent services in a container environment may be beneficial. This avoids potential headaches concerning file permissions and eases the use of debugging tools. The application generation instructions below use [Lando](https://lando.dev) to achieve this setup.
 
 This document contains instructions specific to setting up an app with __Hyrax
-v5.2.0__. If you are looking for instructions on installing a different
+v5.3.0__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 
@@ -148,7 +148,7 @@ Generate a new Rails application using the template.
 **NOTE:** `HYRAX_SKIP_WINGS` is needed here to avoid loading the Wings compatibility layer during the application generation process.
 
 ```shell
-HYRAX_SKIP_WINGS=true rails _7.2.2.1_ new my_app --database=postgresql -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v5.2.0/template.rb
+HYRAX_SKIP_WINGS=true rails _7.2.2.1_ new my_app --database=postgresql -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v5.3.0/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including: