Archivematica - User contributions [en]

Development roadmap: Archivematica

2026-01-13T14:12:14Z

Dcerna: Update Roadmap link

[[Main Page]] > [[Development]] > Development roadmap

<div style="padding: 10px 10px; border: 1px solid black; background-color: #F79086;">This roadmap page is no longer being maintained. We are now tracking the Archivematica roadmap in [https://github.com/archivematica/Issues/wiki/Archivematica-Roadmap GitHub]. Please subscribe to the [https://groups.google.com/forum/#!forum/archivematica Archivematica Google Group] for release and roadmap related announcements. </div> <p>

= Archivematica development roadmap =

This roadmap describes what [http://www.artefactual.com/ Artefactual] is working on for the Archivematica system. '''Sponsored''' work, that is development of features and enhancements which is funded by our development partners, is prioritized. On our '''wishlist''', we have also included enhancements and features that we would like to see or that the community has shown interest in; however, without development resources allocated to us or contributions from developers outside of Artefactual, we cannot guarantee their inclusion.

Reflecting the [http://en.wikipedia.org/wiki/Open-source_bounty bounty business model] for open source development, each feature is developed in partnership with an institution or group of institutions with unique workflow needs. Despite our best efforts to keep features as generic as possible, some extra development may be necessary for a feature to function well in your own environment. Please see the [http://www.artefactual.com/services/archivematica/ Archivematica services] offered on Artefactual's website to find out more about how to become a development partner, get training and support, or take advantage of installation services.

We will issue public releases incrementally upon completion and testing of the sponsored features and enhancements listed below. All features are subject to code review and QA, the results of which may result in any feature being pushed to a future release.

==Artefactual Labs==
* For other cool stuff we're working on, see [https://github.com/artefactual-labs Artefactual Labs]

==Features by release number==

===1.7.1===
See the 1.7.1 Milestone on our [https://waffle.io/artefactual/archivematica?search=cul:%20phase%202&milestone=1.7.1 Waffleboard] for more information or our [[Archivematica_1.7.1_release_notes| 1.7.1 release notes]] for specific pull requests.

*'''Sponsored''' (Columbia University Library) Performance enhancements
**Change MCPClient to stop sending tool outputs through the job scheduler
**Change MCPServer to require only return code from client tasks

*Fix encrypted AIP storage spaces on centos/ansible installs (0.11.1)
*Fix storage for encrypted uncompressed AIPs (0.11.1)

===1.7/0.11===

*'''Sponsored''' (PREFORMA/MediaArea) MediaConch integration for audio-visual format verification
*'''Sponsored''' (Rockefeller Archives Centre) Importing object-level PREMIS rights via CSV
** Allows users to apply PREMIS rights to individual objects, rather than having all of the objects in the transfer inherit rights applied to the SIP via the Add Rights metadata form, using a CSV file included with the transfer
*'''Sponsored''' (Canadian Council of Archives) Enable internationalization and localization of Archivematica
** This will allow the Archivematica interface to be translated into languages other than English, using a translation system or application
*'''Sponsored''' (Canadian Centre for Architecture) Change METS encoding to UTF-8
*'''Sponsored''' (Canadian Centre for Architecture) Use default access rule if normal rule errors
*'''Sponsored''' (Bentley Historical Library) Allow zip as archive format for AIPs stored in DSpace
*'''Sponsored''' (Museum of Modern Art New York) AIP migration
** This allows AIPs to be moved from one location to another via a new API endpoint. The API takes two arguments: 1) UUID of an existing package (AIP or DIP or transfer) and 2) the UUID of a Location.

===Proposed/in development/experimental===

These features are works in progress or have experimental/proof of concept status.

See also, [[Improvements]]

*'''Sponsored''' (Simon Fraser University Archives) WARC file ingest
** Analyze WARC header information and prepare metadata mapping to Archivematica AIP METS file
** Add Archivematica micro-services to parse WARC header information to Archivematica METS file
*'''Sponsored''' (Ontario Council of University Libraries) Dataverse integration (proof of concept)
** The scope of sponsored work is a proof of concept model for integration of Dataverse with Archivematica. As design/development progresses, we will update the development roadmap accordingly.
*'''Sponsored''' (University of York/University of Hull) Automated DIP generation workflow
** Change workflow so that the ‘upload DIP’ choice can be preconfigured
** Update AIP reingest workflow to allow uncompressed AIPs to be reingested. (DONE, version 1.6/0.10)
** Enhance the callback functionality in the Storage Service, to notify third party apps when a DIP is ready to be used.
*'''Sponsored''' (University of York/University of Hull) METS parsing tools
** Develop the public facing API of the REST service and define the API to return answers as JSON-LD or another linked data format
** Develop a python METSReader library that would live behind the REST service
** Write documentation for the REST service
*'''Sponsored''' (University of York/University of Hull) Generic search REST API (proof-of-concept)
** Develop the public facing API of the REST service, a read-only API to provide a small number of endpoints to answer basic questions about the number of files in storage, their formats, date of ingest, etc.
** Develop functionality in the Archivematica Storage Service to implement this API
** Write documentation for the REST API
*'''Sponsored''' (University of York/University of Hull) Enhance PRONOM integration
** Allow a user to manually assign pronom IDs to non-identified files; record manual selection in the AIP METS file
** Provide report of non-identified files in a SIP or AIP, with access to the file identification tool output
** Provide direct access to the PRONOM submission form from within Archivematica.
*'''Sponsored''' (University of York/University of Hull) Automation tools documentation

===Fixity app===

*'''Sponsored''' (Simon Fraser University Archives) Better end-user documentation for the fixity app.

==Wish list==
This section describes enhancements and features that the Archivematica community would like to see researched and implemented; however, without development resources allocated to us or contributions from developers outside of Artefactual, we cannot guarantee their inclusion in an upcoming release. Also see unsponsored features/tasks/bugs without assigned releases: [http://bit.ly/1eW9yRs unsponsored and unscheduled fixes, features and tasks]

===Dashboard===
*'''User interface'''
** Upload submission documentation during transfer upload #1910
** Administrative dashboard interface for system monitoring, including status, restart services, maintenance of backups, tools for restoring, automatic indexing of ElasticSearch index
** Indicator in dashboard of decision made at decision points
** Indicator that Archivematica is currently processing
** Status indicator to show current status of transfer/job
** Reconsider icons and access to the Add Metadata / Rights templates (currently the icon matches the ‘report’ icon and it’s unclear when is the ‘right’ time to add metadata) and the Reminder: add metadata micro-service
** Access tab, Archival Storage tab, Preservation Planning tab should have description of purpose of tab
** Treat each tab as its own web application
** Administrative access to Storage Service from Access tab
** Task cogs containing no information should have a short descriptive indicator of why there is none (ie no tool output available)
** Ability to choose a fallback identification tool when the selected tool fails
** Hide AtoM user password in the user interface
*'''SIP arrangement''' See also #6791
** Visualization of transfer contents - #1578, [[Transfer and SIP creation#File visualization reporting page]]
** Clean up of transfer backlog once arrangement is complete - in dashboard Admin? in Ingest?
** Increase icon size and fix 'jumpiness' of content indicators
** Include tooltips for buttons
** Consider name change of 'originals' pane to 'transfer backlog search results' or the like
** Create delete package request from Transfer backlog
*'''Deposit tool'''
** Configure transfer in GUI rather than in local filesystem for complex workflows (ie. adding metadata files, checksums, manually normalized content, etc)
** Upload submission documentation (see above, may consider in Transfer dashboard tab)
** Provide download link to METS file in AIP review that doesn't involve opening in browser (for larger METS files which timeout)
*'''Email ingest workflow'''
** Improvements to e-mail ingest workflow (maildir)
*'''AIP Reingest'''
** Include option to run microservices on previously normalized files

===Metadata===
* Capture PREMIS from external systems
* Field validation in PREMIS rights templates - #1519
* METS refactoring and METS generation improvements
** develop standalone Python METS reader/writer application and distribute separately from and integrated with Archivematica
** In progress, see [https://github.com/artefactual-labs/mets-reader-writer METS Reader & Writer]
* Change encoding of the METS file to UTF-8

===Format Policy Registry===
* Format Policy Registry (FPR) public site UI
* Ability to send local format policy changes to the FPR public site #5074

===Storage Service===
* Move some/all DIP upload responsibilities to SS
* Move Index AIP micro-service to SS
* Automated deletion of content in transfer source once a successful AIP has been created and stored
* Ability to send AIPs/DIPs to duplicate locations
* Re-index transfer backlog, AIPs and DIPs - ElasticSearch re-indexing
* Ability to select multiple packages from SS to download at once
* Persistent data about stored AIPs and DIPs
* DIP generation/upload info logged to pointer file
* SAMBA plugin for Storage API
* Move ElasticSearch to SS
* Research management of processing space, so a transfer cannot be run if it's too big for the allotted space

===Integration===
* AtoM - Send PREMIS rights metadata with DIP
* Hydra (Ingest, AIP storage, API plugin)
* DSpace (Ingest, DIP upload)
* BitCurator integration: packages, bulk extractor reporting, how much functionality/data can be integrated/re-used prior to Archivematica ingest #1869

===Fixity app===
* Add flag specifying number of AIPs to check simultaneously

Archivematica 1.18.0 and Storage Service 0.24.0 release notes

2025-09-26T19:29:20Z

Dcerna: /* Elasticsearch 8.x */

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.18.0 and Storage Service 0.24.0

'''Release date: September 26, 2025'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.18/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.18.0 and Storage Service 0.24.0 have been tested in the following environments:

* Ubuntu 24.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== Elasticsearch 8.x ===

* Issue: https://github.com/archivematica/Issues/issues/1752

Archivematica 1.18.0 no longer supports Elasticsearch 6.x and is now compatible with version 8.x. For instructions on migrating your Elasticsearch data, refer to the [https://www.archivematica.org/en/docs/archivematica-1.18/admin-manual/installation-setup/upgrading/upgrading/#upgrade-elasticsearch Upgrade Elasticsearch from 6.x to 8.x] section of the Upgrade page in the documentation.

=== Ubuntu 24.04 ===

* Issue: https://github.com/archivematica/Issues/issues/1729

Archivematica 1.18.0 supports Ubuntu 24.04 and drops support for Ubuntu 20.04.

=== JHOVE validation commands ===

* Issue: https://github.com/archivematica/Issues/issues/1723

New JHOVE validation commands have been implemented to prevent false positives that occur when [https://github.com/openpreserve/jhove/issues/395 JHOVE encounters the built-in BYTESTREAM module] following validation errors. The existing validation rules have been updated to use these new commands.

The new commands also capture errors from the command output and include them in the outcome detail note of the <code>validation</code> PREMIS event within the METS file.

Special thanks to Felicitas Günther for sharing their error-handling implementation.

=== JHOVE 1.34.0 ===

* Issue: https://github.com/archivematica/Issues/issues/1730

=== PRONOM v120 ===

* Issue: https://github.com/archivematica/Issues/issues/1725

=== Cookie configuration improvements ===

New application variables have been added to control cookie flags (Secure, HttpOnly, SameSite) in the Archivematica Dashboard and Storage Service. This change enhances session protection and reduces risks such as session hijacking and cross-site request forgery, particularly in HTTPS deployments.

Because default values for several cookie-related settings have changed, this update is backward incompatible with previous deployments. In particular, if your deployment is not using HTTPS, you must explicitly set the <code>*_SESSION_COOKIE_SECURE</code> and <code>*_CSRF_COOKIE_SECURE</code> application variables to <code>false</code> to restore the previous behavior. Deployments already configured with HTTPS should not be affected by these changes. Administrators should review their settings to take advantage of these options ensuring deployment configurations are updated to align with these stricter defaults.

<b>Note on OIDC authentication</b>: If your deployment uses OIDC authentication across different domains, you may need to adjust the <code>*_SESSION_COOKIE_SAMESITE</code> settings. By default, they are set to <code>Strict</code>, which may prevent cross-domain login flows. In such cases, relax the settings to <code>Lax</code> to allow OIDC authentication to function correctly across domains.

{|class="wikitable"
|+ Dashboard application variables
|-
! Variable Name !! Previous Value !! New Value
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_HTTPONLY</code> || <code>false</code> || <code>false</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|}

{|class="wikitable"
|+ Storage Service application-specific environment variables
|-
! Variable Name !! Previous Value !! New Value
|-
| <code>SESSION_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>SESSION_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>SESSION_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|-
| <code>CSRF_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>CSRF_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>CSRF_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|}

== Fixed ==

=== Users must re-authenticate when changing their passwords ===

* Issue: https://github.com/archivematica/Issues/issues/1757

=== User API keys are not displayed anymore ===

* Issue: https://github.com/archivematica/Issues/issues/1736
* Issue: https://github.com/archivematica/Issues/issues/1738

=== METS file generation works with bags with no metadata ===

* Issue: https://github.com/archivematica/Issues/issues/1697

=== Transfer status check has been optimized ===

* Issue: https://github.com/archivematica/Issues/issues/1741

Special thanks to [https://github.com/liam-lloyd Liam Lloyd-Tucker] for this contribution.

=== Transcribe job handles invalid arguments ===

* Issue: https://github.com/archivematica/Issues/issues/1751

Please see the 1.18.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/27?closed=1.

Archivematica 1.18.0 and Storage Service 0.24.0 release notes

2025-09-26T15:31:20Z

Dcerna:

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.18.0 and Storage Service 0.24.0

'''Release date: September 26, 2025'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.18/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.18.0 and Storage Service 0.24.0 have been tested in the following environments:

* Ubuntu 24.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== Elasticsearch 8.x ===

* Issue: https://github.com/archivematica/Issues/issues/1752

Archivematica 1.18.0 no longer supports Elasticsearch 6.x and is now compatible with version 8.x. For instructions on migrating your Elasticsearch data, refer to the [https://www.archivematica.org Upgrade Elasticsearch from 6.x to 8.x] section of the Upgrade page in the documentation.

=== Ubuntu 24.04 ===

* Issue: https://github.com/archivematica/Issues/issues/1729

Archivematica 1.18.0 supports Ubuntu 24.04 and drops support for Ubuntu 20.04.

=== JHOVE validation commands ===

* Issue: https://github.com/archivematica/Issues/issues/1723

New JHOVE validation commands have been implemented to prevent false positives that occur when [https://github.com/openpreserve/jhove/issues/395 JHOVE encounters the built-in BYTESTREAM module] following validation errors. The existing validation rules have been updated to use these new commands.

The new commands also capture errors from the command output and include them in the outcome detail note of the <code>validation</code> PREMIS event within the METS file.

Special thanks to Felicitas Günther for sharing their error-handling implementation.

=== JHOVE 1.34.0 ===

* Issue: https://github.com/archivematica/Issues/issues/1730

=== PRONOM v120 ===

* Issue: https://github.com/archivematica/Issues/issues/1725

=== Cookie configuration improvements ===

New application variables have been added to control cookie flags (Secure, HttpOnly, SameSite) in the Archivematica Dashboard and Storage Service. This change enhances session protection and reduces risks such as session hijacking and cross-site request forgery, particularly in HTTPS deployments.

Because default values for several cookie-related settings have changed, this update is backward incompatible with previous deployments. In particular, if your deployment is not using HTTPS, you must explicitly set the <code>*_SESSION_COOKIE_SECURE</code> and <code>*_CSRF_COOKIE_SECURE</code> application variables to <code>false</code> to restore the previous behavior. Deployments already configured with HTTPS should not be affected by these changes. Administrators should review their settings to take advantage of these options ensuring deployment configurations are updated to align with these stricter defaults.

<b>Note on OIDC authentication</b>: If your deployment uses OIDC authentication across different domains, you may need to adjust the <code>*_SESSION_COOKIE_SAMESITE</code> settings. By default, they are set to <code>Strict</code>, which may prevent cross-domain login flows. In such cases, relax the settings to <code>Lax</code> to allow OIDC authentication to function correctly across domains.

{|class="wikitable"
|+ Dashboard application variables
|-
! Variable Name !! Previous Value !! New Value
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_HTTPONLY</code> || <code>false</code> || <code>false</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|}

{|class="wikitable"
|+ Storage Service application-specific environment variables
|-
! Variable Name !! Previous Value !! New Value
|-
| <code>SESSION_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>SESSION_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>SESSION_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|-
| <code>CSRF_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>CSRF_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>CSRF_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|}

== Fixed ==

=== Users must re-authenticate when changing their passwords ===

* Issue: https://github.com/archivematica/Issues/issues/1757

=== User API keys are not displayed anymore ===

* Issue: https://github.com/archivematica/Issues/issues/1736
* Issue: https://github.com/archivematica/Issues/issues/1738

=== METS file generation works with bags with no metadata ===

* Issue: https://github.com/archivematica/Issues/issues/1697

=== Transfer status check has been optimized ===

* Issue: https://github.com/archivematica/Issues/issues/1741

Special thanks to [https://github.com/liam-lloyd Liam Lloyd-Tucker] for this contribution.

=== Transcribe job handles invalid arguments ===

* Issue: https://github.com/archivematica/Issues/issues/1751

Please see the 1.18.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/27?closed=1.

Release Notes

2025-09-25T22:33:06Z

Dcerna: /* Archivematica 1.x releases */

[[Main_Page|Home]] > Release Notes

== About ==

Release notes are prepared by Artefactual for each release of Archivematica. Most releases also have a corresponding release of the Storage System, and may also include corresponding releases for various dependencies and libraries (i.e. FIDO, Automation Tools) - be sure to check the release notes for more information.

Major releases are '''bolded''', minor releases are not.

Features, enhancements, and bug fixes are often sponsored by members of the Archivematica community who are dedicated to funding Archivematica's ongoing development and maintenance. Code contributors are individuals who write Archivematica code and [https://github.com/artefactual/archivematica/blob/stable/1.6.x/CONTRIBUTING.md| contribute it] back to the project. Archivematica couldn't continue to grow without sponsors and contributors - thank you!

Questions about a release or the release notes? Ask on the [https://groups.google.com/forum/#!forum/archivematica| Archivematica Google Group!]

== Security patches ==

* [[Log4j|Log4j vulnerability information]] Updated December 13, 2021

== Archivematica 1.x releases ==

* [[Archivematica_1.18.0_and_Storage_Service_0.24.0_release_notes|'''Archivematica 1.18.0 and Storage Service 0.24.0 Release Notes''']] (Current release)
* [[Archivematica_1.17.1_release_notes|Archivematica 1.17.1 Release Notes]]
* [[Archivematica_1.17.0_and_Storage_Service_0.23.0_release_notes|'''Archivematica 1.17.0 and Storage Service 0.23.0 Release Notes''']]
* [[Archivematica_1.16.0_and_Storage_Service_0.22.0_release_notes|'''Archivematica 1.16.0 and Storage Service 0.22.0 Release Notes''']]
* [[Archivematica_1.15.1_and_Storage_Service_0.21.1_release_notes|Archivematica 1.15.1 and Storage Service 0.21.1 Release Notes]]
* [[Archivematica_1.15.0_and_Storage_Service_0.21.0_release_notes|'''Archivematica 1.15.0 and Storage Service 0.21.0 Release Notes''']]
* [[Archivematica_1.14.1_and_Storage_Service_0.20.1_release_notes|Archivematica 1.14.1 and Storage Service 0.20.1 Release Notes]]
* [[Archivematica_1.14.0_and_Storage_Service_0.20.0_release_notes|'''Archivematica 1.14.0 and Storage Service 0.20.0 Release Notes''']]
* [[Storage Service 0.19 Release Notes|'''Storage Service 0.19 Release Notes''']]
* [[Archivematica_1.13.2|Archivematica 1.13.2 Release Notes]]
* [[Archivematica_1.13.1_and_Storage_Service_0.18.1_release_notes|'''Archivematica 1.13.1 and Storage Service 0.18.1 Release Notes''']]
* [[Archivematica_1.13.0_and_Storage_Service_0.18.0_release_notes|'''Archivematica 1.13.0 and Storage Service 0.18.0 Release Notes''']]
* [[Archivematica_1.12.2|Archivematica 1.12.2 Release Notes]]
* [[Archivematica_1.12.1_and_Storage_Service_0.17.1_release_notes|Archivematica 1.12.1 and Storage Service 0.17.1 Release Notes]]
* [[Archivematica_1.12.0_and_Storage_Service_0.17.0_release_notes|'''Archivematica 1.12.0 and Storage Service 0.17.0 Release Notes''']]
* [[Archivematica_1.11.2_and_Storage_Service_0.16.1_release_notes|Archivematica 1.11.2 and Storage Service 0.16.1 Release Notes]]
* [[Archivematica_1.11.1|Archivematica 1.11.1 Release Notes]]
* [[Archivematica_1.11_and_Storage_Service_0.16_release_notes|'''Archivematica 1.11 and Storage Service 0.16 Release Notes''']]
* [[Archivematica_1.10.2|Archivematica 1.10.2 Release Notes]]
* [[Archivematica_1.10.1_release_notes|Archivematica 1.10.1 and Storage Service 0.15.1 Release Notes]]
* [[Archivematica_1.10_and_Storage_Service_0.15_release_notes|'''Archivematica 1.10 and Storage Service 0.15 Release Notes''']]
* [[Archivematica_1.9.3|Archivematica 1.9.3 Release Notes]]
* [[Archivematica_1.9.2_release_notes|Archivematica 1.9.2 Release Notes]]
* [[Archivematica_1.9.1_and_Storage_Service_0.14.1_release_notes|Archivematica 1.9.1 and Storage Service 0.14.1 Release Notes]]
* [[Archivematica_1.9_and_Storage_Service_0.14_release_notes|'''Archivematica 1.9 and Storage Service 0.14 Release Notes''']]
* [[Archivematica_1.8.1_release_notes|Archivematica 1.8.1 Release Notes]]
* [[Archivematica_1.8_and_Storage_Service_0.13_release_notes|'''Archivematica 1.8 and Storage Service 0.13 Release Notes''']]
* [[Archivematica 1.7.2_release_notes|Archivematica 1.7.2 Release Notes]]
* [[Storage Service 0.12 Release Notes|'''Storage Service 0.12 Release Notes''']]
* [[Archivematica 1.7.1_release_notes|Archivematica 1.7.1 Release Notes]]
* [[Storage Service 0.11.1 Release Notes]]
* [[Archivematica_1.7_and_Storage_Service_0.11_release_notes|'''Archivematica 1.7 and Storage Service 0.11 Release Notes''']]
* [[Archivematica_1.6.1_release_notes|Archivematica 1.6.1 Release Notes]]
* [[Archivematica_1.6_release_notes|'''Archivematica 1.6 Release Notes''']]
* [[Archivematica_1.5.1_Release_Notes|Archivematica 1.5.1 Release Notes]]
* [[Archivematica_1.5_Release_Notes|'''Archivematica 1.5 Release Notes''']]
* [[Archivematica_1.4.1_Release_Notes|Archivematica 1.4.1 Release Notes]]
* [[Archivematica_1.4_Release_Notes|'''Archivematica 1.4 Release Notes''']]
* [[Archivematica_1.3.2_Release_Notes|Archivematica 1.3.2 Release Notes]]
* [[Archivematica_1.3.1_Release_Notes|Archivematica 1.3.1 Release Notes]]
* [[Archivematica_1.3_Release_Notes|'''Archivematica 1.3 Release Notes''']]
* [[Archivematica_1.2_Release_Notes|'''Archivematica 1.2 Release Notes''']]
* [[Archivematica_1.1_Release_Notes|'''Archivematica 1.1 Release Notes''']]
* [[Archivematica_1.0_Release_Notes|'''Archivematica 1.0 Release Notes''']]

== Archivematica 0.x releases ==

* [[Archivematica_0.10-beta_Release_Notes|'''Archivematica 0.10 Release Notes''']]
* [[Archivematica_0.9_Release_Notes|'''Archivematica 0.9 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.8 Release Notes''']]
* [[Archivematica_0.7.1_Release_Notes|Archivematica 0.7.1 Release Notes]]
* [[Archivematica_0.7_Release_Notes|'''Archivematica 0.7 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.6 Release Notes''']]

== Templates ==

* [[Major_release_notes|Template for major releases]]
* [[Minor_release_notes|Template for minor releases]]

Archivematica 1.18.0 and Storage Service 0.24.0 release notes

2025-09-25T22:31:50Z

Dcerna:

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.18.0 and Storage Service 0.24.0

'''Release date: September 25, 2025'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.18/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.18.0 and Storage Service 0.24.0 have been tested in the following environments:

* Ubuntu 24.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== Elasticsearch 8.x ===

* Issue: https://github.com/archivematica/Issues/issues/1752

Archivematica 1.18.0 no longer supports Elasticsearch 6.x and is now compatible with version 8.x. For instructions on migrating your Elasticsearch data, refer to the [https://www.archivematica.org Upgrade Elasticsearch from 6.x to 8.x] section of the Upgrade page in the documentation.

=== Ubuntu 24.04 ===

* Issue: https://github.com/archivematica/Issues/issues/1729

Archivematica 1.18.0 supports Ubuntu 24.04 and drops support for Ubuntu 20.04.

=== JHOVE validation commands ===

* Issue: https://github.com/archivematica/Issues/issues/1723

New JHOVE validation commands have been implemented to prevent false positives that occur when [https://github.com/openpreserve/jhove/issues/395 JHOVE encounters the built-in BYTESTREAM module] following validation errors. The existing validation rules have been updated to use these new commands.

The new commands also capture errors from the command output and include them in the outcome detail note of the <code>validation</code> PREMIS event within the METS file.

Special thanks to Felicitas Günther for sharing their error-handling implementation.

=== JHOVE 1.34.0 ===

* Issue: https://github.com/archivematica/Issues/issues/1730

=== PRONOM v120 ===

* Issue: https://github.com/archivematica/Issues/issues/1725

=== Cookie configuration improvements ===

New application variables have been added to control cookie flags (Secure, HttpOnly, SameSite) in the Archivematica Dashboard and Storage Service. This change enhances session protection and reduces risks such as session hijacking and cross-site request forgery, particularly in HTTPS deployments.

Because default values for several cookie-related settings have changed, this update is backward incompatible with previous deployments. In particular, if your deployment is not using HTTPS, you must explicitly set the <code>*_SESSION_COOKIE_SECURE</code> and <code>*_CSRF_COOKIE_SECURE</code> application variables to <code>false</code> to restore the previous behavior. Deployments already configured with HTTPS should not be affected by these changes. Administrators should review their settings to take advantage of these options ensuring deployment configurations are updated to align with these stricter defaults.

<b>Note on OIDC authentication</b>: If your deployment uses OIDC authentication across different domains, you may need to adjust the <code>*_SESSION_COOKIE_SAMESITE</code> settings. By default, they are set to <code>Strict</code>, which may prevent cross-domain login flows. In such cases, relax the settings to <code>Lax</code> to allow OIDC authentication to function correctly across domains.

{|class="wikitable"
|+ Dashboard application variables
|-
! Variable Name !! Previous Value !! New Value
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_HTTPONLY</code> || <code>false</code> || <code>false</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|}

{|class="wikitable"
|+ Storage Service application-specific environment variables
|-
! Variable Name !! Previous Value !! New Value
|-
| <code>SESSION_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>SESSION_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>SESSION_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|-
| <code>CSRF_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>CSRF_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>CSRF_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|}

== Fixed ==

=== Users must re-authenticate when changing their passwords ===

* Issue: https://github.com/archivematica/Issues/issues/1757

=== User API keys are not displayed anymore ===

* Issue: https://github.com/archivematica/Issues/issues/1736
* Issue: https://github.com/archivematica/Issues/issues/1738

=== METS file generation works with bags with no metadata ===

* Issue: https://github.com/archivematica/Issues/issues/1697

=== Transfer status check has been optimized ===

* Issue: https://github.com/archivematica/Issues/issues/1741

Special thanks to [https://github.com/liam-lloyd Liam Lloyd-Tucker] for this contribution.

=== Transcribe job handles invalid arguments ===

* Issue: https://github.com/archivematica/Issues/issues/1751

Please see the 1.18.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/27?closed=1.

Archivematica 1.18.0 and Storage Service 0.24.0 release notes

2025-09-25T19:36:51Z

Dcerna: Add OIDC authentication cookie settings clarification

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.18.0 and Storage Service 0.24.0

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.18/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.18.0 and Storage Service 0.24.0 have been tested in the following environments:

* Ubuntu 24.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== Elasticsearch 8.x ===

* Issue: https://github.com/archivematica/Issues/issues/1752

Archivematica 1.18.0 no longer supports Elasticsearch 6.x and is now compatible with version 8.x. For instructions on migrating your Elasticsearch data, refer to the [https://www.archivematica.org Upgrade Elasticsearch from 6.x to 8.x] section of the Upgrade page in the documentation.

=== Ubuntu 24.04 ===

* Issue: https://github.com/archivematica/Issues/issues/1729

Archivematica 1.18.0 supports Ubuntu 24.04 and drops support for Ubuntu 20.04.

=== JHOVE validation commands ===

* Issue: https://github.com/archivematica/Issues/issues/1723

New JHOVE validation commands have been implemented to prevent false positives that occur when [https://github.com/openpreserve/jhove/issues/395 JHOVE encounters the built-in BYTESTREAM module] following validation errors. The existing validation rules have been updated to use these new commands.

The new commands also capture errors from the command output and include them in the outcome detail note of the <code>validation</code> PREMIS event within the METS file.

Special thanks to Felicitas Günther for sharing their error-handling implementation.

=== JHOVE 1.34.0 ===

* Issue: https://github.com/archivematica/Issues/issues/1730

=== PRONOM v120 ===

* Issue: https://github.com/archivematica/Issues/issues/1725

=== Cookie configuration improvements ===

New application variables have been added to control cookie flags (Secure, HttpOnly, SameSite) in the Archivematica Dashboard and Storage Service. This change enhances session protection and reduces risks such as session hijacking and cross-site request forgery, particularly in HTTPS deployments.

Because default values for several cookie-related settings have changed, this update is backward incompatible with previous deployments. In particular, if your deployment is not using HTTPS, you must explicitly set the <code>*_SESSION_COOKIE_SECURE</code> and <code>*_CSRF_COOKIE_SECURE</code> application variables to <code>false</code> to restore the previous behavior. Deployments already configured with HTTPS should not be affected by these changes. Administrators should review their settings to take advantage of these options ensuring deployment configurations are updated to align with these stricter defaults.

<b>Note on OIDC authentication</b>: If your deployment uses OIDC authentication across different domains, you may need to adjust the <code>*_SESSION_COOKIE_SAMESITE</code> settings. By default, they are set to <code>Strict</code>, which may prevent cross-domain login flows. In such cases, relax the settings to <code>Lax</code> to allow OIDC authentication to function correctly across domains.

{|class="wikitable"
|+ Dashboard application variables
|-
! Variable Name !! Previous Value !! New Value
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_HTTPONLY</code> || <code>false</code> || <code>false</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|}

{|class="wikitable"
|+ Storage Service application-specific environment variables
|-
! Variable Name !! Previous Value !! New Value
|-
| <code>SESSION_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>SESSION_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>SESSION_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|-
| <code>CSRF_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>CSRF_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>CSRF_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|}

== Fixed ==

=== Users must re-authenticate when changing their passwords ===

* Issue: https://github.com/archivematica/Issues/issues/1757

=== User API keys are not displayed anymore ===

* Issue: https://github.com/archivematica/Issues/issues/1736
* Issue: https://github.com/archivematica/Issues/issues/1738

=== METS file generation works with bags with no metadata ===

* Issue: https://github.com/archivematica/Issues/issues/1697

=== Transfer status check has been optimized ===

* Issue: https://github.com/archivematica/Issues/issues/1741

Special thanks to [https://github.com/liam-lloyd Liam Lloyd-Tucker] for this contribution.

=== Transcribe job handles invalid arguments ===

* Issue: https://github.com/archivematica/Issues/issues/1751

Please see the 1.18.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/27?closed=1.

Archivematica 1.18.0 and Storage Service 0.24.0 release notes

2025-09-16T23:41:00Z

Dcerna: Add cookie configuration improvements notes

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.18.0 and Storage Service 0.24.0

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.18/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.18.0 and Storage Service 0.24.0 have been tested in the following environments:

* Ubuntu 24.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== Elasticsearch 8.x ===

* Issue: https://github.com/archivematica/Issues/issues/1752

Archivematica 1.18.0 no longer supports Elasticsearch 6.x and is now compatible with version 8.x. For instructions on migrating your Elasticsearch data, refer to the [https://www.archivematica.org Upgrade Elasticsearch from 6.x to 8.x] section of the Upgrade page in the documentation.

=== Ubuntu 24.04 ===

* Issue: https://github.com/archivematica/Issues/issues/1729

Archivematica 1.18.0 supports Ubuntu 24.04 and drops support for Ubuntu 20.04.

=== JHOVE validation commands ===

* Issue: https://github.com/archivematica/Issues/issues/1723

New JHOVE validation commands have been implemented to prevent false positives that occur when [https://github.com/openpreserve/jhove/issues/395 JHOVE encounters the built-in BYTESTREAM module] following validation errors. The existing validation rules have been updated to use these new commands.

The new commands also capture errors from the command output and include them in the outcome detail note of the <code>validation</code> PREMIS event within the METS file.

Special thanks to Felicitas Günther for sharing their error-handling implementation.

=== JHOVE 1.34.0 ===

* Issue: https://github.com/archivematica/Issues/issues/1730

=== PRONOM v120 ===

* Issue: https://github.com/archivematica/Issues/issues/1725

=== Cookie configuration improvements ===

New application variables have been added to control cookie flags (Secure, HttpOnly, SameSite) in the Archivematica Dashboard and Storage Service. This change enhances session protection and reduces risks such as session hijacking and cross-site request forgery, particularly in HTTPS deployments.

Because default values for several cookie-related settings have changed, this update is backward incompatible with previous deployments. In particular, if your deployment is not using HTTPS, you must explicitly set the <code>*_SESSION_COOKIE_SECURE</code> and <code>*_CSRF_COOKIE_SECURE</code> application variables to <code>false</code> to restore the previous behavior. Deployments already configured with HTTPS should not be affected by these changes. Administrators should review their settings to take advantage of these options ensuring deployment configurations are updated to align with these stricter defaults:

{|class="wikitable"
|+ Dashboard application variables
|-
! Variable Name !! Previous Value !! New Value
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_SESSION_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_HTTPONLY</code> || <code>false</code> || <code>false</code>
|-
| <code>ARCHIVEMATICA_DASHBOARD_DASHBOARD_CSRF_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|}

{|class="wikitable"
|+ Storage Service application-specific environment variables
|-
! Variable Name !! Previous Value !! New Value
|-
| <code>SESSION_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>SESSION_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>SESSION_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|-
| <code>CSRF_COOKIE_SECURE</code> || <code>false</code> || <code>true</code>
|-
| <code>CSRF_COOKIE_HTTPONLY</code> || <code>false</code> || <code>true</code>
|-
| <code>CSRF_COOKIE_SAMESITE</code> || <code>Lax</code> || <code>Strict</code>
|}

== Fixed ==

=== Users must re-authenticate when changing their passwords ===

* Issue: https://github.com/archivematica/Issues/issues/1757

=== User API keys are not displayed anymore ===

* Issue: https://github.com/archivematica/Issues/issues/1736
* Issue: https://github.com/archivematica/Issues/issues/1738

=== METS file generation works with bags with no metadata ===

* Issue: https://github.com/archivematica/Issues/issues/1697

=== Transfer status check has been optimized ===

* Issue: https://github.com/archivematica/Issues/issues/1741

Special thanks to [https://github.com/liam-lloyd Liam Lloyd-Tucker] for this contribution.

=== Transcribe job handles invalid arguments ===

* Issue: https://github.com/archivematica/Issues/issues/1751

Please see the 1.18.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/27?closed=1.

Archivematica 1.18.0 and Storage Service 0.24.0 release notes

2025-08-19T13:43:27Z

Dcerna: /* Add transfer status check optimization */

Archivematica 1.18.0 and Storage Service 0.24.0 release notes

2025-08-18T21:57:43Z

Dcerna: Archivematica 1.18.0

Release Notes

2025-05-20T15:45:02Z

Dcerna: Archivematica 1.17.1

[[Main_Page|Home]] > Release Notes

== About ==

Release notes are prepared by Artefactual for each release of Archivematica. Most releases also have a corresponding release of the Storage System, and may also include corresponding releases for various dependencies and libraries (i.e. FIDO, Automation Tools) - be sure to check the release notes for more information.

Major releases are '''bolded''', minor releases are not.

Features, enhancements, and bug fixes are often sponsored by members of the Archivematica community who are dedicated to funding Archivematica's ongoing development and maintenance. Code contributors are individuals who write Archivematica code and [https://github.com/artefactual/archivematica/blob/stable/1.6.x/CONTRIBUTING.md| contribute it] back to the project. Archivematica couldn't continue to grow without sponsors and contributors - thank you!

Questions about a release or the release notes? Ask on the [https://groups.google.com/forum/#!forum/archivematica| Archivematica Google Group!]

== Security patches ==

* [[Log4j|Log4j vulnerability information]] Updated December 13, 2021

== Archivematica 1.x releases ==

* [[Archivematica_1.17.1_release_notes|'''Archivematica 1.17.1 Release Notes''']] (Current release)
* [[Archivematica_1.17.0_and_Storage_Service_0.23.0_release_notes|'''Archivematica 1.17.0 and Storage Service 0.23.0 Release Notes''']]
* [[Archivematica_1.16.0_and_Storage_Service_0.22.0_release_notes|'''Archivematica 1.16.0 and Storage Service 0.22.0 Release Notes''']]
* [[Archivematica_1.15.1_and_Storage_Service_0.21.1_release_notes|Archivematica 1.15.1 and Storage Service 0.21.1 Release Notes]]
* [[Archivematica_1.15.0_and_Storage_Service_0.21.0_release_notes|'''Archivematica 1.15.0 and Storage Service 0.21.0 Release Notes''']]
* [[Archivematica_1.14.1_and_Storage_Service_0.20.1_release_notes|Archivematica 1.14.1 and Storage Service 0.20.1 Release Notes]]
* [[Archivematica_1.14.0_and_Storage_Service_0.20.0_release_notes|'''Archivematica 1.14.0 and Storage Service 0.20.0 Release Notes''']]
* [[Storage Service 0.19 Release Notes|'''Storage Service 0.19 Release Notes''']]
* [[Archivematica_1.13.2|Archivematica 1.13.2 Release Notes]]
* [[Archivematica_1.13.1_and_Storage_Service_0.18.1_release_notes|'''Archivematica 1.13.1 and Storage Service 0.18.1 Release Notes''']]
* [[Archivematica_1.13.0_and_Storage_Service_0.18.0_release_notes|'''Archivematica 1.13.0 and Storage Service 0.18.0 Release Notes''']]
* [[Archivematica_1.12.2|Archivematica 1.12.2 Release Notes]]
* [[Archivematica_1.12.1_and_Storage_Service_0.17.1_release_notes|Archivematica 1.12.1 and Storage Service 0.17.1 Release Notes]]
* [[Archivematica_1.12.0_and_Storage_Service_0.17.0_release_notes|'''Archivematica 1.12.0 and Storage Service 0.17.0 Release Notes''']]
* [[Archivematica_1.11.2_and_Storage_Service_0.16.1_release_notes|Archivematica 1.11.2 and Storage Service 0.16.1 Release Notes]]
* [[Archivematica_1.11.1|Archivematica 1.11.1 Release Notes]]
* [[Archivematica_1.11_and_Storage_Service_0.16_release_notes|'''Archivematica 1.11 and Storage Service 0.16 Release Notes''']]
* [[Archivematica_1.10.2|Archivematica 1.10.2 Release Notes]]
* [[Archivematica_1.10.1_release_notes|Archivematica 1.10.1 and Storage Service 0.15.1 Release Notes]]
* [[Archivematica_1.10_and_Storage_Service_0.15_release_notes|'''Archivematica 1.10 and Storage Service 0.15 Release Notes''']]
* [[Archivematica_1.9.3|Archivematica 1.9.3 Release Notes]]
* [[Archivematica_1.9.2_release_notes|Archivematica 1.9.2 Release Notes]]
* [[Archivematica_1.9.1_and_Storage_Service_0.14.1_release_notes|Archivematica 1.9.1 and Storage Service 0.14.1 Release Notes]]
* [[Archivematica_1.9_and_Storage_Service_0.14_release_notes|'''Archivematica 1.9 and Storage Service 0.14 Release Notes''']]
* [[Archivematica_1.8.1_release_notes|Archivematica 1.8.1 Release Notes]]
* [[Archivematica_1.8_and_Storage_Service_0.13_release_notes|'''Archivematica 1.8 and Storage Service 0.13 Release Notes''']]
* [[Archivematica 1.7.2_release_notes|Archivematica 1.7.2 Release Notes]]
* [[Storage Service 0.12 Release Notes|'''Storage Service 0.12 Release Notes''']]
* [[Archivematica 1.7.1_release_notes|Archivematica 1.7.1 Release Notes]]
* [[Storage Service 0.11.1 Release Notes]]
* [[Archivematica_1.7_and_Storage_Service_0.11_release_notes|'''Archivematica 1.7 and Storage Service 0.11 Release Notes''']]
* [[Archivematica_1.6.1_release_notes|Archivematica 1.6.1 Release Notes]]
* [[Archivematica_1.6_release_notes|'''Archivematica 1.6 Release Notes''']]
* [[Archivematica_1.5.1_Release_Notes|Archivematica 1.5.1 Release Notes]]
* [[Archivematica_1.5_Release_Notes|'''Archivematica 1.5 Release Notes''']]
* [[Archivematica_1.4.1_Release_Notes|Archivematica 1.4.1 Release Notes]]
* [[Archivematica_1.4_Release_Notes|'''Archivematica 1.4 Release Notes''']]
* [[Archivematica_1.3.2_Release_Notes|Archivematica 1.3.2 Release Notes]]
* [[Archivematica_1.3.1_Release_Notes|Archivematica 1.3.1 Release Notes]]
* [[Archivematica_1.3_Release_Notes|'''Archivematica 1.3 Release Notes''']]
* [[Archivematica_1.2_Release_Notes|'''Archivematica 1.2 Release Notes''']]
* [[Archivematica_1.1_Release_Notes|'''Archivematica 1.1 Release Notes''']]
* [[Archivematica_1.0_Release_Notes|'''Archivematica 1.0 Release Notes''']]

== Archivematica 0.x releases ==

* [[Archivematica_0.10-beta_Release_Notes|'''Archivematica 0.10 Release Notes''']]
* [[Archivematica_0.9_Release_Notes|'''Archivematica 0.9 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.8 Release Notes''']]
* [[Archivematica_0.7.1_Release_Notes|Archivematica 0.7.1 Release Notes]]
* [[Archivematica_0.7_Release_Notes|'''Archivematica 0.7 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.6 Release Notes''']]

== Templates ==

* [[Major_release_notes|Template for major releases]]
* [[Minor_release_notes|Template for minor releases]]

Archivematica 1.17.1 release notes

2025-05-20T15:31:03Z

Dcerna:

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.17.1

'''Release date: May 20, 2025'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.17.1 has been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Fixed ==

=== Docker images build ===

* Issue: https://github.com/archivematica/Issues/issues/1747

Updated the MediaArea software repository version to <code>1.0-25</code> and ensured the Dashboard frontend is built using the dependency versions specified in <code>package-lock.json</code>.

Please see the 1.17.1 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/28?closed=1.

Archivematica 1.17.1 release notes

2025-05-15T21:48:37Z

Dcerna: /* Environments */

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.17.1

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.17.1 has been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Fixed ==

=== Docker images build ===

* Issue: https://github.com/archivematica/Issues/issues/1747

Updated the MediaArea software repository version to <code>1.0-25</code> and ensured the Dashboard frontend is built using the dependency versions specified in <code>package-lock.json</code>.

Please see the 1.17.1 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/28?closed=1.

Archivematica 1.17.1 release notes

2025-05-15T21:20:15Z

Dcerna: Archivematica 1.17.1

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.17.1

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.17.1 and Storage Service 0.23.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Fixed ==

=== Docker images build ===

* Issue: https://github.com/archivematica/Issues/issues/1747

Updated the MediaArea software repository version to <code>1.0-25</code> and ensured the Dashboard frontend is built using the dependency versions specified in <code>package-lock.json</code>.

Please see the 1.17.1 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/28?closed=1.

Release Notes

2024-12-06T14:49:36Z

Dcerna: /* Archivematica 1.x releases */

[[Main_Page|Home]] > Release Notes

== About ==

Release notes are prepared by Artefactual for each release of Archivematica. Most releases also have a corresponding release of the Storage System, and may also include corresponding releases for various dependencies and libraries (i.e. FIDO, Automation Tools) - be sure to check the release notes for more information.

Major releases are '''bolded''', minor releases are not.

Features, enhancements, and bug fixes are often sponsored by members of the Archivematica community who are dedicated to funding Archivematica's ongoing development and maintenance. Code contributors are individuals who write Archivematica code and [https://github.com/artefactual/archivematica/blob/stable/1.6.x/CONTRIBUTING.md| contribute it] back to the project. Archivematica couldn't continue to grow without sponsors and contributors - thank you!

Questions about a release or the release notes? Ask on the [https://groups.google.com/forum/#!forum/archivematica| Archivematica Google Group!]

== Security patches ==

* [[Log4j|Log4j vulnerability information]] Updated December 13, 2021

== Archivematica 1.x releases ==

* [[Archivematica_1.17.0_and_Storage_Service_0.23.0_release_notes|'''Archivematica 1.17.0 and Storage Service 0.23.0 Release Notes''']] (Current release)
* [[Archivematica_1.16.0_and_Storage_Service_0.22.0_release_notes|'''Archivematica 1.16.0 and Storage Service 0.22.0 Release Notes''']]
* [[Archivematica_1.15.1_and_Storage_Service_0.21.1_release_notes|Archivematica 1.15.1 and Storage Service 0.21.1 Release Notes]]
* [[Archivematica_1.15.0_and_Storage_Service_0.21.0_release_notes|'''Archivematica 1.15.0 and Storage Service 0.21.0 Release Notes''']]
* [[Archivematica_1.14.1_and_Storage_Service_0.20.1_release_notes|Archivematica 1.14.1 and Storage Service 0.20.1 Release Notes]]
* [[Archivematica_1.14.0_and_Storage_Service_0.20.0_release_notes|'''Archivematica 1.14.0 and Storage Service 0.20.0 Release Notes''']]
* [[Storage Service 0.19 Release Notes|'''Storage Service 0.19 Release Notes''']]
* [[Archivematica_1.13.2|Archivematica 1.13.2 Release Notes]]
* [[Archivematica_1.13.1_and_Storage_Service_0.18.1_release_notes|'''Archivematica 1.13.1 and Storage Service 0.18.1 Release Notes''']]
* [[Archivematica_1.13.0_and_Storage_Service_0.18.0_release_notes|'''Archivematica 1.13.0 and Storage Service 0.18.0 Release Notes''']]
* [[Archivematica_1.12.2|Archivematica 1.12.2 Release Notes]]
* [[Archivematica_1.12.1_and_Storage_Service_0.17.1_release_notes|Archivematica 1.12.1 and Storage Service 0.17.1 Release Notes]]
* [[Archivematica_1.12.0_and_Storage_Service_0.17.0_release_notes|'''Archivematica 1.12.0 and Storage Service 0.17.0 Release Notes''']]
* [[Archivematica_1.11.2_and_Storage_Service_0.16.1_release_notes|Archivematica 1.11.2 and Storage Service 0.16.1 Release Notes]]
* [[Archivematica_1.11.1|Archivematica 1.11.1 Release Notes]]
* [[Archivematica_1.11_and_Storage_Service_0.16_release_notes|'''Archivematica 1.11 and Storage Service 0.16 Release Notes''']]
* [[Archivematica_1.10.2|Archivematica 1.10.2 Release Notes]]
* [[Archivematica_1.10.1_release_notes|Archivematica 1.10.1 and Storage Service 0.15.1 Release Notes]]
* [[Archivematica_1.10_and_Storage_Service_0.15_release_notes|'''Archivematica 1.10 and Storage Service 0.15 Release Notes''']]
* [[Archivematica_1.9.3|Archivematica 1.9.3 Release Notes]]
* [[Archivematica_1.9.2_release_notes|Archivematica 1.9.2 Release Notes]]
* [[Archivematica_1.9.1_and_Storage_Service_0.14.1_release_notes|Archivematica 1.9.1 and Storage Service 0.14.1 Release Notes]]
* [[Archivematica_1.9_and_Storage_Service_0.14_release_notes|'''Archivematica 1.9 and Storage Service 0.14 Release Notes''']]
* [[Archivematica_1.8.1_release_notes|Archivematica 1.8.1 Release Notes]]
* [[Archivematica_1.8_and_Storage_Service_0.13_release_notes|'''Archivematica 1.8 and Storage Service 0.13 Release Notes''']]
* [[Archivematica 1.7.2_release_notes|Archivematica 1.7.2 Release Notes]]
* [[Storage Service 0.12 Release Notes|'''Storage Service 0.12 Release Notes''']]
* [[Archivematica 1.7.1_release_notes|Archivematica 1.7.1 Release Notes]]
* [[Storage Service 0.11.1 Release Notes]]
* [[Archivematica_1.7_and_Storage_Service_0.11_release_notes|'''Archivematica 1.7 and Storage Service 0.11 Release Notes''']]
* [[Archivematica_1.6.1_release_notes|Archivematica 1.6.1 Release Notes]]
* [[Archivematica_1.6_release_notes|'''Archivematica 1.6 Release Notes''']]
* [[Archivematica_1.5.1_Release_Notes|Archivematica 1.5.1 Release Notes]]
* [[Archivematica_1.5_Release_Notes|'''Archivematica 1.5 Release Notes''']]
* [[Archivematica_1.4.1_Release_Notes|Archivematica 1.4.1 Release Notes]]
* [[Archivematica_1.4_Release_Notes|'''Archivematica 1.4 Release Notes''']]
* [[Archivematica_1.3.2_Release_Notes|Archivematica 1.3.2 Release Notes]]
* [[Archivematica_1.3.1_Release_Notes|Archivematica 1.3.1 Release Notes]]
* [[Archivematica_1.3_Release_Notes|'''Archivematica 1.3 Release Notes''']]
* [[Archivematica_1.2_Release_Notes|'''Archivematica 1.2 Release Notes''']]
* [[Archivematica_1.1_Release_Notes|'''Archivematica 1.1 Release Notes''']]
* [[Archivematica_1.0_Release_Notes|'''Archivematica 1.0 Release Notes''']]

== Archivematica 0.x releases ==

* [[Archivematica_0.10-beta_Release_Notes|'''Archivematica 0.10 Release Notes''']]
* [[Archivematica_0.9_Release_Notes|'''Archivematica 0.9 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.8 Release Notes''']]
* [[Archivematica_0.7.1_Release_Notes|Archivematica 0.7.1 Release Notes]]
* [[Archivematica_0.7_Release_Notes|'''Archivematica 0.7 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.6 Release Notes''']]

== Templates ==

* [[Major_release_notes|Template for major releases]]
* [[Minor_release_notes|Template for minor releases]]

Archivematica 1.17.0 and Storage Service 0.23.0 release notes

2024-12-06T14:48:15Z

Dcerna:

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.17.0 and Storage Service 0.23.0

'''Release date: December 6, 2024'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.17.0 and Storage Service 0.23.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== Fixity reports sort failures ===

* Issue: https://github.com/archivematica/Issues/issues/1681

AIPs that fail fixity scan are displayed at the top of the list.

== Removed ==

=== FITS ===

* Issue: https://github.com/archivematica/Issues/issues/703

[https://harvard-lts.github.io/fits/about FITS] has been removed in Archivematica 1.17.0 to mitigate potential vulnerabilities identified by various security scanners.

The [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/upgrading/upgrading/#upgrade Upgrading Archivematica] section of the documentation now includes detailed instructions for uninstalling the FITS and nailgun packages.

== Fixed ==

=== Write-Only Replica Staging space works with transfers that include dots in their names ===

* Issue: https://github.com/archivematica/Issues/issues/1697

=== Fixity runs do not email inactive users anymore ===

* Issue: https://github.com/archivematica/Issues/issues/1523

=== AIP recovery updates ===

* Issue: https://github.com/archivematica/Issues/issues/420

[https://www.archivematica.org/en/docs/storage-service-0.23/#aip-recovery AIP recovery] places the recovered AIP inside the appropriate quad directory and the documentation details the permission and directory requirements of the process.

=== Subprocess non-UTF8 output is now escaped in MCPClient jobs ===

* Issue: https://github.com/archivematica/Issues/issues/1702

=== Tesseract OCR command can be disabled through Preservation Planning ===

* Issue: https://github.com/archivematica/Issues/issues/1630

=== The <code>purge_transient_processing_data</code> management command deletes transfer files ===

* Issue: https://github.com/archivematica/Issues/issues/1714

=== The <code>import_aip</code> management command sets the correct group ownership ===

* Issue: https://github.com/archivematica/Issues/issues/1703

=== RPM packages set the correct ownership of the static asset files ===

* Issue: https://github.com/archivematica/Issues/issues/1700

Please see the 1.17.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/26?closed=1.

Archivematica 1.17.0 and Storage Service 0.23.0 release notes

2024-12-05T22:30:25Z

Dcerna: /* Fixity reports sort failures */

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.17.0 and Storage Service 0.23.0

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.17.0 and Storage Service 0.23.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== Fixity reports sort failures ===

* Issue: https://github.com/archivematica/Issues/issues/1681

AIPs that fail fixity scan are displayed at the top of the list.

== Removed ==

=== FITS ===

* Issue: https://github.com/archivematica/Issues/issues/703

[https://harvard-lts.github.io/fits/about FITS] has been removed in Archivematica 1.17.0 to mitigate potential vulnerabilities identified by various security scanners.

The [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/upgrading/upgrading/#upgrade Upgrading Archivematica] section of the documentation now includes detailed instructions for uninstalling the FITS and nailgun packages.

== Fixed ==

=== Write-Only Replica Staging space works with transfers that include dots in their names ===

* Issue: https://github.com/archivematica/Issues/issues/1697

=== Fixity runs do not email inactive users anymore ===

* Issue: https://github.com/archivematica/Issues/issues/1523

=== AIP recovery updates ===

* Issue: https://github.com/archivematica/Issues/issues/420

[https://www.archivematica.org/en/docs/storage-service-0.23/#aip-recovery AIP recovery] places the recovered AIP inside the appropriate quad directory and the documentation details the permission and directory requirements of the process.

=== Subprocess non-UTF8 output is now escaped in MCPClient jobs ===

* Issue: https://github.com/archivematica/Issues/issues/1702

=== Tesseract OCR command can be disabled through Preservation Planning ===

* Issue: https://github.com/archivematica/Issues/issues/1630

=== The <code>purge_transient_processing_data</code> management command deletes transfer files ===

* Issue: https://github.com/archivematica/Issues/issues/1714

=== The <code>import_aip</code> management command sets the correct group ownership ===

* Issue: https://github.com/archivematica/Issues/issues/1703

=== RPM packages set the correct ownership of the static asset files ===

* Issue: https://github.com/archivematica/Issues/issues/1700

Please see the 1.17.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/26?closed=1.

Archivematica 1.17.0 and Storage Service 0.23.0 release notes

2024-12-05T22:14:48Z

Dcerna:

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.17.0 and Storage Service 0.23.0

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.17.0 and Storage Service 0.23.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== Fixity reports sort failures ===

* Issue: https://github.com/archivematica/Issues/issues/###

AIPs that fail fixity scan are displayed at the top of the list.

== Removed ==

=== FITS ===

* Issue: https://github.com/archivematica/Issues/issues/703

[https://harvard-lts.github.io/fits/about FITS] has been removed in Archivematica 1.17.0 to mitigate potential vulnerabilities identified by various security scanners.

The [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/upgrading/upgrading/#upgrade Upgrading Archivematica] section of the documentation now includes detailed instructions for uninstalling the FITS and nailgun packages.

== Fixed ==

=== Write-Only Replica Staging space works with transfers that include dots in their names ===

* Issue: https://github.com/archivematica/Issues/issues/1697

=== Fixity runs do not email inactive users anymore ===

* Issue: https://github.com/archivematica/Issues/issues/1523

=== AIP recovery updates ===

* Issue: https://github.com/archivematica/Issues/issues/420

[https://www.archivematica.org/en/docs/storage-service-0.23/#aip-recovery AIP recovery] places the recovered AIP inside the appropriate quad directory and the documentation details the permission and directory requirements of the process.

=== Subprocess non-UTF8 output is now escaped in MCPClient jobs ===

* Issue: https://github.com/archivematica/Issues/issues/1702

=== Tesseract OCR command can be disabled through Preservation Planning ===

* Issue: https://github.com/archivematica/Issues/issues/1630

=== The <code>purge_transient_processing_data</code> management command deletes transfer files ===

* Issue: https://github.com/archivematica/Issues/issues/1714

=== The <code>import_aip</code> management command sets the correct group ownership ===

* Issue: https://github.com/archivematica/Issues/issues/1703

=== RPM packages set the correct ownership of the static asset files ===

* Issue: https://github.com/archivematica/Issues/issues/1700

Please see the 1.17.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/26?closed=1.

Archivematica 1.17.0 and Storage Service 0.23.0 release notes

2024-12-05T22:14:18Z

Dcerna: /* Changed */

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.17.0 and Storage Service 0.23.0

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.17.0 and Storage Service 0.23.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Added ==

=== TODO ===

* Issue: https://github.com/archivematica/Issues/issues/###

Description of the issue.

== Changed ==

=== Fixity reports sort failures ===

* Issue: https://github.com/archivematica/Issues/issues/###

AIPs that fail fixity scan are displayed at the top of the list.

== Removed ==

=== FITS ===

* Issue: https://github.com/archivematica/Issues/issues/703

[https://harvard-lts.github.io/fits/about FITS] has been removed in Archivematica 1.17.0 to mitigate potential vulnerabilities identified by various security scanners.

The [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/upgrading/upgrading/#upgrade Upgrading Archivematica] section of the documentation now includes detailed instructions for uninstalling the FITS and nailgun packages.

== Fixed ==

=== Write-Only Replica Staging space works with transfers that include dots in their names ===

* Issue: https://github.com/archivematica/Issues/issues/1697

=== Fixity runs do not email inactive users anymore ===

* Issue: https://github.com/archivematica/Issues/issues/1523

=== AIP recovery updates ===

* Issue: https://github.com/archivematica/Issues/issues/420

[https://www.archivematica.org/en/docs/storage-service-0.23/#aip-recovery AIP recovery] places the recovered AIP inside the appropriate quad directory and the documentation details the permission and directory requirements of the process.

=== Subprocess non-UTF8 output is now escaped in MCPClient jobs ===

* Issue: https://github.com/archivematica/Issues/issues/1702

=== Tesseract OCR command can be disabled through Preservation Planning ===

* Issue: https://github.com/archivematica/Issues/issues/1630

=== The <code>purge_transient_processing_data</code> management command deletes transfer files ===

* Issue: https://github.com/archivematica/Issues/issues/1714

=== The <code>import_aip</code> management command sets the correct group ownership ===

* Issue: https://github.com/archivematica/Issues/issues/1703

=== RPM packages set the correct ownership of the static asset files ===

* Issue: https://github.com/archivematica/Issues/issues/1700

Please see the 1.17.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/26?closed=1.

Archivematica 1.17.0 and Storage Service 0.23.0 release notes

2024-12-05T22:12:18Z

Dcerna: /* Fixed */

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.17.0 and Storage Service 0.23.0

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.17.0 and Storage Service 0.23.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Added ==

=== TODO ===

* Issue: https://github.com/archivematica/Issues/issues/###

Description of the issue.

== Changed ==

=== TODO ===

* Issue: https://github.com/archivematica/Issues/issues/###

Description of the issue.

== Removed ==

=== FITS ===

* Issue: https://github.com/archivematica/Issues/issues/703

[https://harvard-lts.github.io/fits/about FITS] has been removed in Archivematica 1.17.0 to mitigate potential vulnerabilities identified by various security scanners.

The [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/upgrading/upgrading/#upgrade Upgrading Archivematica] section of the documentation now includes detailed instructions for uninstalling the FITS and nailgun packages.

== Fixed ==

=== Write-Only Replica Staging space works with transfers that include dots in their names ===

* Issue: https://github.com/archivematica/Issues/issues/1697

=== Fixity runs do not email inactive users anymore ===

* Issue: https://github.com/archivematica/Issues/issues/1523

=== AIP recovery updates ===

* Issue: https://github.com/archivematica/Issues/issues/420

[https://www.archivematica.org/en/docs/storage-service-0.23/#aip-recovery AIP recovery] places the recovered AIP inside the appropriate quad directory and the documentation details the permission and directory requirements of the process.

=== Subprocess non-UTF8 output is now escaped in MCPClient jobs ===

* Issue: https://github.com/archivematica/Issues/issues/1702

=== Tesseract OCR command can be disabled through Preservation Planning ===

* Issue: https://github.com/archivematica/Issues/issues/1630

=== The <code>purge_transient_processing_data</code> management command deletes transfer files ===

* Issue: https://github.com/archivematica/Issues/issues/1714

=== The <code>import_aip</code> management command sets the correct group ownership ===

* Issue: https://github.com/archivematica/Issues/issues/1703

=== RPM packages set the correct ownership of the static asset files ===

* Issue: https://github.com/archivematica/Issues/issues/1700

Please see the 1.17.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/26?closed=1.

Archivematica 1.17.0 and Storage Service 0.23.0 release notes

2024-12-05T22:09:30Z

Dcerna: /* Fixed */

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.17.0 and Storage Service 0.23.0

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.17.0 and Storage Service 0.23.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Added ==

=== TODO ===

* Issue: https://github.com/archivematica/Issues/issues/###

Description of the issue.

== Changed ==

=== TODO ===

* Issue: https://github.com/archivematica/Issues/issues/###

Description of the issue.

== Removed ==

=== FITS ===

* Issue: https://github.com/archivematica/Issues/issues/703

[https://harvard-lts.github.io/fits/about FITS] has been removed in Archivematica 1.17.0 to mitigate potential vulnerabilities identified by various security scanners.

The [https://www.archivematica.org/en/docs/archivematica-1.17/admin-manual/installation-setup/upgrading/upgrading/#upgrade Upgrading Archivematica] section of the documentation now includes detailed instructions for uninstalling the FITS and nailgun packages.

== Fixed ==

=== Write-Only Replica Staging space works with transfers that include dots in their names ===

* Issue: https://github.com/archivematica/Issues/issues/1697

=== AIP recovery updates ===

* Issue: https://github.com/archivematica/Issues/issues/420

[https://www.archivematica.org/en/docs/storage-service-0.23/#aip-recovery AIP recovery] places the recovered AIP inside the appropriate quad directory and the documentation details the permission and directory requirements of the process.

=== Subprocess non-UTF8 output is now escaped in MCPClient jobs ===

* Issue: https://github.com/archivematica/Issues/issues/1702

=== Tesseract OCR command can be disabled through Preservation Planning ===

* Issue: https://github.com/archivematica/Issues/issues/1630

=== The <code>purge_transient_processing_data</code> management command deletes transfer files ===

* Issue: https://github.com/archivematica/Issues/issues/1714

=== The <code>import_aip</code> management command sets the correct group ownership ===

* Issue: https://github.com/archivematica/Issues/issues/1703

=== RPM packages set the correct ownership of the static asset files ===

* Issue: https://github.com/archivematica/Issues/issues/1700

Please see the 1.17.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/26?closed=1.

Archivematica 1.17.0 and Storage Service 0.23.0 release notes

2024-12-05T21:40:39Z

Dcerna: /* Removed */

Archivematica 1.17.0 and Storage Service 0.23.0 release notes

2024-10-08T14:28:42Z

Dcerna: Archivematica 1.17.0

Archivematica 1.16.0 and Storage Service 0.22.0 release notes

2024-06-12T16:19:11Z

Dcerna: Update API links

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.16.0 and Storage Service 0.22.0

'''Release date: May 16, 2024'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.16/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.16.0 and Storage Service 0.22.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Added ==

=== List jobs API endpoint returns detailed output ===

* Issue: https://github.com/archivematica/Issues/issues/1641

A <code>detailed</code> parameter was added to the [https://www.archivematica.org/en/docs/archivematica-1.16/dev-manual/api/api-reference-archivematica/#list-jobs List jobs] API endpoint. When the parameter is sent in the request, the endpoint will return all the task properties returned by the [https://www.archivematica.org/en/docs/archivematica-1.16/dev-manual/api/api-reference-archivematica/#task Task] endpoint.

== Changed ==

=== PRONOM v.116 ===

As of this Archivematica release, we are up to date to PRONOM v. 116.

[https://github.com/archivematica/Issues/issues/1653 GitHub issue 1653]

=== Python versions ===

* Issue: https://github.com/archivematica/Issues/issues/1632

Archivematica 1.16 works with all the current [https://devguide.python.org/versions/#supported-versions Python supported versions]: 3.8 - 3.12.

=== Django 4.2 ===

* Issue: https://github.com/archivematica/Issues/issues/1624

Archivematica 1.16 dropped support for Django 3.2.

== Fixed ==

=== Update MCPClient forking model ===

* Issue: https://github.com/archivematica/Issues/issues/1482

Archivematica 1.16.0 introduces a new prefork execution model in MCPClient based on a process pool. MCPClient workers are automatically restarted to free resources and will reuse database connections when possible.

The following new settings were added to the MCPClient service:

* <code>ARCHIVEMATICA_MCPCLIENT_WORKERS</code> defines the number of MCPClient workers. If undefined, it defaults to the number of CPUs available on the machine. Only client modules that define <code>concurrent_instances</code> will perform concurrent execution of tasks (e.g. identify_file_format).

* <code>ARCHIVEMATICA_MCPCLIENT_MAX_TASKS_PER_CHILD</code> defines the maximum number of tasks a worker can execute before it's replaced by a new process in order to free resources.

* <code>ARCHIVEMATICA_MCPCLIENT_MCPCLIENT_PROMETHEUS_DETAILED_METRICS</code> indicates that detailed metrics should be sent to Prometheus. With large transfers this might affect performance of the local storage in Prometheus and slow down its threads in Archivematica.

See the [https://github.com/artefactual/archivematica/blob/48004c5bd798ccb54196720103b462654bf9b08d/src/MCPClient/install/README.md MCPClient Configuration] page.

=== DIPs are cleaned from watched directories ===

* Issue: https://github.com/archivematica/Issues/issues/1665

=== Duracloud spaces retry chunk downloads ===

* Issue: https://github.com/archivematica/Issues/issues/1607

Thank you [https://github.com/carlosmcgregor Carlos Mc Gregor] for contributing this fix!

=== Partial reingest works with non-core DC properties ===

* Issue: https://github.com/archivematica/Issues/issues/1620

=== Improve paths handling in the Storage Service ===

* Issue: https://github.com/archivematica/Issues/issues/1622

Thank you [https://github.com/klavman Fco. Javier Clavero] for starting this work!

Please see the 1.16.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/24?closed=1.

Release Notes

2024-05-16T18:50:58Z

Dcerna: /* Archivematica 1.x releases */

[[Main_Page|Home]] > Release Notes

== About ==

Release notes are prepared by Artefactual for each release of Archivematica. Most releases also have a corresponding release of the Storage System, and may also include corresponding releases for various dependencies and libraries (i.e. FIDO, Automation Tools) - be sure to check the release notes for more information.

Major releases are '''bolded''', minor releases are not.

Features, enhancements, and bug fixes are often sponsored by members of the Archivematica community who are dedicated to funding Archivematica's ongoing development and maintenance. Code contributors are individuals who write Archivematica code and [https://github.com/artefactual/archivematica/blob/stable/1.6.x/CONTRIBUTING.md| contribute it] back to the project. Archivematica couldn't continue to grow without sponsors and contributors - thank you!

Questions about a release or the release notes? Ask on the [https://groups.google.com/forum/#!forum/archivematica| Archivematica Google Group!]

== Security patches ==

* [[Log4j|Log4j vulnerability information]] Updated December 13, 2021

== Archivematica 1.x releases ==

* [[Archivematica_1.16.0_and_Storage_Service_0.22.0_release_notes|'''Archivematica 1.16.0 and Storage Service 0.22.0 Release Notes''']] (Current release)
* [[Archivematica_1.15.1_and_Storage_Service_0.21.1_release_notes|Archivematica 1.15.1 and Storage Service 0.21.1 Release Notes]]
* [[Archivematica_1.15.0_and_Storage_Service_0.21.0_release_notes|'''Archivematica 1.15.0 and Storage Service 0.21.0 Release Notes''']]
* [[Archivematica_1.14.1_and_Storage_Service_0.20.1_release_notes|Archivematica 1.14.1 and Storage Service 0.20.1 Release Notes]]
* [[Archivematica_1.14.0_and_Storage_Service_0.20.0_release_notes|'''Archivematica 1.14.0 and Storage Service 0.20.0 Release Notes''']]
* [[Storage Service 0.19 Release Notes|'''Storage Service 0.19 Release Notes''']]
* [[Archivematica_1.13.2|Archivematica 1.13.2 Release Notes]]
* [[Archivematica_1.13.1_and_Storage_Service_0.18.1_release_notes|'''Archivematica 1.13.1 and Storage Service 0.18.1 Release Notes''']]
* [[Archivematica_1.13.0_and_Storage_Service_0.18.0_release_notes|'''Archivematica 1.13.0 and Storage Service 0.18.0 Release Notes''']]
* [[Archivematica_1.12.2|Archivematica 1.12.2 Release Notes]]
* [[Archivematica_1.12.1_and_Storage_Service_0.17.1_release_notes|Archivematica 1.12.1 and Storage Service 0.17.1 Release Notes]]
* [[Archivematica_1.12.0_and_Storage_Service_0.17.0_release_notes|'''Archivematica 1.12.0 and Storage Service 0.17.0 Release Notes''']]
* [[Archivematica_1.11.2_and_Storage_Service_0.16.1_release_notes|Archivematica 1.11.2 and Storage Service 0.16.1 Release Notes]]
* [[Archivematica_1.11.1|Archivematica 1.11.1 Release Notes]]
* [[Archivematica_1.11_and_Storage_Service_0.16_release_notes|'''Archivematica 1.11 and Storage Service 0.16 Release Notes''']]
* [[Archivematica_1.10.2|Archivematica 1.10.2 Release Notes]]
* [[Archivematica_1.10.1_release_notes|Archivematica 1.10.1 and Storage Service 0.15.1 Release Notes]]
* [[Archivematica_1.10_and_Storage_Service_0.15_release_notes|'''Archivematica 1.10 and Storage Service 0.15 Release Notes''']]
* [[Archivematica_1.9.3|Archivematica 1.9.3 Release Notes]]
* [[Archivematica_1.9.2_release_notes|Archivematica 1.9.2 Release Notes]]
* [[Archivematica_1.9.1_and_Storage_Service_0.14.1_release_notes|Archivematica 1.9.1 and Storage Service 0.14.1 Release Notes]]
* [[Archivematica_1.9_and_Storage_Service_0.14_release_notes|'''Archivematica 1.9 and Storage Service 0.14 Release Notes''']]
* [[Archivematica_1.8.1_release_notes|Archivematica 1.8.1 Release Notes]]
* [[Archivematica_1.8_and_Storage_Service_0.13_release_notes|'''Archivematica 1.8 and Storage Service 0.13 Release Notes''']]
* [[Archivematica 1.7.2_release_notes|Archivematica 1.7.2 Release Notes]]
* [[Storage Service 0.12 Release Notes|'''Storage Service 0.12 Release Notes''']]
* [[Archivematica 1.7.1_release_notes|Archivematica 1.7.1 Release Notes]]
* [[Storage Service 0.11.1 Release Notes]]
* [[Archivematica_1.7_and_Storage_Service_0.11_release_notes|'''Archivematica 1.7 and Storage Service 0.11 Release Notes''']]
* [[Archivematica_1.6.1_release_notes|Archivematica 1.6.1 Release Notes]]
* [[Archivematica_1.6_release_notes|'''Archivematica 1.6 Release Notes''']]
* [[Archivematica_1.5.1_Release_Notes|Archivematica 1.5.1 Release Notes]]
* [[Archivematica_1.5_Release_Notes|'''Archivematica 1.5 Release Notes''']]
* [[Archivematica_1.4.1_Release_Notes|Archivematica 1.4.1 Release Notes]]
* [[Archivematica_1.4_Release_Notes|'''Archivematica 1.4 Release Notes''']]
* [[Archivematica_1.3.2_Release_Notes|Archivematica 1.3.2 Release Notes]]
* [[Archivematica_1.3.1_Release_Notes|Archivematica 1.3.1 Release Notes]]
* [[Archivematica_1.3_Release_Notes|'''Archivematica 1.3 Release Notes''']]
* [[Archivematica_1.2_Release_Notes|'''Archivematica 1.2 Release Notes''']]
* [[Archivematica_1.1_Release_Notes|'''Archivematica 1.1 Release Notes''']]
* [[Archivematica_1.0_Release_Notes|'''Archivematica 1.0 Release Notes''']]

== Archivematica 0.x releases ==

* [[Archivematica_0.10-beta_Release_Notes|'''Archivematica 0.10 Release Notes''']]
* [[Archivematica_0.9_Release_Notes|'''Archivematica 0.9 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.8 Release Notes''']]
* [[Archivematica_0.7.1_Release_Notes|Archivematica 0.7.1 Release Notes]]
* [[Archivematica_0.7_Release_Notes|'''Archivematica 0.7 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.6 Release Notes''']]

== Templates ==

* [[Major_release_notes|Template for major releases]]
* [[Minor_release_notes|Template for minor releases]]

Archivematica 1.16.0 and Storage Service 0.22.0 release notes

2024-05-16T18:47:54Z

Dcerna:

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.16.0 and Storage Service 0.22.0

'''Release date: May 16, 2024'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.16/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.16.0 and Storage Service 0.22.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Added ==

=== List jobs API endpoint returns detailed output ===

* Issue: https://github.com/archivematica/Issues/issues/1641

A <code>detailed</code> parameter was added to the [https://wiki.archivematica.org/Archivematica_API#List_jobs List jobs] API endpoint. When the parameter is sent in the request, the endpoint will return all the task properties returned by the [https://wiki.archivematica.org/Archivematica_API#Task Task] endpoint.

== Changed ==

=== PRONOM v.116 ===

As of this Archivematica release, we are up to date to PRONOM v. 116.

[https://github.com/archivematica/Issues/issues/1653 GitHub issue 1653]

=== Python versions ===

* Issue: https://github.com/archivematica/Issues/issues/1632

Archivematica 1.16 works with all the current [https://devguide.python.org/versions/#supported-versions Python supported versions]: 3.8 - 3.12.

=== Django 4.2 ===

* Issue: https://github.com/archivematica/Issues/issues/1624

Archivematica 1.16 dropped support for Django 3.2.

== Fixed ==

=== Update MCPClient forking model ===

* Issue: https://github.com/archivematica/Issues/issues/1482

Archivematica 1.16.0 introduces a new prefork execution model in MCPClient based on a process pool. MCPClient workers are automatically restarted to free resources and will reuse database connections when possible.

The following new settings were added to the MCPClient service:

* <code>ARCHIVEMATICA_MCPCLIENT_WORKERS</code> defines the number of MCPClient workers. If undefined, it defaults to the number of CPUs available on the machine. Only client modules that define <code>concurrent_instances</code> will perform concurrent execution of tasks (e.g. identify_file_format).

* <code>ARCHIVEMATICA_MCPCLIENT_MAX_TASKS_PER_CHILD</code> defines the maximum number of tasks a worker can execute before it's replaced by a new process in order to free resources.

* <code>ARCHIVEMATICA_MCPCLIENT_MCPCLIENT_PROMETHEUS_DETAILED_METRICS</code> indicates that detailed metrics should be sent to Prometheus. With large transfers this might affect performance of the local storage in Prometheus and slow down its threads in Archivematica.

See the [https://github.com/artefactual/archivematica/blob/48004c5bd798ccb54196720103b462654bf9b08d/src/MCPClient/install/README.md MCPClient Configuration] page.

=== DIPs are cleaned from watched directories ===

* Issue: https://github.com/archivematica/Issues/issues/1665

=== Duracloud spaces retry chunk downloads ===

* Issue: https://github.com/archivematica/Issues/issues/1607

Thank you [https://github.com/carlosmcgregor Carlos Mc Gregor] for contributing this fix!

=== Partial reingest works with non-core DC properties ===

* Issue: https://github.com/archivematica/Issues/issues/1620

=== Improve paths handling in the Storage Service ===

* Issue: https://github.com/archivematica/Issues/issues/1622

Thank you [https://github.com/klavman Fco. Javier Clavero] for starting this work!

Please see the 1.16.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/24?closed=1.

Archivematica 1.16.0 and Storage Service 0.22.0 release notes

2024-05-16T18:47:27Z

Dcerna:

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.16.0 and Storage Service 0.22.0

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.16/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.16.0 and Storage Service 0.22.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Added ==

=== List jobs API endpoint returns detailed output ===

* Issue: https://github.com/archivematica/Issues/issues/1641

A <code>detailed</code> parameter was added to the [https://wiki.archivematica.org/Archivematica_API#List_jobs List jobs] API endpoint. When the parameter is sent in the request, the endpoint will return all the task properties returned by the [https://wiki.archivematica.org/Archivematica_API#Task Task] endpoint.

== Changed ==

=== PRONOM v.116 ===

As of this Archivematica release, we are up to date to PRONOM v. 116.

[https://github.com/archivematica/Issues/issues/1653 GitHub issue 1653]

=== Python versions ===

* Issue: https://github.com/archivematica/Issues/issues/1632

Archivematica 1.16 works with all the current [https://devguide.python.org/versions/#supported-versions Python supported versions]: 3.8 - 3.12.

=== Django 4.2 ===

* Issue: https://github.com/archivematica/Issues/issues/1624

Archivematica 1.16 dropped support for Django 3.2.

== Fixed ==

=== Update MCPClient forking model ===

* Issue: https://github.com/archivematica/Issues/issues/1482

Archivematica 1.16.0 introduces a new prefork execution model in MCPClient based on a process pool. MCPClient workers are automatically restarted to free resources and will reuse database connections when possible.

The following new settings were added to the MCPClient service:

* <code>ARCHIVEMATICA_MCPCLIENT_WORKERS</code> defines the number of MCPClient workers. If undefined, it defaults to the number of CPUs available on the machine. Only client modules that define <code>concurrent_instances</code> will perform concurrent execution of tasks (e.g. identify_file_format).

* <code>ARCHIVEMATICA_MCPCLIENT_MAX_TASKS_PER_CHILD</code> defines the maximum number of tasks a worker can execute before it's replaced by a new process in order to free resources.

* <code>ARCHIVEMATICA_MCPCLIENT_MCPCLIENT_PROMETHEUS_DETAILED_METRICS</code> indicates that detailed metrics should be sent to Prometheus. With large transfers this might affect performance of the local storage in Prometheus and slow down its threads in Archivematica.

See the [https://github.com/artefactual/archivematica/blob/48004c5bd798ccb54196720103b462654bf9b08d/src/MCPClient/install/README.md MCPClient Configuration] page.

=== DIPs are cleaned from watched directories ===

* Issue: https://github.com/archivematica/Issues/issues/1665

=== Duracloud spaces retry chunk downloads ===

* Issue: https://github.com/archivematica/Issues/issues/1607

Thank you [https://github.com/carlosmcgregor Carlos Mc Gregor] for contributing this fix!

=== Partial reingest works with non-core DC properties ===

* Issue: https://github.com/archivematica/Issues/issues/1620

=== Improve paths handling in the Storage Service ===

* Issue: https://github.com/archivematica/Issues/issues/1622

Thank you [https://github.com/klavman Fco. Javier Clavero] for starting this work!

Please see the 1.16.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/24?closed=1.

Archivematica 1.16.0 and Storage Service 0.22.0 release notes

2024-05-16T18:39:30Z

Dcerna:

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.16.0 and Storage Service 0.22.0

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.16/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.16.0 and Storage Service 0.22.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== PRONOM v.116 ===

As of this Archivematica release, we are up to date to PRONOM v. 116.

[https://github.com/archivematica/Issues/issues/1653 GitHub issue 1653]

=== Python versions ===

* Issue: https://github.com/archivematica/Issues/issues/1632

Archivematica 1.16 works with all the current [https://devguide.python.org/versions/#supported-versions Python supported versions]: 3.8 - 3.12.

=== Django 4.2 ===

* Issue: https://github.com/archivematica/Issues/issues/1624

Archivematica 1.16 dropped support for Django 3.2.

== Fixed ==

=== Update MCPClient forking model ===

* Issue: https://github.com/archivematica/Issues/issues/1482

Archivematica 1.16.0 introduces a new prefork execution model in MCPClient based on a process pool. MCPClient workers are automatically restarted to free resources and will reuse database connections when possible.

The following new settings were added to the MCPClient service:

* <code>ARCHIVEMATICA_MCPCLIENT_WORKERS</code> defines the number of MCPClient workers. If undefined, it defaults to the number of CPUs available on the machine. Only client modules that define <code>concurrent_instances</code> will perform concurrent execution of tasks (e.g. identify_file_format).

* <code>ARCHIVEMATICA_MCPCLIENT_MAX_TASKS_PER_CHILD</code> defines the maximum number of tasks a worker can execute before it's replaced by a new process in order to free resources.

* <code>ARCHIVEMATICA_MCPCLIENT_MCPCLIENT_PROMETHEUS_DETAILED_METRICS</code> indicates that detailed metrics should be sent to Prometheus. With large transfers this might affect performance of the local storage in Prometheus and slow down its threads in Archivematica.

See the [https://github.com/artefactual/archivematica/blob/48004c5bd798ccb54196720103b462654bf9b08d/src/MCPClient/install/README.md MCPClient Configuration] page.

=== DIPs are cleaned from watched directories ===

* Issue: https://github.com/archivematica/Issues/issues/1665

=== Duracloud spaces retry chunk downloads ===

* Issue: https://github.com/archivematica/Issues/issues/1607

Thank you [https://github.com/carlosmcgregor Carlos Mc Gregor] for contributing this fix!

=== Partial reingest works with non-core DC properties ===

* Issue: https://github.com/archivematica/Issues/issues/1620

=== Improve paths handling in the Storage Service ===

* Issue: https://github.com/archivematica/Issues/issues/1622

Thank you [https://github.com/klavman Fco. Javier Clavero] for starting this work!

Please see the 1.16.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/24?closed=1.

Archivematica 1.16.0 and Storage Service 0.22.0 release notes

2024-05-16T18:39:06Z

Dcerna: Update Fixed section

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.16.0 and Storage Service 0.22.0

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.16/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.16.0 and Storage Service 0.22.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Added ==

== Changed ==

=== PRONOM v.116 ===

As of this Archivematica release, we are up to date to PRONOM v. 116.

[https://github.com/archivematica/Issues/issues/1653 GitHub issue 1653]

=== Python versions ===

* Issue: https://github.com/archivematica/Issues/issues/1632

Archivematica 1.16 works with all the current [https://devguide.python.org/versions/#supported-versions Python supported versions]: 3.8 - 3.12.

=== Django 4.2 ===

* Issue: https://github.com/archivematica/Issues/issues/1624

Archivematica 1.16 dropped support for Django 3.2.

== Fixed ==

=== Update MCPClient forking model ===

* Issue: https://github.com/archivematica/Issues/issues/1482

Archivematica 1.16.0 introduces a new prefork execution model in MCPClient based on a process pool. MCPClient workers are automatically restarted to free resources and will reuse database connections when possible.

The following new settings were added to the MCPClient service:

* <code>ARCHIVEMATICA_MCPCLIENT_WORKERS</code> defines the number of MCPClient workers. If undefined, it defaults to the number of CPUs available on the machine. Only client modules that define <code>concurrent_instances</code> will perform concurrent execution of tasks (e.g. identify_file_format).

* <code>ARCHIVEMATICA_MCPCLIENT_MAX_TASKS_PER_CHILD</code> defines the maximum number of tasks a worker can execute before it's replaced by a new process in order to free resources.

* <code>ARCHIVEMATICA_MCPCLIENT_MCPCLIENT_PROMETHEUS_DETAILED_METRICS</code> indicates that detailed metrics should be sent to Prometheus. With large transfers this might affect performance of the local storage in Prometheus and slow down its threads in Archivematica.

See the [https://github.com/artefactual/archivematica/blob/48004c5bd798ccb54196720103b462654bf9b08d/src/MCPClient/install/README.md MCPClient Configuration] page.

=== DIPs are cleaned from watched directories ===

* Issue: https://github.com/archivematica/Issues/issues/1665

=== Duracloud spaces retry chunk downloads ===

* Issue: https://github.com/archivematica/Issues/issues/1607

Thank you [https://github.com/carlosmcgregor Carlos Mc Gregor] for contributing this fix!

=== Partial reingest works with non-core DC properties ===

* Issue: https://github.com/archivematica/Issues/issues/1620

=== Improve paths handling in the Storage Service ===

* Issue: https://github.com/archivematica/Issues/issues/1622

Thank you [https://github.com/klavman Fco. Javier Clavero] for starting this work!

Please see the 1.16.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/24?closed=1.

Archivematica 1.16.0 and Storage Service 0.22.0 release notes

2024-05-16T18:29:11Z

Dcerna: Update Changed section

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.16.0 and Storage Service 0.22.0

'''Release date: TBD'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.16/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.16.0 and Storage Service 0.22.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Added ==

== Changed ==

=== PRONOM v.116 ===

As of this Archivematica release, we are up to date to PRONOM v. 116.

[https://github.com/archivematica/Issues/issues/1653 GitHub issue 1653]

=== Python versions ===

* Issue: https://github.com/archivematica/Issues/issues/1632

Archivematica 1.16 works with all the current [https://devguide.python.org/versions/#supported-versions Python supported versions]: 3.8 - 3.12.

=== Django 4.2 ===

* Issue: https://github.com/archivematica/Issues/issues/1624

Archivematica 1.16 dropped support for Django 3.2.

== Fixed ==

=== Update MCPClient forking model ===

* Issue: https://github.com/archivematica/Issues/issues/1482

Archivematica 1.16.0 introduces a new prefork execution model in MCPClient based on a process pool. MCPClient workers are automatically restarted to free resources and will reuse database connections when possible.

The following new settings were added to the MCPClient service:

* <code>ARCHIVEMATICA_MCPCLIENT_WORKERS</code> defines the number of MCPClient workers. If undefined, it defaults to the number of CPUs available on the machine. Only client modules that define <code>concurrent_instances</code> will perform concurrent execution of tasks (e.g. identify_file_format).

* <code>ARCHIVEMATICA_MCPCLIENT_MAX_TASKS_PER_CHILD</code> defines the maximum number of tasks a worker can execute before it's replaced by a new process in order to free resources.

* <code>ARCHIVEMATICA_MCPCLIENT_MCPCLIENT_PROMETHEUS_DETAILED_METRICS</code> indicates that detailed metrics should be sent to Prometheus. With large transfers this might affect performance of the local storage in Prometheus and slow down its threads in Archivematica.

See the [https://github.com/artefactual/archivematica/blob/48004c5bd798ccb54196720103b462654bf9b08d/src/MCPClient/install/README.md MCPClient Configuration] page.

=== DIPs are cleaned from watched directories ===

* Issue: https://github.com/archivematica/Issues/issues/1665

=== Duracloud spaces retry chunk downloads ===

* Issue: https://github.com/archivematica/Issues/issues/1607

Thank you [https://github.com/carlosmcgregor Carlos Mc Gregor] for contributing this fix!

Please see the 1.16.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/24?closed=1.

Archivematica 1.16.0 and Storage Service 0.22.0 release notes

2024-05-16T18:24:30Z

Dcerna: Update Fixed section

Archivematica 1.16.0 and Storage Service 0.22.0 release notes

2024-05-16T17:57:57Z

Dcerna: Add PRONOM update

Archivematica 1.16.0 and Storage Service 0.22.0 release notes

2024-04-02T20:21:50Z

Dcerna: Archivematica 1.16.0

Release Process

2024-03-11T00:25:42Z

Dcerna: /* Update workflow */

This is an outline/checklist of the process to create Archivematica & Storage service releases.

== Overview ==

# Merge new features
# Test new features
# [[#Update PRONOM]]
# Write documentation
# Update dependencies
# Update version
# [[#Build deb/rpm packages]]
# Test packages for new installs and upgrades
# [[#Tag Release]]
# Update ansible roles
# Announce release

== Translations ==

'''Needs to be improved!'''

* Determine code freeze / call for translations process
* Describe processes: push and pull - and when it needs to happen
* We made a choice on how we're using Transifex to keep things simple: only one branch at a time pushed to Transifex. E.g. once SS 0.10.0 is released we have to decide if:
*# We move Transifex to stable/0.10.x for a while so we can work on a minor release with translation fixes (e.g. 0.10.1), or
*# We move to qa/0.11.x which would only make possible to bring new translations to SS 0.11.0.
* Affected repositories
** archivematica-storage-service
** archivematica-workflow
** archivematica-dashboard
*** Includes archivematica-fpr-admin
*** Includes appraisal-tab

== Update PRONOM ==

PRONOM needs to be updated in our file identification tools, FIDO & Siegfried, as well as in the FPR.

=== Update FIDO ===

The FPR update currently use FIDO as a source for new PRONOM, since it is formatted nicer than PRONOM offers, so we depend on FIDO having updated their PRONOM. If that has not happened, we can generate a new formats-v##.xml by updating signatures manually. Artefactual can also update PRONOM and submit a PR to FIDO.

# Checkout fido from https://github.com/openpreserve/fido
# Update signatures
#* Run <code>python setup.py install</code>
#* Run <code>python -m fido.update_signatures</code> from the fido repository root
# Add:
#* New signature file <code>fido/conf/DROID_SignatureFile-v##.xml</code>
#* New formats file <code>fido/conf/formats-v##.xml</code>
#* New PRONOM zip file <code>fido/conf/pronom-xml-v##.zip</code>
#* Updated <code>fido/conf/versions.xml</code>
# Remove:
#* Old signature file
#* Old formats file
#* Old PRONOM zip file
# Replace:
#* the container signatures (download here: https://www.nationalarchives.gov.uk/aboutapps/pronom/droid-signature-files.htm)
#* the reference path to the container signatures in <code>fido/fido.py</code>
# Update version:
#* Update in __init__.py
#* Update in versions.xml
# Create pull request.
# Release new version of FIDO.

Remember to package FIDO and Siegfried in Archivematica! See next step below.

=== Package FIDO ===

FIDO is packaged via [http://pypi.org/ PyPi] under opf-fido. The Makefile includes a `make package` command that will do the update.

MCPClient's base.txt [https://github.com/artefactual/archivematica/blob/qa/1.x/src/MCPClient/requirements/base.txt] will need to be updated with the latest version.

=== Package Siegfried ===

When a new Siegfried version becomes available, clone the [https://github.com/artefactual-labs/am-packbuild/ am-packbuild] repo, checkout the <code>qa/1.x</code> branch and update the Makefiles available at <code>rpms/EL9/siegfried/Makefile</code>, and <code>debs/siegfried/Makefile</code> , and run <code>make</code> in each directory to build the packages.

=== Update FPR ===

==== Examples ====
<div class="text-alert">
* In https://github.com/artefactual/archivematica-fpr-admin/pull/51, the devtools used here to generate the migration were included in archivematica-fpr-admin as django-admin management tools.
* At the end of the process: '''remember''' to remove "pk"s from the final migration fixture! E.g. see PR #55
* Examples
** PRONOM 92:
*** https://github.com/artefactual/archivematica-fpr-admin/pull/63
*** ???
** PRONOM 90:
*** https://github.com/artefactual/archivematica-fpr-admin/pull/51
*** https://github.com/artefactual/archivematica-fpr-admin/pull/55

There used to be a [https://projects.artefactual.com/issues/10466#change-46673 bug] in the imports model. To fix, Remove the <code>apps.get_model</code> lines and Import the models directly with <code>from fpr.models import Format, FormatVersion, IDRule</code>. You shouldn't have to do this now.

</div>

==== Update workflow ====

This depends on FIDO having updated PRONOM files. See [[#Update FIDO]]

# Generate a JSON with the current version of the FPR (for use later)
#* <code>python src/dashboard/src/manage.py dumpdata -o tmp/fpr-current.json fpr</code>
# Make a new migration (you can copy from a previous one) and update it accordingly
#* E.g. <code>cp src/dashboard/src/fpr/migrations/0022_pronom_94.py src/dashboard/src/fpr/migrations/0032_pronom_96.py</code>
# Generate the FPR migration body. This also updates the local database's FPR with the new PRONOM IDs
#* E.g. <code>python src/dashboard/src/manage.py import_pronom_ids path/to/fido/fido/conf/formats-v96.xml --output-filename pronom96.txt</code>
# Copy the output into the blank migration above the Migration class. (Note: This is temporary, to create the data inside the FPR for the analyst steps below)
# Make sure the below RunPython operation is in the Migration class, in the operations list
# Deploy on testing pipeline or locally

(Analyst work)
# Update the new entries. Edit ONLY entries added by the latest PRONOM update otherwise the fixture won't work properly!
#* Move new formats to the most appropriate category
#* Create rules & commands
#* Test with data for new formats
(End Analyst work)

# Generate a JSON with the updated version of the FPR on the testing pipeline
#* <code>python src/dashboard/src/manage.py dumpdata -o tmp/fpr-updated.json fpr</code>
# Get the updates as JSON
#* E.g. <code>python src/dashboard/src/manage.py get_fpr_changes fpr-current.json fpr-updated.json pronom_96.json</code>
# Update the migration to load the JSON updates (see previous migrations)
# Review JSON -- some IDs with multipleformats are being imported and will have to be manually reviewed until bug is identified/corrected.
#* Remove any direct imports from the bug
#* '''Remove the pk's from the entries in the JSON document.'''
#* Improvement Note: Because this is using loaddata, this will have problems if the FPR models are changed. A possible solution is to update get-fpr-changes to generate a migration instead of JSON
# Rebuild and test migration
# Commit, send PR, merge

=== Finally, update IDTools versions in the FPR ===
# FPR needs a migration to point to the latest and accurate versions of Fido and Siegfried, and disables the previous version of Siegfried (Fido is disabled by default. As of 1.9, there can only be one enabled identification tool). See this PR for an example of a functional migration, and heed the messy commits as a warning: https://github.com/artefactual/archivematica/pull/1547/files
# Testing the above migration can be done by running <code>make bootstrap-dashboard-db</code> to recreate the dashboard and run all associated migrations.

== Update dependencies ==

=== Python Packages ===

[https://github.com/artefactual-labs/mets-reader-writer metsrw] and [https://github.com/artefactual-labs/agentarchives agentarchives] both have Makefiles that handle most of the packaging

# Check for open PRs, merge as necessary
# Update <code>setup.py</code> with the new version, create a pull request, code review, [[Merging | merge]].
# Tag new release, push tag
#* <code>git push --tags</code>
# Run <code>make package</code>
#* This will build the package and upload it to PyPI. It will prompt for your PyPI username and password for the upload
#* The Makefile was created from instructions at https://packaging.python.org/distributing/
# <code>make clean</code> will delete packaging related files

== Update version ==

# Update PREMIS agent to Archivematica-X.X.X
# Update Dashboard-Administration-Version to X.X.X
# Update Storage services-Admin-Version to X.X.X

== Build deb/rpm packages ==

The am-packbuild repository has all the code related to building packages, except the building gpg keys. The steps to follow in order to build production production packages are as follow

=== Debian packages ===

# Clone the [https://github.com/artefactual-labs/am-packbuild am-packbuild] repo. Latest work is available in master
# Put your gpg private key into <code>debs/GPG-KEYS-REPOS</code>. That's the place the Dockerfile looks for it when building the environment.
# Update the makefile at <code>debs/archivematica/Makefile</code> in order to reflect version/keys you want to use.
# Run <make>, and the packages will be available in the <code>build</code> once the building finishes.
# Upload packages to public debian repository

=== Debian reposities ===

There are two debian repositories, one for archivematica packages, and one for dependencies. The procedure in order to create new ones, or upload packages to them, is the same:

#* Create folder for repo, and configuration file:
<code>
mkdir -p /path/to/repos/repo/conf

cat > /path/to/repos/repo/conf/distributions << EOF

Codename: trusty

Components: main

Architectures: amd64 source

SignWith: <short gpg keyid>

EOF
</code>

#* Go inside the repo, and import the packages previously uploaded with:
<code>
cd /path/to/repos/repo/

reprepro includedeb trusty /path/to/packages/*.deb

reprepro includedsc trusty /path/to/packages/*.deb

</code>

The current official repo is at packages.archivematica.org

=== RPM Packages ===

# Package specs are available in [https://github.com/artefactual-labs/am-packbuild/tree/dev/packaging-1.6-docker/rpm am-packbuild/rpms]
# There are vars in the Makefiles for version/release , so update them when needed
# In order to build them, just go into the directory you want to build, and run “make”

=== RPM Repositories ===

Once the packages are built, upload them to packages.archivematica.org/<version>/centos
Sign the packages with rpm --addsign *.rpm (already signed packages will be skipped)

Go inside that dir, and as user ohbot run:

* ''rpm --addsign *.rpm'' (already signed packages will be skipped)

* ''createrepo .'' (For packages other than archivematica , use “centos-extras” repository)

* ''gpg --detach-sign --armor repodata/repomd.xml''

The first gpg command signs the rpms, and the later signs the repository content.

=== Development stage ===

In the final stages of development, the repositories for the new releases are created, but packages are signed with a development key to avoid mistakes. Once the development stage finishes, all new packages need to be rebuild using the production keys.

Development packages are built on each new commit to stable branches by Jenkins. Repositories are available at http://jenkins-ci.archivematica.org/repos/

== Website ==

'''Needs to be improved!'''

==== Homepage ====

* Make changes in archivematica-web.git
** Update links
** Add new doc repos
* Deploy
** Log in sites-pub as archivematica-web and run update-web.sh

==== Documentation ====

* Deploy
** Log in sites-pub as archivematica-web and run update-docs.sh

==== Wiki ====

* Release notes
* Installation notes
* ...

== News ==

* Twitter
* Mailing list
* News section in artefactual.com

== Update ansible roles ==

Check that the deploy-pub vars files for archivematica are updated, and the ansible-ansiblematica-src and ansible-archivematica-pkg roles are able to deploy the new version

== Tag Release ==

# Add release tags to repositories
#* Archivematica
#* Storage Service
#* FPR-admin
#* appraisal tab
#* transfer browser
#* Others?
# Create stable/#.x branch
# Delete qa/#.x branch if necessary

== Release Day Checklist ==

'''Step 0''': Operations Team checklist tasks are complete (as of September 2018, this is an internal Trello list).
*At this point, there should be a release candidate that has been tested. A release candidate always precedes a tagged release. If any new issues have been uncovered, a new release candidate should be made and tested before proceeding with the rest of the steps.

'''Step 1''': Release Captain decides whether the current release candidate is ready to release

* Look at all recently filed issues in GitHub -- is anything concerning / relevant for this release? Does anything need to be addressed? If an issue is uncovered that does need to be fixed, this restarts the checklist back to Step 0.
* Have automated tests passed?

'''Step 2''': Release Captain creates a new tag for the release via GitHub (e.g. `v1.7.0` or `v0.11.0` for the Storage Service) or assigns someone else to do it.

* Ensure you are adding the tag to the right commit! It should match the last commit of the final release candidate.
* You can create the tags from GitHub or from CLI: <code>git tag $VERSION $REVISION</code>and <code>git push origin refs/tags/$VERSION</code>
* Make sure that the version is valid,
** Valid values: v1.8.1, v1.8.1-rc.1
** Invalid values: 1.8.1, 1.8, 1.8.1-rc1, v1.8.1-rc1

'''Step 3''': Sysadmin builds new packages using the release tag.

* See the internal wiki for steps.

'''Step 4''': Sysadmin copies new packages to the proper repository (e.g., https://packages.archivematica.org/1.7.x/)

* See the internal wiki for steps.

'''Step 5''': Analyst updates the Archivematica documentation links in the install / upgrade section with the correct package names and locations (e.g. conf.py in docs repo)

'''Step 6''': Sysadmin updates deploy-pub to use the new links.

'''Step 7''': Developer updates archivematica-web (managed in Gitolite / GitLab) to show the new release.

* See the internal wiki for steps.

'''Step 8''': Developer changes the default branches in GitHub and GitLab and updates references in https://gist.github.com/qubot.

'''Step 9''': Systems administrator updates am-packbuild and upgrades public and private demo sites.

* See the internal wiki for steps.

'''Step 10''': Developer, Ops, or Analyst, creates a release branch, and release, of [https://github.com/artefactual-labs/archivematica-acceptance-tests Archivematica Automated Acceptance tests] (AMAUAT) in-line with the Archivematica versioning, e.g. for Archivematica 1.10 release a 1.10 branch and [https://github.com/artefactual-labs/archivematica-acceptance-tests/releases release] of AMAUAT.

'''Step 11''': Release Captain finalizes the [https://wiki.archivematica.org/Release_Notes release notes] and adds a link to them in the [https://github.com/artefactual/archivematica/releases GitHub release]. Make sure that the releases are marked as "published".
* https://github.com/artefactual/archivematica/releases
* https://github.com/artefactual/archivematica-storage-service/releases

'''Step 12''': Release Captain posts a notification to the [https://groups.google.com/forum/#!forum/archivematica Archivematica Google Group] and the News section of the Artefactual website.

'''Step 13''': Release Captain closes all release-related issues.

'''Step 14''': All involved eat cake (for a major release) or cupcakes (for a minor release).

Post-release cleanup: remove any temporary VMs created for testing.

[[Category:Process documentation]]

Storage Service API

2024-03-05T22:33:08Z

Dcerna: /* Update space endpoint */

[[Main Page]] > [[Development]] > Storage Service API

<div style="padding: 10px 10px; border: 1px solid black; background-color: #F79086;">This page is no longer being maintained and may contain inaccurate information. Please see the [https://www.archivematica.org/en/docs/archivematica-1.13/dev-manual/ Archivematica documentation] for up-to-date information.</div>

The [[Storage Service]] API provides programmatic access to moving files around in storage areas that the Storage Service has access to.

The API is written using [http://django-tastypie.readthedocs.io/en/latest/ TastyPie].

{| class="wikitable" style="background-color:#ffeecc;" cellpadding="10";
| Improvement Note: TastyPie is less well supported than [http://www.django-rest-framework.org/ Django REST Framework], both in terms of docs & community. We should look at replacing TastyPie with DRF.
|}

Endpoints require authentication with a username and API key. This can be submitted as GET parameters (eg <code>?username=test&api_key=e6282adabed84e39ffe451f8bf6ff1a67c1fc9f2</code>) or as a header (eg <code>Authorization: ApiKey test:e6282adabed84e39ffe451f8bf6ff1a67c1fc9f2</code>)

== A note about browsing ==

A detailed schema can be found for each of the resources by adding "schema" to the get all URL.

Example:
$ curl -X GET -H"Authorization: ApiKey test:95141fc645ed97a95893f1f865d24687f89a27ad" 'http://localhost:8000/api/v2/location/schema/?format=json
{
"allowed_detail_http_methods": [
"get",
"post"
],
"allowed_list_http_methods": [
"get"
],
"default_format": "application/json",
"default_limit": 20,
"fields": {
"description": {
"blank": false,
"default": "No default provided.",
"help_text": "Unicode string data. Ex: \"Hello World\"",
"nullable": false,
"primary_key": false,
"readonly": true,
"type": "string",
"unique": false,
"verbose_name": "description"
},
"enabled": {
"blank": true,
"default": true,
"help_text": "True if space can be accessed.",
"nullable": false,
"primary_key": false,
"readonly": false,
"type": "boolean",
"unique": false,
"verbose_name": "Enabled"
},
"path": {
"blank": false,
"default": "No default provided.",
"help_text": "Unicode string data. Ex: \"Hello World\"",
"nullable": false,
"primary_key": false,
"readonly": true,
"type": "string",
"unique": false,
"verbose_name": "path"
},
"pipeline": {
"blank": false,
"default": "No default provided.",
"help_text": "Many related resources. Can be either a list of URIs or list of individually nested resource data.",
"nullable": false,
"primary_key": false,
"readonly": false,
"related_schema": "/api/v2/pipeline/schema/",
"related_type": "to_many",
"type": "related",
"unique": false,
"verbose_name": "pipeline"
},
"purpose": {
"blank": false,
"default": "No default provided.",
"help_text": "Purpose of the space. Eg. AIP storage, Transfer source",
"nullable": false,
"primary_key": false,
"readonly": false,
"type": "string",
"unique": false,
"verbose_name": "Purpose"
},
"quota": {
"blank": false,
"default": null,
"help_text": "Size, in bytes (optional)",
"nullable": true,
"primary_key": false,
"readonly": false,
"type": "string",
"unique": false,
"verbose_name": "Quota"
},
"relative_path": {
"blank": false,
"default": "",
"help_text": "Path to location, relative to the storage space's path.",
"nullable": false,
"primary_key": false,
"readonly": false,
"type": "string",
"unique": false,
"verbose_name": "Relative Path"
},
"resource_uri": {
"blank": false,
"default": "No default provided.",
"help_text": "Unicode string data. Ex: \"Hello World\"",
"nullable": false,
"primary_key": false,
"readonly": true,
"type": "string",
"unique": false,
"verbose_name": "resource uri"
},
"space": {
"blank": false,
"default": "No default provided.",
"help_text": "A single related resource. Can be either a URI or set of nested resource data.",
"nullable": false,
"primary_key": false,
"readonly": false,
"related_schema": "/api/v2/space/schema/",
"related_type": "to_one",
"type": "related",
"unique": false,
"verbose_name": "space"
},
"used": {
"blank": false,
"default": 0,
"help_text": "Amount used, in bytes.",
"nullable": false,
"primary_key": false,
"readonly": false,
"type": "string",
"unique": false,
"verbose_name": "Used"
},
"uuid": {
"blank": true,
"default": "",
"help_text": "Unique identifier",
"nullable": false,
"primary_key": false,
"readonly": false,
"type": "string",
"unique": true,
"verbose_name": "uuid"
}
},
"filtering": {
"pipeline": 2,
"purpose": 1,
"quota": 1,
"relative_path": 1,
"space": 2,
"used": 1,
"uuid": 1
}
}

This schema, among other things, describes the fields in the resource (including the schema URI of related resource fields) and the fields that allow filtering. Valid filtering values are: Django ORM filters (e.g. startswith, exact, lte, etc.) or 1 or 2. If a filtering field is set to 2 it can be filtered over the related resource fields. For example, the locations could be filtered by their pipeline UUID setting it in a request parameter formatted with two underscore chars: <code>/api/v2/location/?pipeline__uuid=<uuid></code>

For more info on how to interact with the API see:

http://django-tastypie.readthedocs.io/en/v0.13.1/interacting.html

== Pipeline ==

=== Get all pipelines ===

* '''URL''': <code>/api/v2/pipeline/</code>
* '''Verb''': GET
* '''Parameters''': Query string parameters
** <code>description</code>: Description of the pipeline
** <code>uuid</code>: UUID of the pipeline
* '''Response''': JSON
** <code>meta</code>: Metadata on the response: number of hits, pagination information
** <code>objects</code>: List of pipelines. See [[#Get pipeline details]] for format

Returns information about all the pipelines in the system. Can be [http://django-tastypie.readthedocs.io/en/latest/resources.html#basic-filtering filtered] by the description or uuid. Disabled pipelines are not returned.

Example:
$ curl -X GET -H"Authorization: ApiKey test:95141fc645ed97a95893f1f865d24687f89a27ad" 'http://localhost:8000/api/v2/pipeline/?description__startswith=Archivematica' | python -m json.tool
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 1
},
"objects": [
{
"description": "Archivematica on alouette",
"remote_name": "127.0.0.1",
"resource_uri": "/api/v2/pipeline/dd354557-9e6e-4918-9fe3-a65b00ecb1af/",
"uuid": "dd354557-9e6e-4918-9fe3-a65b00ecb1af"
}
]
}

=== Create new pipeline ===

* '''URL''': <code>/api/v2/pipeline/</code>
* '''Verb''': POST
* '''Parameters''': JSON body
** Should contain fields for a new pipeline: <code>uuid</code>, <code>description</code>, <code>api_key</code>, <code>api_username</code>
** <code>create_default_locations</code>: If True, will associated default [[Storage Service#Locations | Locations]] with the newly created pipeline
** <code>shared_path</code>: If default locations are created, create the [[Storage Service#Currently Processing | processing]] location at this path in the local filesystem
** <code>remote_name</code>: URI of the pipeline.
*** Before v0.11.0: If <code>create_default_locations</code> is set, SS will try to guess the value using the <code>REMOTE_ADDR</code> header.
*** In v0.11.0 or newer: If not provided, SS will try to guess the value using the <code>REMOTE_ADDR</code> header.
* '''Response''': JSON with data for the pipeline

If the 'Pipelines disabled on creation' setting is set, the pipeline will be disabled by default, and will not respond to queries.

Example:

$ curl -X POST \
-H"Authorization: ApiKey test:95141fc645ed97a95893f1f865d24687f89a27ad" \
-H"Content-Type: application/json" \
-d'{"uuid": "99354557-9e6e-4918-9fe3-a65b00ecb199", \
"description": "Test pipeline", "create_default_locations": true, \
"api_username": "demo", \
"api_key": "03ecb307f5b8012f4771d245d534830378a87259"}' \
'http://192.168.1.42:8000/api/v2/pipeline/'
{
"create_default_locations": true,
"description": "Test pipeline",
"remote_name": "192.168.1.42",
"resource_uri": "/api/v2/pipeline/99354557-9e6e-4918-9fe3-a65b00ecb199/",
"uuid": "99354557-9e6e-4918-9fe3-a65b00ecb199"
}

=== Get pipeline details ===

* '''URL''': <code>/api/v2/pipeline/<UUID>/</code>
* '''Verb''': GET
* '''Parameters''': None
* '''Response''': JSON
** <code>description</code>: Pipeline description
** <code>remote_name</code>: IP or hostname of the pipeline. For use in API calls
** <code>resource_uri</code>: URI for this pipeline in the API
** <code>uuid</code>: UUID of the pipeline

== Space ==

=== Get all spaces ===

* '''URL''': <code>/api/v2/space/</code>
* '''Verb''': GET
* '''Parameters''': Query string parameters
** <code>access_protocol</code>: Protocol that the [[Storage Service#Space | Space]] uses. Must be searched based on the database code.
** <code>path</code>: Space's path
** <code>size</code>: Maximum size in bytes. Can use greater than (size__gt=1024), less than (size__lt=1024), and other Django [https://docs.djangoproject.com/en/1.8/ref/models/querysets/#field-lookups field lookups].
** <code>used</code>: Bytes stored in this space. Can use greater than (size__gt=1024), less than (size__lt=1024), and other Django [https://docs.djangoproject.com/en/1.8/ref/models/querysets/#field-lookups field lookups].
** <code>uuid</code>: UUID of the Space
* '''Response''': JSON
** <code>meta</code>: Metadata on the response: number of hits, pagination information
** <code>objects</code>: List of spaces. See [[#Get space details]] for format

Returns information about all the spaces in the system. Can be [http://django-tastypie.readthedocs.io/en/latest/resources.html#basic-filtering filtered] by several fields: access protocol, path, size, amount used, UUID and verified status. Disabled spaces are not returned.

=== Get space details ===

* '''URL''': <code>/api/v2/space/<UUID>/</code>
* '''Verb''': GET
* '''Parameters''': None
* '''Response''': JSON
** <code>access_protocol</code>: Database code for the access protocol
** <code>last_verified</code>: Date of last verification. This is a stub feature
** <code>path</code>: Space's path
** <code>resource_uri</code>: URI to the resource in the API
** <code>size</code>: Maximum size of the space in bytes.
** <code>used</code>: Bytes stored in this space.
** <code>uuid</code>: UUID of the space
** <code>verified</code>: If the space is verified. This is a stub feature
** Other space-specific fields

=== Browse space path ===

* '''URL''': <code>/api/v2/space/<UUID>/browse/</code>
* '''Verb''': GET
* '''Parameters''': Query string parameters
** <code>path</code>: Path inside the Space to look
* '''Response''': JSON
** <code>entries</code>: List of entries at path, files or directories
** <code>directories</code>: List of directories in path. Subset of `entries`.

=== Create space ===

* '''URL''': <code>/api/v2/space</code>
* '''Verb''': POST
* '''Parameters''': JSON body
** Should contain fields for a new space: See the [https://www.archivematica.org/en/docs/storage-service-0.21/administrators/#id4 Storage Service Documentation] for fields relevant to each type of space. Basic fields for a local file system space are listed below.
** <code>access_protocol</code>: this defines the type of space
** <code>path</code>: Absolute path to the Space on the local filesystem
** <code>size</code>: (Optional) Maximum size allowed for this space. Set to 0 or leave blank for unlimited.

Example (to create an S3 space):
<pre>
$ curl \
-X POST \
-d @payload.json \
-H "Content-Type: application/json" \
-H "Authorization: ApiKey test:test" \
http://127.0.0.1:62081/api/v2/space/

Where payload.json contains
{
"access_protocol": "S3",
"path": "",
"staging_path": "/",
"endpoint_url": "http://127.0.0.1:12345",
"access_key_id": "_Cah4cae1_",
"secret_access_key": "_Thu6Ahqu_",
"region": "us-west-2"
}
</pre>

{| class="wikitable" style="background-color:#ffffcc;" cellpadding="10";
| Version 1: Returns paths as strings
Version 2: Returns all paths base64 encoded
|}

== Location ==

=== Get all locations ===

* '''URL''': <code>/api/v2/location/</code>
* '''Verb''': GET

=== Create new location ===

Added in v0.12 - see [https://github.com/artefactual/archivematica-storage-service/issues/367 issue 367] and [https://github.com/archivematica/Issues/issues/37 issue 37].

This endpoint creates a location in the storage service, but it doesn't actually create the directory that the location points to.

* '''URL''': <code>/api/v2/location/</code>
* '''Verb''': POST
* '''Parameters''': JSON body
** <code>description</code>.
** <code>pipeline</code>: URI of the pipeline.
** <code>space</code>: URI of the space.
** <code>default</code>: If 'true' this location will be the default for it's purpose.
** <code>purpose</code>: (below is a list of possible values)
*** <code>AR</code> (AIP_RECOVERY)
*** <code>AS</code> (AIP_STORAGE)
*** <code>CP</code> (CURRENTLY_PROCESSING)
*** <code>DS</code> (DIP_STORAGE)
*** <code>SD</code> (SWORD_DEPOSIT)
*** <code>SS</code> (STORAGE_SERVICE_INTERNAL)
*** <code>BL</code> (BACKLOG)
*** <code>TS</code> (TRANSFER_SOURCE)
*** <code>RP</code> (REPLICATOR)
** <code>relative_path</code>: Relative to the space's path.

Example:

<pre>
curl -s -d '{
"pipeline": ["/api/v2/pipeline/90707555-244f-47af-8271-66496a6a965b/"],
"purpose": "TS",
"relative_path": "foo/bar",
"description": "foobar",
"space": "/api/v2/space/141593ff-2a27-44a1-9de1-917573fa0f4a/"
}' \
-X POST \
-H "Authorization: ApiKey test:test" \
-H "Content-Type: application/json" \
"http://127.0.0.1:62081/api/v2/location/"
</pre>

=== Get location details ===

* '''URL''': <code>/api/v2/location/<UUID>/</code>
* '''Verb''': GET

=== Move files to this location ===

* '''URL''': <code>/api/v2/location/<UUID>/</code>
* '''Verb''': POST
* '''Parameters''': JSON body
** <code>origin_location</code>: URI of the Location the files should be moved from
** <code>pipeline</code>: URI of the [[Storage Service#Pipeline | pipeline]]. Both Locations must be associated with this pipeline.
** <code>files</code>: List of dicts containing <code>source</code> and <code>destination</code>. The source and destination are paths relative to their Location of the files to be moved.

Intended for use with creating Transfers, SIPs, etc and other cases where files need to be moved but not tracked by the storage service.

=== Browse location path ===

* '''URL''': <code>/api/v2/location/<UUID>/browse/</code>
* '''Verb''': GET
* '''Parameters''': Query string parameters
** <code>path</code>: Path inside the Location to look
* '''Response''': JSON
** <code>entries</code>: List of entries in `path`, files or directories
** <code>directories</code>: List of directories in `path`. Subset of `entries`.

{| class="wikitable" style="background-color:#ffffcc;" cellpadding="10";
| Version 1: Returns paths as strings
Version 2: Returns all paths base64 encoded
|}

=== SWORD collection ===

* '''URL''': <code>/api/v2/location/<UUID>/sword/collection/</code>
* '''Verb''': GET, POST

See [[Sword API]] for details

== Package ==

=== Get all packages ===

* '''URL''': <code>/api/v2/file/</code>
* '''Verb''': GET

=== Create new package ===

* '''URL''': <code>/api/v2/file/</code>
* '''Verb''': POST
* '''Parameters''': JSON. Fields for a new package:
** <code>uuid</code>: UUID of the new package
** <code>origin_location</code>: URI of the Location where the package is currently
** <code>origin_path</code>: Path to the package, relative to the origin_location
** <code>current_location</code>: URI of the Location where the package should be stored
** <code>current_path</code>: Path where the package should be stored, relative to the current_location
** <code>package_type</code>: Type of package this is. One of: <code>AIP</code>, <code>AIC</code>, <code>DIP</code>, <code>transfer</code>, <code>SIP</code>, <code>file</code>, <code>deposit</code>
** <code>size</code>: Size of the package
** <code>origin_pipeline</code>: URI of the pipeline the package is from
** <code>related_package_uuid</code>: UUID of a package that is related to this one. E.g. UUID of a DIP when storing an AIP

Creates a database entry tracking the package (AIP, transfer, etc). If the package is an AIP, DIP or AIC and the current_location is an AIP or DIP storage location it also moves the files from the source to destination location. If the package is a Transfer and the current_location is transfer backlog, it is also moved.

This is handled through the modified <code>obj_create</code> function, which calls <code>Package.store_aip</code> or <code>Package.backlog_transfer</code>

=== Get package details ===

* '''URL''': <code>/api/v2/file/<UUID>/</code>
* '''Verb''': GET

=== Update package contents ===

* '''URL''': <code>/api/v2/file/<UUID>/</code>
* '''Verb''': PUT
* '''Parameters''': JSON body
** <code>reingest</code>: Flag to mark that this is reingest. Reduces chance to accidentally modify an AIP.
** <code>uuid</code>: UUID of the existing package
** <code>origin_location</code>: URI of the Location where the package is currently
** <code>origin_path</code>: Path to the package, relative to the origin_location
** <code>current_location</code>: URI of the Location where the package should be stored
** <code>current_path</code>: Path where the package should be stored, relative to the current_location
** <code>package_type</code>: Type of package this is. One of: <code>AIP</code>, <code>AIC</code>
** <code>size</code>: Size of the package
** <code>origin_pipeline</code>: URI of the pipeline the package is from. This must be the same pipeline reingest was started on (tracked through <code>Package.misc_attributes.reingest_pipeline</code>)

Updates the contents of a package during reingest. If the package is an AIP or AIC, currently stored in an AIP storage location, and the 'reingest' parameter is set, it will call <code>Package.finish_reingest</code> and merge the new AIP with the existing one.

This is implemented using a modified <code>obj_update</code> which calls <code>obj_update_hook</code>.

=== Update package metadata ===

* '''URL''': <code>/api/v2/file/<UUID>/</code>
* '''Verb''': PATCH
* '''Parameters''': JSON body
** <code>reingest</code>: Pipeline UUID or None.

Used to update metadata stored in the database for the package. Currently, this is used to update the reingest status.

{| class="wikitable" style="background-color:#ffeecc;" cellpadding="10";
| Improvement Note: Currently, this always sets Package.misc_attributes.reingest to None, regardless of what value was actually passed in.
|}

This is implemented using a modified <code>obj_update</code> which calls <code>obj_update_hook</code>. <code>update_in_place</code> also helps.

=== Delete package request ===

* '''URL''': <code>/api/v2/file/<UUID>/delete_aip/</code>
* '''Verb''': POST
* '''Parameters''': JSON body
** <code>event_reason</code>: Reason for deleting the AIP
** <code>pipeline</code>: UUID of the pipeline the delete request is from
** <code>user_id</code>: User ID requesting the deletion. This is the ID of the user on the pipeline, and must be an integer greater than 0.
** <code>user_email</code>: Email of the user requesting the deletion.

=== Recover AIP request ===

* '''URL''': <code>/api/v2/file/<UUID>/recover_aip/</code>
* '''Verb''': POST
* '''Parameters''': JSON body
** <code>event_reason</code>: Reason for recovering the AIP
** <code>pipeline</code>: URI of the pipeline the recovery request is from
** <code>user_id</code>: User ID requesting the recovery. This is the ID of the user on the pipeline, and must be an integer greater than 0.
** <code>user_email</code>: Email of the user requesting the recovery.

=== Download single file ===

* '''URL''': <code>/api/v2/file/<UUID>/extract_file/</code>
* '''Verb''': GET, HEAD
* '''Parameters''': Query string parameters
** <code>relative_path_to_file</code>: Path to the file to download, relative to the location where is stored down to the lowest level.<br />E.g.: <code>test01-36d4efb7-83ba-46bf-a171-8c7b965d9dcb/data/objects/MARBLES.TGA</code>, where <code>test01-36d4efb7-83ba-46bf-a171-8c7b965d9dcb</code> contains both the UUID of the package and the name of the transfer which you can find using [[#Get package details | Get package details]] (see <code>current_path</code> attribute).
* '''Response''': Stream of the requested file

Returns a single file from the Package. If the package is compressed, it downloads the whole AIP and extracts it.

This responds to HEAD because AtoM uses HEAD to check for the existence of a file.

{| class="wikitable" style="background-color:#ffeecc;" cellpadding="10";
| Improvement Note: HEAD and GET should not perform the same functions. HEAD should be updated to not return the file, and to only check for existence. Currently, the storage service has no way to check if a file exists except by downloading and extracting this AIP
|}

If the package is in [[Storage Service#Arkivum | Arkivum]], the package may not actually be available. This endpoint checks if the package is locally available. If it is, it is returned as normal. If not, it returns <code>202</code> and emails the administrator about the attempted access.

=== Download package ===

* '''URL''': <code>/api/v2/file/<UUID>/download/</code>
* '''URL''': <code>/api/v2/file/<UUID>/download/<chunk number>/</code> (for [[Storage Service#LOCKSS-o-matic | LOCKSS]] harvesting)
* '''Verb''': GET, HEAD
* '''Parameters''': None
* '''Response''': Stream of the package

Returns the entire package as a single file. If the AIP is uncompressed, create one file by using `tar`.

If the download URL has a chunk number, it will attempt to serve the LOCKSS chunk specified for that package. If the package is not in LOCKSS, it will return the the whole package.

This responds to HEAD because AtoM uses HEAD to check for the existence of a file.

{| class="wikitable" style="background-color:#ffeecc;" cellpadding="10";
| Improvement Note: HEAD and GET should not perform the same functions. HEAD should be updated to not return the file, and to only check for existence.
|}

If the package is in [[Storage Service#Arkivum | Arkivum]], the package may not actually be available. This endpoint checks if the package is locally available. If it is, it is returned as normal. If not, it returns <code>202</code> and emails the administrator about the attempted access.

=== Get pointer file ===

* '''URL''': <code>/api/v2/file/<UUID>/pointer_file/</code>
* '''Verb''': GET
* '''Parameters''': None
* '''Response''': Stream of the pointer file.

=== Check fixity ===

* '''URL''': <code>/api/v2/file/<UUID>/check_fixity/</code>
* '''Verb''': GET
* '''Parameters''': Query string parameters
** <code>force_local</code>: If true, download and run fixity on the AIP locally, instead of using the Space-provided fixity if available.
* '''Response''': JSON
** <code>success</code>: True if the verification succeeded, False if the verification failed, None if the scan could not start
** <code>message</code>: Human-readable string explaining the report; it will be empty for successful scans.
** <code>failures</code>: List of 0 or more errors
** <code>timestamp</code>: ISO-formated string with the datetime of the last fixity check. If the check was performed by an external system, this will be provided by that system. If not provided,or on error, it will be None.

=== AIP storage callback request ===

* '''URL''': <code>/api/v2/file/<UUID>/send_callback/post_store/</code>
* '''Verb''': GET

Request to call any Callbacks configured to run post-storage for this AIP.

In SS0.15 and above, this endpoint has been extended to support callbacks for AIP, AIC and DIP stored events.

* '''Event''': Post-store AIP, AIC, or DIP
* '''URI''': <code>https://scope.com/api/v1/dip/<package_uuid>/stored</code>
* '''Method''': POST
* '''Headers''':
* - Authorization -> <code>Token <token></code>
* - Origin -> <code>https://ss.com</code>
* '''Expected Status''': 202

{| class="wikitable" style="background-color:#ffeecc;" cellpadding="10";
| Improvement Note: This only works on locally available AIPs (AIPs stored in Spaces that are available via a UNIX filesystem layer).
|}

=== Get file information for package ===

* '''URL''': <code>/api/v2/file/<UUID>/contents/</code>
* '''Verb''': GET
* '''Response''': JSON
** <code>success</code>: True
** <code>package</code>: UUID of the package
** <code>files</code>: List of dictionaries with file information. Each dictionary has:
*** <code>source_id</code>: UUID of the file to index
*** <code>name</code>: Relative path of the file inside the package
*** <code>source_package</code>: UUID of the SIP this file is from
*** <code>checksum</code>: Checksum of the file, or an empty string
*** <code>accessionid</code>: Accession number, or an empty string
*** <code>origin</code>: UUID of the Archivematica dashboard this is from

Returns metadata about every file within the package.

=== Update file information for package ===

* '''URL''': <code>/api/v2/file/<UUID>/contents/</code>
* '''Verb''': PUT
* '''Parameters''': JSON list of dictionaries with information on the files to be added. Each dict must have the following attributes:
** <code>relative_path</code>: Relative path of the file inside the package
** <code>fileuuid</code>: UUID of the file to index
** <code>accessionid</code>: Accession number, or an empty string
** <code>sipuuid</code>: UUID of the SIP this file is from
** <code>origin</code>: UUID of the Archivematica dashboard this is from

Adds a set of files to a package.

=== Delete file information for package ===

* '''URL''': <code>/api/v2/file/<UUID>/contents/</code>
* '''Verb''': DELETE

Removes all file records associated with this package.

=== Query file information on packages ===

* '''URL''': <code>/api/v2/file/metadata/</code>
* '''Verb''': GET, POST
* '''Parameters''': Query string parameters. Must have at least one, but not all are required
** <code>relative_path</code>: Relative path of the file inside the package
** <code>fileuuid</code>: UUID of the file
** <code>accessionid</code>: Accession number
** <code>sipuuid</code>: UUID of the SIP this file is from
* '''Response''': JSON. List of dicts with file information about the files that match the query.
** <code>accessionid</code>: Accession number, or an empty string
** <code>file_extension</code>: File extension
** <code>filename</code>: Name of the file, sans path.
** <code>relative_path</code>: Relative path of the file inside the package
** <code>fileuuid</code>: UUID of the file to index
** <code>sipuuid</code>: UUID of the SIP this file is from
** <code>origin</code>: UUID of the Archivematica dashboard this is from

=== Reingest AIP ===

* '''URL''': <code>/api/v2/file/<UUID>/reingest/</code>
* '''Verb''': POST
* '''Parameters''': JSON body
** <code>pipeline</code>: UUID of the pipeline to reingest on
** <code>reingest_type</code>: Type of reingest to start. One of <code>METADATA_ONLY</code> (metadata-only reingest), <code>OBJECTS</code> (partial reingest), <code>FULL</code> (full reingest)
** <code>processing_config</code>: Optional. Name of the processing configuration to use on full reingest

=== Move Package ===

This endpoint is introduced in v0.14.

* '''URL''': <code>/api/v2/file/<UUID>/move/</code>
* '''Verb''': POST
* '''Parameters''': JSON body
** <code>location_uuid</code>: UUID of the location to send the package. The location must have the same Purpose as the package's current location (e.g. AIP Storage, DIP Storage).

Example:
$ curl -d 'location_uuid=7c5c48d4-50db-4018-b4b1-7ed29d1ef9d3 ' -H"Authorization: ApiKey test:4525fd5272275caeac04a28447698c51" 'http://mysite.archivematica.org:8000/api/v2/file/8b8aa1a2-79c9-490e-b630-28f90bb7e654/move/'

=== SWORD endpoints ===

* '''URL''': <code>/api/v2/file/<UUID>/sword/</code>
* '''URL''': <code>/api/v2/file/<UUID>/sword/media/</code>
* '''URL''': <code>/api/v2/file/<UUID>/sword/state/</code>

See [[Sword API]] for details.

[[Category:Development documentation]]

Release Process

2024-02-02T23:22:11Z

Dcerna: /* Update workflow */

This is an outline/checklist of the process to create Archivematica & Storage service releases.

== Overview ==

# Merge new features
# Test new features
# [[#Update PRONOM]]
# Write documentation
# Update dependencies
# Update version
# [[#Build deb/rpm packages]]
# Test packages for new installs and upgrades
# [[#Tag Release]]
# Update ansible roles
# Announce release

== Translations ==

'''Needs to be improved!'''

* Determine code freeze / call for translations process
* Describe processes: push and pull - and when it needs to happen
* We made a choice on how we're using Transifex to keep things simple: only one branch at a time pushed to Transifex. E.g. once SS 0.10.0 is released we have to decide if:
*# We move Transifex to stable/0.10.x for a while so we can work on a minor release with translation fixes (e.g. 0.10.1), or
*# We move to qa/0.11.x which would only make possible to bring new translations to SS 0.11.0.
* Affected repositories
** archivematica-storage-service
** archivematica-workflow
** archivematica-dashboard
*** Includes archivematica-fpr-admin
*** Includes appraisal-tab

== Update PRONOM ==

PRONOM needs to be updated in our file identification tools, FIDO & Siegfried, as well as in the FPR.

=== Update FIDO ===

The FPR update currently use FIDO as a source for new PRONOM, since it is formatted nicer than PRONOM offers, so we depend on FIDO having updated their PRONOM. If that has not happened, we can generate a new formats-v##.xml by updating signatures manually. Artefactual can also update PRONOM and submit a PR to FIDO.

# Checkout fido from https://github.com/openpreserve/fido
# Update signatures
#* Run <code>python setup.py install</code>
#* Run <code>python -m fido.update_signatures</code> from the fido repository root
# Add:
#* New signature file <code>fido/conf/DROID_SignatureFile-v##.xml</code>
#* New formats file <code>fido/conf/formats-v##.xml</code>
#* New PRONOM zip file <code>fido/conf/pronom-xml-v##.zip</code>
#* Updated <code>fido/conf/versions.xml</code>
# Remove:
#* Old signature file
#* Old formats file
#* Old PRONOM zip file
# Replace:
#* the container signatures (download here: https://www.nationalarchives.gov.uk/aboutapps/pronom/droid-signature-files.htm)
#* the reference path to the container signatures in <code>fido/fido.py</code>
# Update version:
#* Update in __init__.py
#* Update in versions.xml
# Create pull request.
# Release new version of FIDO.

Remember to package FIDO and Siegfried in Archivematica! See next step below.

=== Package FIDO ===

FIDO is packaged via [http://pypi.org/ PyPi] under opf-fido. The Makefile includes a `make package` command that will do the update.

MCPClient's base.txt [https://github.com/artefactual/archivematica/blob/qa/1.x/src/MCPClient/requirements/base.txt] will need to be updated with the latest version.

=== Package Siegfried ===

When a new Siegfried version becomes available, clone the [https://github.com/artefactual-labs/am-packbuild/ am-packbuild] repo, checkout the <code>qa/1.x</code> branch and update the Makefiles available at <code>rpms/EL9/siegfried/Makefile</code>, and <code>debs/siegfried/Makefile</code> , and run <code>make</code> in each directory to build the packages.

=== Update FPR ===

==== Examples ====
<div class="text-alert">
* In https://github.com/artefactual/archivematica-fpr-admin/pull/51, the devtools used here to generate the migration were included in archivematica-fpr-admin as django-admin management tools.
* At the end of the process: '''remember''' to remove "pk"s from the final migration fixture! E.g. see PR #55
* Examples
** PRONOM 92:
*** https://github.com/artefactual/archivematica-fpr-admin/pull/63
*** ???
** PRONOM 90:
*** https://github.com/artefactual/archivematica-fpr-admin/pull/51
*** https://github.com/artefactual/archivematica-fpr-admin/pull/55

There used to be a [https://projects.artefactual.com/issues/10466#change-46673 bug] in the imports model. To fix, Remove the <code>apps.get_model</code> lines and Import the models directly with <code>from fpr.models import Format, FormatVersion, IDRule</code>. You shouldn't have to do this now.

</div>

==== Update workflow ====

This depends on FIDO having updated PRONOM files. See [[#Update FIDO]]

# Generate a JSON with the current version of the FPR (for use later)
#* <code>python src/dashboard/src/manage.py dumpdata -o tmp/fpr-current.json fpr</code>
# Make a new migration (you can copy from a previous one) and update it accordingly
#* E.g. <code>cp src/dashboard/src/fpr/migrations/0022_pronom_94.py src/dashboard/src/fpr/migrations/0032_pronom_96.py</code>
# Generate the FPR migration body. This also updates the local database's FPR with the new PRONOM IDs
#* E.g. <code>python src/dashboard/src/manage.py import_pronom_ids path/to/fido/fido/conf/formats-v96.xml --output-filename pronom96.txt</code>
# Copy the output into the blank migration above the Migration class. (Note: This is temporary, to create the data inside the FPR for the analyst steps below)
# Make sure the below RunPython operation is in the Migration class, in the operations list
# Deploy on testing pipeline or locally

(Analyst work)
# Update the new entries. Edit ONLY entries added by the latest PRONOM update otherwise the fixture won't work properly!
#* Move new formats to the most appropriate category
#* Create rules & commands
#* Test with data for new formats
(End Analyst work)

# Generate a JSON with the updated version of the FPR on the testing pipeline
#* <code>python src/dashboard/src/manage.py dumpdata fpr > tmp/fpr-updated.json</code>
# Get the updates as JSON
#* E.g. <code>python src/dashboard/src/manage.py get_fpr_changes fpr-current.json fpr-updated.json pronom_96.json</code>
# Update the migration to load the JSON updates (see previous migrations)
# Review JSON -- some IDs with multipleformats are being imported and will have to be manually reviewed until bug is identified/corrected.
#* Remove any direct imports from the bug
#* '''Remove the pk's from the entries in the JSON document.'''
#* Improvement Note: Because this is using loaddata, this will have problems if the FPR models are changed. A possible solution is to update get-fpr-changes to generate a migration instead of JSON
# Rebuild and test migration
# Commit, send PR, merge

=== Finally, update IDTools versions in the FPR ===
# FPR needs a migration to point to the latest and accurate versions of Fido and Siegfried, and disables the previous version of Siegfried (Fido is disabled by default. As of 1.9, there can only be one enabled identification tool). See this PR for an example of a functional migration, and heed the messy commits as a warning: https://github.com/artefactual/archivematica/pull/1547/files
# Testing the above migration can be done by running <code>make bootstrap-dashboard-db</code> to recreate the dashboard and run all associated migrations.

== Update dependencies ==

=== Python Packages ===

[https://github.com/artefactual-labs/mets-reader-writer metsrw] and [https://github.com/artefactual-labs/agentarchives agentarchives] both have Makefiles that handle most of the packaging

# Check for open PRs, merge as necessary
# Update <code>setup.py</code> with the new version, create a pull request, code review, [[Merging | merge]].
# Tag new release, push tag
#* <code>git push --tags</code>
# Run <code>make package</code>
#* This will build the package and upload it to PyPI. It will prompt for your PyPI username and password for the upload
#* The Makefile was created from instructions at https://packaging.python.org/distributing/
# <code>make clean</code> will delete packaging related files

== Update version ==

# Update PREMIS agent to Archivematica-X.X.X
# Update Dashboard-Administration-Version to X.X.X
# Update Storage services-Admin-Version to X.X.X

== Build deb/rpm packages ==

The am-packbuild repository has all the code related to building packages, except the building gpg keys. The steps to follow in order to build production production packages are as follow

=== Debian packages ===

# Clone the [https://github.com/artefactual-labs/am-packbuild am-packbuild] repo. Latest work is available in master
# Put your gpg private key into <code>debs/GPG-KEYS-REPOS</code>. That's the place the Dockerfile looks for it when building the environment.
# Update the makefile at <code>debs/archivematica/Makefile</code> in order to reflect version/keys you want to use.
# Run <make>, and the packages will be available in the <code>build</code> once the building finishes.
# Upload packages to public debian repository

=== Debian reposities ===

There are two debian repositories, one for archivematica packages, and one for dependencies. The procedure in order to create new ones, or upload packages to them, is the same:

#* Create folder for repo, and configuration file:
<code>
mkdir -p /path/to/repos/repo/conf

cat > /path/to/repos/repo/conf/distributions << EOF

Codename: trusty

Components: main

Architectures: amd64 source

SignWith: <short gpg keyid>

EOF
</code>

#* Go inside the repo, and import the packages previously uploaded with:
<code>
cd /path/to/repos/repo/

reprepro includedeb trusty /path/to/packages/*.deb

reprepro includedsc trusty /path/to/packages/*.deb

</code>

The current official repo is at packages.archivematica.org

=== RPM Packages ===

# Package specs are available in [https://github.com/artefactual-labs/am-packbuild/tree/dev/packaging-1.6-docker/rpm am-packbuild/rpms]
# There are vars in the Makefiles for version/release , so update them when needed
# In order to build them, just go into the directory you want to build, and run “make”

=== RPM Repositories ===

Once the packages are built, upload them to packages.archivematica.org/<version>/centos
Sign the packages with rpm --addsign *.rpm (already signed packages will be skipped)

Go inside that dir, and as user ohbot run:

* ''rpm --addsign *.rpm'' (already signed packages will be skipped)

* ''createrepo .'' (For packages other than archivematica , use “centos-extras” repository)

* ''gpg --detach-sign --armor repodata/repomd.xml''

The first gpg command signs the rpms, and the later signs the repository content.

=== Development stage ===

In the final stages of development, the repositories for the new releases are created, but packages are signed with a development key to avoid mistakes. Once the development stage finishes, all new packages need to be rebuild using the production keys.

Development packages are built on each new commit to stable branches by Jenkins. Repositories are available at http://jenkins-ci.archivematica.org/repos/

== Website ==

'''Needs to be improved!'''

==== Homepage ====

* Make changes in archivematica-web.git
** Update links
** Add new doc repos
* Deploy
** Log in sites-pub as archivematica-web and run update-web.sh

==== Documentation ====

* Deploy
** Log in sites-pub as archivematica-web and run update-docs.sh

==== Wiki ====

* Release notes
* Installation notes
* ...

== News ==

* Twitter
* Mailing list
* News section in artefactual.com

== Update ansible roles ==

Check that the deploy-pub vars files for archivematica are updated, and the ansible-ansiblematica-src and ansible-archivematica-pkg roles are able to deploy the new version

== Tag Release ==

# Add release tags to repositories
#* Archivematica
#* Storage Service
#* FPR-admin
#* appraisal tab
#* transfer browser
#* Others?
# Create stable/#.x branch
# Delete qa/#.x branch if necessary

== Release Day Checklist ==

'''Step 0''': Operations Team checklist tasks are complete (as of September 2018, this is an internal Trello list).
*At this point, there should be a release candidate that has been tested. A release candidate always precedes a tagged release. If any new issues have been uncovered, a new release candidate should be made and tested before proceeding with the rest of the steps.

'''Step 1''': Release Captain decides whether the current release candidate is ready to release

* Look at all recently filed issues in GitHub -- is anything concerning / relevant for this release? Does anything need to be addressed? If an issue is uncovered that does need to be fixed, this restarts the checklist back to Step 0.
* Have automated tests passed?

'''Step 2''': Release Captain creates a new tag for the release via GitHub (e.g. `v1.7.0` or `v0.11.0` for the Storage Service) or assigns someone else to do it.

* Ensure you are adding the tag to the right commit! It should match the last commit of the final release candidate.
* You can create the tags from GitHub or from CLI: <code>git tag $VERSION $REVISION</code>and <code>git push origin refs/tags/$VERSION</code>
* Make sure that the version is valid,
** Valid values: v1.8.1, v1.8.1-rc.1
** Invalid values: 1.8.1, 1.8, 1.8.1-rc1, v1.8.1-rc1

'''Step 3''': Sysadmin builds new packages using the release tag.

* See the internal wiki for steps.

'''Step 4''': Sysadmin copies new packages to the proper repository (e.g., https://packages.archivematica.org/1.7.x/)

* See the internal wiki for steps.

'''Step 5''': Analyst updates the Archivematica documentation links in the install / upgrade section with the correct package names and locations (e.g. conf.py in docs repo)

'''Step 6''': Sysadmin updates deploy-pub to use the new links.

'''Step 7''': Developer updates archivematica-web (managed in Gitolite / GitLab) to show the new release.

* See the internal wiki for steps.

'''Step 8''': Developer changes the default branches in GitHub and GitLab and updates references in https://gist.github.com/qubot.

'''Step 9''': Systems administrator updates am-packbuild and upgrades public and private demo sites.

* See the internal wiki for steps.

'''Step 10''': Developer, Ops, or Analyst, creates a release branch, and release, of [https://github.com/artefactual-labs/archivematica-acceptance-tests Archivematica Automated Acceptance tests] (AMAUAT) in-line with the Archivematica versioning, e.g. for Archivematica 1.10 release a 1.10 branch and [https://github.com/artefactual-labs/archivematica-acceptance-tests/releases release] of AMAUAT.

'''Step 11''': Release Captain finalizes the [https://wiki.archivematica.org/Release_Notes release notes] and adds a link to them in the [https://github.com/artefactual/archivematica/releases GitHub release]. Make sure that the releases are marked as "published".
* https://github.com/artefactual/archivematica/releases
* https://github.com/artefactual/archivematica-storage-service/releases

'''Step 12''': Release Captain posts a notification to the [https://groups.google.com/forum/#!forum/archivematica Archivematica Google Group] and the News section of the Artefactual website.

'''Step 13''': Release Captain closes all release-related issues.

'''Step 14''': All involved eat cake (for a major release) or cupcakes (for a minor release).

Post-release cleanup: remove any temporary VMs created for testing.

[[Category:Process documentation]]

Release Process

2024-02-02T21:39:02Z

Dcerna: /* Package Siegfried */

This is an outline/checklist of the process to create Archivematica & Storage service releases.

== Overview ==

# Merge new features
# Test new features
# [[#Update PRONOM]]
# Write documentation
# Update dependencies
# Update version
# [[#Build deb/rpm packages]]
# Test packages for new installs and upgrades
# [[#Tag Release]]
# Update ansible roles
# Announce release

== Translations ==

'''Needs to be improved!'''

* Determine code freeze / call for translations process
* Describe processes: push and pull - and when it needs to happen
* We made a choice on how we're using Transifex to keep things simple: only one branch at a time pushed to Transifex. E.g. once SS 0.10.0 is released we have to decide if:
*# We move Transifex to stable/0.10.x for a while so we can work on a minor release with translation fixes (e.g. 0.10.1), or
*# We move to qa/0.11.x which would only make possible to bring new translations to SS 0.11.0.
* Affected repositories
** archivematica-storage-service
** archivematica-workflow
** archivematica-dashboard
*** Includes archivematica-fpr-admin
*** Includes appraisal-tab

== Update PRONOM ==

PRONOM needs to be updated in our file identification tools, FIDO & Siegfried, as well as in the FPR.

=== Update FIDO ===

The FPR update currently use FIDO as a source for new PRONOM, since it is formatted nicer than PRONOM offers, so we depend on FIDO having updated their PRONOM. If that has not happened, we can generate a new formats-v##.xml by updating signatures manually. Artefactual can also update PRONOM and submit a PR to FIDO.

# Checkout fido from https://github.com/openpreserve/fido
# Update signatures
#* Run <code>python setup.py install</code>
#* Run <code>python -m fido.update_signatures</code> from the fido repository root
# Add:
#* New signature file <code>fido/conf/DROID_SignatureFile-v##.xml</code>
#* New formats file <code>fido/conf/formats-v##.xml</code>
#* New PRONOM zip file <code>fido/conf/pronom-xml-v##.zip</code>
#* Updated <code>fido/conf/versions.xml</code>
# Remove:
#* Old signature file
#* Old formats file
#* Old PRONOM zip file
# Replace:
#* the container signatures (download here: https://www.nationalarchives.gov.uk/aboutapps/pronom/droid-signature-files.htm)
#* the reference path to the container signatures in <code>fido/fido.py</code>
# Update version:
#* Update in __init__.py
#* Update in versions.xml
# Create pull request.
# Release new version of FIDO.

Remember to package FIDO and Siegfried in Archivematica! See next step below.

=== Package FIDO ===

FIDO is packaged via [http://pypi.org/ PyPi] under opf-fido. The Makefile includes a `make package` command that will do the update.

MCPClient's base.txt [https://github.com/artefactual/archivematica/blob/qa/1.x/src/MCPClient/requirements/base.txt] will need to be updated with the latest version.

=== Package Siegfried ===

When a new Siegfried version becomes available, clone the [https://github.com/artefactual-labs/am-packbuild/ am-packbuild] repo, checkout the <code>qa/1.x</code> branch and update the Makefiles available at <code>rpms/EL9/siegfried/Makefile</code>, and <code>debs/siegfried/Makefile</code> , and run <code>make</code> in each directory to build the packages.

=== Update FPR ===

==== Examples ====
<div class="text-alert">
* In https://github.com/artefactual/archivematica-fpr-admin/pull/51, the devtools used here to generate the migration were included in archivematica-fpr-admin as django-admin management tools.
* At the end of the process: '''remember''' to remove "pk"s from the final migration fixture! E.g. see PR #55
* Examples
** PRONOM 92:
*** https://github.com/artefactual/archivematica-fpr-admin/pull/63
*** ???
** PRONOM 90:
*** https://github.com/artefactual/archivematica-fpr-admin/pull/51
*** https://github.com/artefactual/archivematica-fpr-admin/pull/55

There used to be a [https://projects.artefactual.com/issues/10466#change-46673 bug] in the imports model. To fix, Remove the <code>apps.get_model</code> lines and Import the models directly with <code>from fpr.models import Format, FormatVersion, IDRule</code>. You shouldn't have to do this now.

</div>

==== Update workflow ====

This depends on FIDO having updated PRONOM files. See [[#Update FIDO]]

# Generate a JSON with the current version of the FPR (for use later)
#* <code>python src/dashboard/src/manage.py dumpdata fpr > tmp/fpr-current.json</code>
# Make a new migration (you can copy from a previous one) and update it accordingly
#* E.g. <code>cp src/dashboard/src/fpr/migrations/0022_pronom_94.py src/dashboard/src/fpr/migrations/0032_pronom_96.py</code>
# Generate the FPR migration body. This also updates the local database's FPR with the new PRONOM IDs
#* E.g. <code>python src/dashboard/src/manage.py import_pronom_ids path/to/fido/fido/conf/formats-v96.xml --output-filename pronom96.txt</code>
# Copy the output into the blank migration above the Migration class. (Note: This is temporary, to create the data inside the FPR for the analyst steps below)
# Make sure the below RunPython operation is in the Migration class, in the operations list
# Deploy on testing pipeline or locally

(Analyst work)
# Update the new entries. Edit ONLY entries added by the latest PRONOM update otherwise the fixture won't work properly!
#* Move new formats to the most appropriate category
#* Create rules & commands
#* Test with data for new formats
(End Analyst work)

# Generate a JSON with the updated version of the FPR on the testing pipeline
#* <code>python src/dashboard/src/manage.py dumpdata fpr > tmp/fpr-updated.json</code>
# Get the updates as JSON
#* E.g. <code>python src/dashboard/src/manage.py get_fpr_changes fpr-current.json fpr-updated.json pronom_96.json</code>
# Update the migration to load the JSON updates (see previous migrations)
# Review JSON -- some IDs with multipleformats are being imported and will have to be manually reviewed until bug is identified/corrected.
#* Remove any direct imports from the bug
#* '''Remove the pk's from the entries in the JSON document.'''
#* Improvement Note: Because this is using loaddata, this will have problems if the FPR models are changed. A possible solution is to update get-fpr-changes to generate a migration instead of JSON
# Rebuild and test migration
# Commit, send PR, merge

=== Finally, update IDTools versions in the FPR ===
# FPR needs a migration to point to the latest and accurate versions of Fido and Siegfried, and disables the previous version of Siegfried (Fido is disabled by default. As of 1.9, there can only be one enabled identification tool). See this PR for an example of a functional migration, and heed the messy commits as a warning: https://github.com/artefactual/archivematica/pull/1547/files
# Testing the above migration can be done by running <code>make bootstrap-dashboard-db</code> to recreate the dashboard and run all associated migrations.

== Update dependencies ==

=== Python Packages ===

[https://github.com/artefactual-labs/mets-reader-writer metsrw] and [https://github.com/artefactual-labs/agentarchives agentarchives] both have Makefiles that handle most of the packaging

# Check for open PRs, merge as necessary
# Update <code>setup.py</code> with the new version, create a pull request, code review, [[Merging | merge]].
# Tag new release, push tag
#* <code>git push --tags</code>
# Run <code>make package</code>
#* This will build the package and upload it to PyPI. It will prompt for your PyPI username and password for the upload
#* The Makefile was created from instructions at https://packaging.python.org/distributing/
# <code>make clean</code> will delete packaging related files

== Update version ==

# Update PREMIS agent to Archivematica-X.X.X
# Update Dashboard-Administration-Version to X.X.X
# Update Storage services-Admin-Version to X.X.X

== Build deb/rpm packages ==

The am-packbuild repository has all the code related to building packages, except the building gpg keys. The steps to follow in order to build production production packages are as follow

=== Debian packages ===

# Clone the [https://github.com/artefactual-labs/am-packbuild am-packbuild] repo. Latest work is available in master
# Put your gpg private key into <code>debs/GPG-KEYS-REPOS</code>. That's the place the Dockerfile looks for it when building the environment.
# Update the makefile at <code>debs/archivematica/Makefile</code> in order to reflect version/keys you want to use.
# Run <make>, and the packages will be available in the <code>build</code> once the building finishes.
# Upload packages to public debian repository

=== Debian reposities ===

There are two debian repositories, one for archivematica packages, and one for dependencies. The procedure in order to create new ones, or upload packages to them, is the same:

#* Create folder for repo, and configuration file:
<code>
mkdir -p /path/to/repos/repo/conf

cat > /path/to/repos/repo/conf/distributions << EOF

Codename: trusty

Components: main

Architectures: amd64 source

SignWith: <short gpg keyid>

EOF
</code>

#* Go inside the repo, and import the packages previously uploaded with:
<code>
cd /path/to/repos/repo/

reprepro includedeb trusty /path/to/packages/*.deb

reprepro includedsc trusty /path/to/packages/*.deb

</code>

The current official repo is at packages.archivematica.org

=== RPM Packages ===

# Package specs are available in [https://github.com/artefactual-labs/am-packbuild/tree/dev/packaging-1.6-docker/rpm am-packbuild/rpms]
# There are vars in the Makefiles for version/release , so update them when needed
# In order to build them, just go into the directory you want to build, and run “make”

=== RPM Repositories ===

Once the packages are built, upload them to packages.archivematica.org/<version>/centos
Sign the packages with rpm --addsign *.rpm (already signed packages will be skipped)

Go inside that dir, and as user ohbot run:

* ''rpm --addsign *.rpm'' (already signed packages will be skipped)

* ''createrepo .'' (For packages other than archivematica , use “centos-extras” repository)

* ''gpg --detach-sign --armor repodata/repomd.xml''

The first gpg command signs the rpms, and the later signs the repository content.

=== Development stage ===

In the final stages of development, the repositories for the new releases are created, but packages are signed with a development key to avoid mistakes. Once the development stage finishes, all new packages need to be rebuild using the production keys.

Development packages are built on each new commit to stable branches by Jenkins. Repositories are available at http://jenkins-ci.archivematica.org/repos/

== Website ==

'''Needs to be improved!'''

==== Homepage ====

* Make changes in archivematica-web.git
** Update links
** Add new doc repos
* Deploy
** Log in sites-pub as archivematica-web and run update-web.sh

==== Documentation ====

* Deploy
** Log in sites-pub as archivematica-web and run update-docs.sh

==== Wiki ====

* Release notes
* Installation notes
* ...

== News ==

* Twitter
* Mailing list
* News section in artefactual.com

== Update ansible roles ==

Check that the deploy-pub vars files for archivematica are updated, and the ansible-ansiblematica-src and ansible-archivematica-pkg roles are able to deploy the new version

== Tag Release ==

# Add release tags to repositories
#* Archivematica
#* Storage Service
#* FPR-admin
#* appraisal tab
#* transfer browser
#* Others?
# Create stable/#.x branch
# Delete qa/#.x branch if necessary

== Release Day Checklist ==

'''Step 0''': Operations Team checklist tasks are complete (as of September 2018, this is an internal Trello list).
*At this point, there should be a release candidate that has been tested. A release candidate always precedes a tagged release. If any new issues have been uncovered, a new release candidate should be made and tested before proceeding with the rest of the steps.

'''Step 1''': Release Captain decides whether the current release candidate is ready to release

* Look at all recently filed issues in GitHub -- is anything concerning / relevant for this release? Does anything need to be addressed? If an issue is uncovered that does need to be fixed, this restarts the checklist back to Step 0.
* Have automated tests passed?

'''Step 2''': Release Captain creates a new tag for the release via GitHub (e.g. `v1.7.0` or `v0.11.0` for the Storage Service) or assigns someone else to do it.

* Ensure you are adding the tag to the right commit! It should match the last commit of the final release candidate.
* You can create the tags from GitHub or from CLI: <code>git tag $VERSION $REVISION</code>and <code>git push origin refs/tags/$VERSION</code>
* Make sure that the version is valid,
** Valid values: v1.8.1, v1.8.1-rc.1
** Invalid values: 1.8.1, 1.8, 1.8.1-rc1, v1.8.1-rc1

'''Step 3''': Sysadmin builds new packages using the release tag.

* See the internal wiki for steps.

'''Step 4''': Sysadmin copies new packages to the proper repository (e.g., https://packages.archivematica.org/1.7.x/)

* See the internal wiki for steps.

'''Step 5''': Analyst updates the Archivematica documentation links in the install / upgrade section with the correct package names and locations (e.g. conf.py in docs repo)

'''Step 6''': Sysadmin updates deploy-pub to use the new links.

'''Step 7''': Developer updates archivematica-web (managed in Gitolite / GitLab) to show the new release.

* See the internal wiki for steps.

'''Step 8''': Developer changes the default branches in GitHub and GitLab and updates references in https://gist.github.com/qubot.

'''Step 9''': Systems administrator updates am-packbuild and upgrades public and private demo sites.

* See the internal wiki for steps.

'''Step 10''': Developer, Ops, or Analyst, creates a release branch, and release, of [https://github.com/artefactual-labs/archivematica-acceptance-tests Archivematica Automated Acceptance tests] (AMAUAT) in-line with the Archivematica versioning, e.g. for Archivematica 1.10 release a 1.10 branch and [https://github.com/artefactual-labs/archivematica-acceptance-tests/releases release] of AMAUAT.

'''Step 11''': Release Captain finalizes the [https://wiki.archivematica.org/Release_Notes release notes] and adds a link to them in the [https://github.com/artefactual/archivematica/releases GitHub release]. Make sure that the releases are marked as "published".
* https://github.com/artefactual/archivematica/releases
* https://github.com/artefactual/archivematica-storage-service/releases

'''Step 12''': Release Captain posts a notification to the [https://groups.google.com/forum/#!forum/archivematica Archivematica Google Group] and the News section of the Artefactual website.

'''Step 13''': Release Captain closes all release-related issues.

'''Step 14''': All involved eat cake (for a major release) or cupcakes (for a minor release).

Post-release cleanup: remove any temporary VMs created for testing.

[[Category:Process documentation]]

Archivematica API

2023-12-11T16:45:16Z

Dcerna: Fix task property name

[[Main Page]] > [[Development]] > Archivematica API

<div style="padding: 10px 10px; border: 1px solid black; background-color: #F79086;">This page is no longer being maintained and may contain inaccurate information. Please see the [https://www.archivematica.org/en/docs/archivematica-1.13/dev-manual/ Archivematica documentation] for up-to-date information.</div>

Endpoints require authentication with a username and API key. This can be submitted as GET parameters (eg <code>?username=demo&api_key=e6282adabed84e39ffe451f8bf6ff1a67c1fc9f2</code>) or as a header (eg <code>Authorization: ApiKey demo:e6282adabed84e39ffe451f8bf6ff1a67c1fc9f2</code>).
<br \><br \>
''As GET parameters, format is:''<br \>
<code>?username=<''username''>&api_key=<''api_key''></code><br \>

''As a header, format is:''<br \>
<code>ApiKey <username>:<api_key></code><br \>

'''NOTE:''' The 'ApiKey' prefix is a requirement of the Tastypie library in use. See the Tastypie docs for [https://django-tastypie.readthedocs.io/en/latest/authentication.html#apikeyauthentication ApiKeyAuthentication].''<br \><br \>

Endpoints return JSON. If there's an error, they will return a 4xx or 5xx HTTP error code and a JSON body <code>{'error': True, 'message': 'message describing error'}</code>

== Transfer ==

=== Start Transfer ===
* '''URL''': <code>/api/transfer/start_transfer/</code>
* '''Verb''': POST
* Start a transfer.
* '''Parameters''': JSON body
** <code>name</code>: Name of new transfer
** <code>type</code>: Type of the new transfer. One of: standard, unzipped bag, zipped bag, dspace
** <code>accession</code>: Accession number of new transfer
** <code>paths[]</code>: List of base64-encoded "<location_uuid>:<relative_path>" to be copied into the new transfer. Location UUIDs should be associated with this pipeline, and relative path should be relative to the location (TODO confirm relative vs absolute path). E.g. NWJiYWJjMTMtMTIyNy00MWE3LWIwY2QtZjJhYzM1MjkxZTdmOi92YWdyYW50L3NhbXBsZWRhdGEvQ1NWbWV0YWRhdGE= (decoded: 5bbabc13-1227-41a7-b0cd-f2ac35291e7f:/vagrant/sampledata/CSVmetadata)
** <code>row_ids[]</code>: ID of the associated TransferMetadataSet for disk image ingest. Can be provided as [""]
* '''Response''': JSON
** <code>message</code>: "Copy successful."
** <code>path</code>: Path the transfer was copied to on start?

=== List Unapproved Transfers ===
* '''URL''': <code>/api/transfer/unapproved</code>
* '''Verb''': GET
* Returns a list of transfers waiting for approval.
* '''Response''': JSON
** <code>message</code>: "Fetched unapproved transfers successfully."
** <code>results</code>: List of dicts with keys:
*** <code>type</code>: Transfer type. One of: standard, unzipped bag, zipped bag, dspace
*** <code>directory</code>: Directory the transfer is in currently
*** <code>uuid</code>: UUID of the transfer

=== Approve Transfer ===
* '''URL''': <code>/api/transfer/approve</code>
* '''Verb''': POST
* Approve a transfer waiting to be started.
* '''Parameters''': JSON body
** <code>type</code>: Type of the transfer to approved. One of: standard, unzipped bag, zipped bag, dspace.
** <code>directory</code>: Name of the directory for the transfer to approve
* '''Response''': JSON
** <code>message</code>: "Approval successful."
** <code>uuid</code>: UUID of the approved transfer

=== Status ===
* '''URL''': <code>/api/transfer/status/<transfer UUID>/</code>
* '''Verb''': GET
* Returns the status of the transfer.
* '''Response''': JSON
** <code>status</code>: One of FAILED, REJECTED, USER_INPUT, COMPLETE or PROCESSING
** <code>name</code>: Name of the transfer, e.g. "imgs"
** <code>sip_uuid</code>: If status is COMPLETE, this field will exist with either the UUID of the SIP or 'BACKLOG'
** <code>microservice</code>: Name of the current microservice
** <code>directory</code>: Name of the directory, e.g. "imgs-52dd0c01-e803-423a-be5f-b592b5d5d61c"
** <code>path</code>: Full path to the transfer, e.g. "/var/archivematica/sharedDirectory/watchedDirectories/SIPCreation/completedTransfers/imgs-52dd0c01-e803-423a-be5f-b592b5d5d61c/"
** <code>message</code>: "Fetched status for <transfer UUID> successfully."
** <code>type</code>: "transfer"
** <code>uuid</code>: UUID of the transfer, e.g. "52dd0c01-e803-423a-be5f-b592b5d5d61c"
'''Note:''' for consumers of this endpoint, it is possible for Archivematica to return a <code>status</code> of <code>COMPLETE</code> without a <code>sip_uuid</code>. Consumers looking to use the UUID of the AIP that will be created following Ingest should therefore test for both a <code>status</code> of <code>COMPLETE</code> and the existence of <code>sip_uuid</code> that does not also equal <code>BACKLOG</code> to ensure that they retrieve it. This might mean an additional call to the status endpoint while this data becomes available.

=== Hide ===
* '''URL''': <code>/api/transfer/<transfer UUID>/delete/</code>
* '''Verb''': DELETE
* Hide a transfer
* '''Response''': JSON
** <code>removed</code>: True

=== Completed ===
* '''URL''': <code>/api/transfer/completed/</code>
* '''Verb''': GET
* Return list of Transfers that are completed
* '''Response''': JSON
** <code>message</code>: "Fetched completed transfers successfully."
** <code>results</code>: List of UUIDs of completed Transfers
* Added in Archivematica 1.6

=== Start Reingest ===
* '''URL''': <code>/api/transfer/reingest</code>
* '''Verb''': POST
* Start a full reingest.
* '''Parameters''': JSON body
** <code>name</code>: Name of the AIP. The AIP should also be found at <code>%sharedDirectory%/tmp/<name></code>
** <code>uuid</code>: UUID of the AIP to reingest
* '''Response''': JSON
** <code>message</code>: "Approval successful."
** <code>reingest_uuid</code>: UUID of the reingested transfer

== Ingest ==

=== Status ===
* '''URL''': <code>/ingest/status/<unit UUID>/</code>
* '''Verb''': GET
* Returns the status of the SIP
* '''Response''': JSON
** <code>status</code>: One of FAILED, REJECTED, USER_INPUT, COMPLETE or PROCESSING
** <code>name</code>: Name of the SIP, e.g. "imgs"
** <code>microservice</code>: Name of the current microservice
** <code>directory</code>: Name of the directory, e.g. "imgs-52dd0c01-e803-423a-be5f-b592b5d5d61c"
** <code>path</code>: Full path to the transfer, e.g. "/var/archivematica/sharedDirectory/currentlyProcessing/imgs-52dd0c01-e803-423a-be5f-b592b5d5d61c/"
** <code>message</code>: "Fetched status for <SIP UUID> successfully."
** <code>type</code>: "SIP"
** <code>uuid</code>: UUID of the SIP, e.g. "52dd0c01-e803-423a-be5f-b592b5d5d61c"

=== Hide ===
* '''URL''': <code>/api/ingest/<SIP UUID>/delete/</code>
* '''Verb''': DELETE
* Hide a SIP
* '''Response''': JSON
** <code>removed</code>: True

=== List SIPS Waiting for User Input ===
* '''URL''': <code>/api/ingest/waiting</code>
* '''Verb''': GET
* Returns a list of SIPs waiting for user input.
* '''Response''': JSON
** <code>message</code>: "Fetched units successfully."
** <code>results</code>: List of dicts with keys:
*** <code>sip_directory</code>: Directory the SIP is in currently
*** <code>sip_uuid</code>: UUID of the SIP
*** <code>sip_name</code>: Name of the SIP
*** <code>microservice</code>: Name of the current microservice

{| class="wikitable" style="background-color:#ffeecc;" cellpadding="10";
| Improvement Note: Despite the URL, this currently returns both SIPs & transfers that are waiting for user input. A separate <code>/api/transfer/waiting</code> should be added for transfers.
|}

=== Completed ===
* '''URL''': <code>/api/ingest/completed/</code>
* '''Verb''': GET
* Return list of SIPs that are completed
* '''Response''': JSON
** <code>message</code>: "Fetched completed ingests successfully."
** <code>results</code>: List of UUIDs of completed SIPs
* Added in Archivematica 1.6

=== Reingest ===
* '''URL''': <code>/api/ingest/reingest</code>
* '''Verb''': POST
* Start a partial or metadata-only reingest.
* '''Parameters''': JSON body
** <code>name</code>: Name of the AIP. The AIP should also be found at <code>%sharedDirectory%/tmp/<name></code>
** <code>uuid</code>: UUID of the AIP to reingest
* '''Response''': JSON
** <code>message</code>: "Approval successful."
** <code>reingest_uuid</code>: UUID of the reingested SIP

=== Copy Metadata ===
* '''URL''': <code>/api/ingest/copy_metadata_files/</code>
* '''Verb''': POST
* Add metadata files to a SIP.
* '''Parameters''': JSON body
** <code>sip_uuid</code>: UUID of the SIP to put files in
** <code>source_paths[]</code>: List of files to be copied, base64 encoded, in the format 'source_location_uuid:full_path'
* '''Response''': JSON
** <code>error</code>: False
** <code>message</code>: "Files added successfully."

== Administration ==

=== Levels of Description ===
* '''URL''': <code>/api/administration/dips/atom/levels/</code>
* '''Verb''': GET?
* Return a JSON-encoded set of the configured levels of description.
* ''Response'': JSON. List of AtoM Levels of description with key 'UUID' and value 'name of level of description'.

=== Fetch Levels of Description ===
* '''URL''': <code>/api/administration/dips/atom/fetch_levels/</code>
* '''Verb''': GET?
* Fetch all levels of description from an AtoM database, replacing any previously existing.
* '''Response''': JSON. Updated list of AtoM Levels of description with key 'UUID' and value 'name of level of description'.

== Unit ==

''Note: Currently, you can only query strings in English.''

=== List jobs ===
* '''URL''': <code>/api/v2beta/jobs/<unit UUID>/</code>
* '''Verb''': GET
* Return a list of jobs for the passed unit (transfer or ingest).
* '''Parameters''':
* '''Optional filters''':
*** <code>microservice</code>: Name of the microservice the jobs belong to
*** <code>link_uuid</code>: UUID of the job chain link
*** <code>name</code>: Name of the job
* '''Response''': JSON body
** '''List of dicts with keys''':
*** <code>uuid</code>: UUID of the job
*** <code>name</code>: Name of the job
*** <code>status</code>: One of USER_INPUT, PROCESSING, COMPLETE, FAILED or UNKNOWN
*** <code>microservice</code>: Microservice the job belongs to
*** <code>link_uuid</code>: UUID of the job chain link
*** <code>tasks</code>: List of dicts with information about the microservice's tasks:
*** <code>uuid</code>: UUID of the task
*** <code>exit_code</code>: Exit code of the task

=== Task ===
* '''URL''': <code>/api/v2beta/task/<task UUID>/</code>
* '''Verb''': GET
* Return information about a task.
* '''Response''': JSON body
** <code>uuid</code>: UUID of the task
** <code>exit_code</code>: Exit code of the task
** <code>file_uuid</code>: UUID of the file used for the task
** <code>file_name</code>: File used for the task,
** <code>time_created</code>: String (YYYY-MM-DD HH:MM:SS) representing when the task was created
** <code>time_started</code>: String (YYYY-MM-DD HH:MM:SS) representing when the task started
** <code>time_ended</code>: String (YYYY-MM-DD HH:MM:SS) representing when the task finished
** <code>duration</code>: Task duration in seconds (integer). If the duration is less than a second, this will be a < 1 string

== Other ==

=== Path Metadata ===
* '''URL''': <code>/api/filesystem/metadata/</code>
* '''Verb''': GET, POST
* Fetch (GET) or update (POST) metadata for a path (currently only level of description).
* '''Parameters''': Query string parameters (GET) or JSON body (POST)
** <code>path</code>: Arranged path to get metadata on
* '''GET response''': JSON
** <code>level_of_description</code>: Level of description
* '''POST response''': JSON
** <code>success</code>: True

=== Processing Configuration ===
* '''URL''': <code>/api/processing-configuration/<name></code>
* '''Verb''': GET?
* Return processing configuration with <name>
* '''Response''': The processing config file as a stream.
* '''Content type''': text/xml

== Beta endpoints ==

API endpoints which are still in-flux and that could potentially change.

=== Package ===

Provides additional functionality over the start and approve transfer endpoints, for example, wrapping both those steps into a single call.

* '''URL''': <code>/api/v2beta/package</code>
* '''Verb''': POST
* Start a new transfer type.
* '''Parameters''': JSON body
** Mandatory
*** <code>name</code>: Transfer name
*** <code>path</code>: Path relative, or absolute to a storage service transfer source
**Optional
*** <code>type</code>: Transfer type, e.g. standard, dataverse, zipped bag, default: <code>standard</code>
*** <code>processing_config</code>: [https://www.archivematica.org/en/docs/latest/user-manual/administer/dashboard-admin/#processing-configuration Processing configuration], e.g. default, automated, default: <code>default</code>
*** <code>accession</code>: Accession ID
*** <code>access_system_id</code>: Access system ID (see [https://www.archivematica.org/en/docs/latest/user-manual/access/access docs])
*** <code>metadata_set_id</code>: Used to link to metadata sets added via the user interface. It's safe to ignore this for now since metadata can't be associated to transfer via the API at the moment.
*** <code>auto_approve</code>: Boolean <code>true</code> or <code>false</code> to set the transfer to auto-approve, default: <code>true</code>
* '''Response''': JSON
** <code>id</code>: Transfer UUID ('''Note:''' as the package endpoint allows the caller to interact with Archivematica asynchronously it doesn't guarantee a transfer has started. The caller must use the UUID in the response to verify it has begun or any errors that were encountered initiating one.)
'''Examples:'''
<br/>
Only a subset of these options might be needed for most use-cases. A fundamental difference between the <code>package</code> endpoint and others from which a transfer can be initiated is that a storage service transfer location UUID isnt always required. In some cases that might still be ideal.
<br/><br/>
''Starting a transfer using an absolute path:''
<br/>
<pre>
curl -v POST \
-H "Authorization: ApiKey test:test" \
-H "Content-Type: application/json" \
-d "{\
\"path\": \"$(echo -n '/home/archivematica/archivematica-sampledata/SampleTransfers/DemoTransferCSV' | base64 -w 0)\", \
\"name\": \"demo_transfer_absolute\", \
\"processing_config\": \"automated\", \
\"type\": \"standard\" \
}" \
"http://<archivematica-uri>/api/v2beta/package"
</pre>
''Starting a transfer using an relative path with a transfer source UUID:''
<br/>
<pre>
curl -v POST \
-H "Authorization: ApiKey test:test" \
-H "Content-Type: application/json" \
-d "{\
\"path\": \"$(echo -n 'd1184f7f-d755-4c8d-831a-a3793b88f760:/archivematica/archivematica-sampledata/SampleTransfers/DemoTransferCSV' | base64 -w 0)\", \
\"name\": \"demo_transfer_relative\", \
\"processing_config\": \"automated\", \
\"type\": \"standard\" \
}" \
"http://<archivematica-uri>/api/v2beta/package"
</pre>

=== Validate ===

Available in Archivematica 1.10+. This endpoint can be used to validate CSVs against embedded sets of rules. Currently works with Avalon Media System Manifest files.

In the future, this endpoint can be extended to support validation for <code>metadata.csv</code> or <code>rights.csv</code>, or other institutionally-based rules.

* '''URL''': <code>/api/v2beta/validate/avalon</code>
* '''Content-Type''': text/csv; charset=utf-8
* '''Parameters''': <code><document></code>

Usage example: (assuming that <code>avalon.csv</code> exists)

<pre>
curl http://127.0.0.1:62080/api/v2beta/validate/avalon \
--data-binary "@avalon.csv" \
--header "Authorization: ApiKey test:test" \
--header "Content-Type: text/csv; charset=utf-8"
</pre>

Response examples:

200 OK

<pre>
{
"valid": true
}
</pre>

400 Bad Request (expect reason to include different validation errors)

<pre>
{
"valid": false,
"reason": "Administrative data must include reference name and author."
}
</pre>

404 Not Found

<pre>
{
"error": true,
"message": "Unknown validator. Accepted values: avalon"
}
</pre>

[[Category:Development documentation]]

Archivematica 1.15.1 and Storage Service 0.21.1 release notes

2023-11-29T20:41:53Z

Dcerna: Add security upgrades

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.15.1 and Storage Service 0.21.1

'''Release date: November 29, 2023'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.15/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.15.1 and Storage Service 0.21.1 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== Security upgrades ===

We have performed upgrades to the follow Python libraries to patch reported security issues in earlier versions:

* agentarchives: from version 0.8.0 to 0.9.0
* amclient: from version 1.2.3 to 1.3.0
* ammcpc: from version 0.1.3 to 0.2.0
* cryptography: from version 41.0.4 to 41.0.7
* django: from version 3.2.22 to 3.2.23
* metsrw: from version 0.4.0 to 0.5.0
* urllib3: from version 1.26.17 to 2.1.0

We have also upgraded the following JavaScript front-end dependencies:

* fsevents: from version 1.1.3 to 1.2.13
* js-yaml: from version 3.7.0 to 3.13.1
* json5: from version 0.5.1 to 1.0.2
* karma: from version 0.13 to 6.0.0
* loader-utils: from version 1.0.2 to 1.4.2
* lodash: from version 4.5.1 to 4.17.12
* nodejs: from version 14.x to 20.x
* shelljs: from version 0.2.6 to 0.8.5

== Fixed ==

=== API endpoint for listing unapproved transfers returns error ===

* Issue: https://github.com/archivematica/Issues/issues/1635

UUID identifiers were not encoded properly in the '''List Unapproved Transfers''' and '''List SIPS Waiting for User Input''' API endpoints.

=== Transfers cannot be moved to the rejected directory ===

* Issue: https://github.com/archivematica/Issues/issues/1636

In the Archivematica 1.15.0 update, there was a backward-incompatible change involving the configuration parsers for Django settings. This change, part of a simplification process, has affected the handling of the ''%%sharedPath%%'' variable. This variable is no longer included in the default settings. If your custom settings rely on this variable, you should now use ''%sharedPath%'' to maintain compatibility with the updated system.

Please see the 1.15.1 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/25?closed=1.

Release Notes

2023-11-29T16:57:25Z

Dcerna: /* Archivematica 1.x releases */

[[Main_Page|Home]] > Release Notes

== About ==

Release notes are prepared by Artefactual for each release of Archivematica. Most releases also have a corresponding release of the Storage System, and may also include corresponding releases for various dependencies and libraries (i.e. FIDO, Automation Tools) - be sure to check the release notes for more information.

Major releases are '''bolded''', minor releases are not.

Features, enhancements, and bug fixes are often sponsored by members of the Archivematica community who are dedicated to funding Archivematica's ongoing development and maintenance. Code contributors are individuals who write Archivematica code and [https://github.com/artefactual/archivematica/blob/stable/1.6.x/CONTRIBUTING.md| contribute it] back to the project. Archivematica couldn't continue to grow without sponsors and contributors - thank you!

Questions about a release or the release notes? Ask on the [https://groups.google.com/forum/#!forum/archivematica| Archivematica Google Group!]

== Security patches ==

* [[Log4j|Log4j vulnerability information]] Updated December 13, 2021

== Archivematica 1.x releases ==

* [[Archivematica_1.15.1_and_Storage_Service_0.21.1_release_notes|Archivematica 1.15.1 and Storage Service 0.21.1 Release Notes]] (Current release)
* [[Archivematica_1.15.0_and_Storage_Service_0.21.0_release_notes|'''Archivematica 1.15.0 and Storage Service 0.21.0 Release Notes''']]
* [[Archivematica_1.14.1_and_Storage_Service_0.20.1_release_notes|Archivematica 1.14.1 and Storage Service 0.20.1 Release Notes]]
* [[Archivematica_1.14.0_and_Storage_Service_0.20.0_release_notes|'''Archivematica 1.14.0 and Storage Service 0.20.0 Release Notes''']]
* [[Storage Service 0.19 Release Notes|'''Storage Service 0.19 Release Notes''']]
* [[Archivematica_1.13.2|Archivematica 1.13.2 Release Notes]]
* [[Archivematica_1.13.1_and_Storage_Service_0.18.1_release_notes|'''Archivematica 1.13.1 and Storage Service 0.18.1 Release Notes''']]
* [[Archivematica_1.13.0_and_Storage_Service_0.18.0_release_notes|'''Archivematica 1.13.0 and Storage Service 0.18.0 Release Notes''']]
* [[Archivematica_1.12.2|Archivematica 1.12.2 Release Notes]]
* [[Archivematica_1.12.1_and_Storage_Service_0.17.1_release_notes|Archivematica 1.12.1 and Storage Service 0.17.1 Release Notes]]
* [[Archivematica_1.12.0_and_Storage_Service_0.17.0_release_notes|'''Archivematica 1.12.0 and Storage Service 0.17.0 Release Notes''']]
* [[Archivematica_1.11.2_and_Storage_Service_0.16.1_release_notes|Archivematica 1.11.2 and Storage Service 0.16.1 Release Notes]]
* [[Archivematica_1.11.1|Archivematica 1.11.1 Release Notes]]
* [[Archivematica_1.11_and_Storage_Service_0.16_release_notes|'''Archivematica 1.11 and Storage Service 0.16 Release Notes''']]
* [[Archivematica_1.10.2|Archivematica 1.10.2 Release Notes]]
* [[Archivematica_1.10.1_release_notes|Archivematica 1.10.1 and Storage Service 0.15.1 Release Notes]]
* [[Archivematica_1.10_and_Storage_Service_0.15_release_notes|'''Archivematica 1.10 and Storage Service 0.15 Release Notes''']]
* [[Archivematica_1.9.3|Archivematica 1.9.3 Release Notes]]
* [[Archivematica_1.9.2_release_notes|Archivematica 1.9.2 Release Notes]]
* [[Archivematica_1.9.1_and_Storage_Service_0.14.1_release_notes|Archivematica 1.9.1 and Storage Service 0.14.1 Release Notes]]
* [[Archivematica_1.9_and_Storage_Service_0.14_release_notes|'''Archivematica 1.9 and Storage Service 0.14 Release Notes''']]
* [[Archivematica_1.8.1_release_notes|Archivematica 1.8.1 Release Notes]]
* [[Archivematica_1.8_and_Storage_Service_0.13_release_notes|'''Archivematica 1.8 and Storage Service 0.13 Release Notes''']]
* [[Archivematica 1.7.2_release_notes|Archivematica 1.7.2 Release Notes]]
* [[Storage Service 0.12 Release Notes|'''Storage Service 0.12 Release Notes''']]
* [[Archivematica 1.7.1_release_notes|Archivematica 1.7.1 Release Notes]]
* [[Storage Service 0.11.1 Release Notes]]
* [[Archivematica_1.7_and_Storage_Service_0.11_release_notes|'''Archivematica 1.7 and Storage Service 0.11 Release Notes''']]
* [[Archivematica_1.6.1_release_notes|Archivematica 1.6.1 Release Notes]]
* [[Archivematica_1.6_release_notes|'''Archivematica 1.6 Release Notes''']]
* [[Archivematica_1.5.1_Release_Notes|Archivematica 1.5.1 Release Notes]]
* [[Archivematica_1.5_Release_Notes|'''Archivematica 1.5 Release Notes''']]
* [[Archivematica_1.4.1_Release_Notes|Archivematica 1.4.1 Release Notes]]
* [[Archivematica_1.4_Release_Notes|'''Archivematica 1.4 Release Notes''']]
* [[Archivematica_1.3.2_Release_Notes|Archivematica 1.3.2 Release Notes]]
* [[Archivematica_1.3.1_Release_Notes|Archivematica 1.3.1 Release Notes]]
* [[Archivematica_1.3_Release_Notes|'''Archivematica 1.3 Release Notes''']]
* [[Archivematica_1.2_Release_Notes|'''Archivematica 1.2 Release Notes''']]
* [[Archivematica_1.1_Release_Notes|'''Archivematica 1.1 Release Notes''']]
* [[Archivematica_1.0_Release_Notes|'''Archivematica 1.0 Release Notes''']]

== Archivematica 0.x releases ==

* [[Archivematica_0.10-beta_Release_Notes|'''Archivematica 0.10 Release Notes''']]
* [[Archivematica_0.9_Release_Notes|'''Archivematica 0.9 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.8 Release Notes''']]
* [[Archivematica_0.7.1_Release_Notes|Archivematica 0.7.1 Release Notes]]
* [[Archivematica_0.7_Release_Notes|'''Archivematica 0.7 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.6 Release Notes''']]

== Templates ==

* [[Major_release_notes|Template for major releases]]
* [[Minor_release_notes|Template for minor releases]]

Release Notes

2023-11-29T16:56:25Z

Dcerna: /* Archivematica 1.x releases */

[[Main_Page|Home]] > Release Notes

== About ==

Release notes are prepared by Artefactual for each release of Archivematica. Most releases also have a corresponding release of the Storage System, and may also include corresponding releases for various dependencies and libraries (i.e. FIDO, Automation Tools) - be sure to check the release notes for more information.

Major releases are '''bolded''', minor releases are not.

Features, enhancements, and bug fixes are often sponsored by members of the Archivematica community who are dedicated to funding Archivematica's ongoing development and maintenance. Code contributors are individuals who write Archivematica code and [https://github.com/artefactual/archivematica/blob/stable/1.6.x/CONTRIBUTING.md| contribute it] back to the project. Archivematica couldn't continue to grow without sponsors and contributors - thank you!

Questions about a release or the release notes? Ask on the [https://groups.google.com/forum/#!forum/archivematica| Archivematica Google Group!]

== Security patches ==

* [[Log4j|Log4j vulnerability information]] Updated December 13, 2021

== Archivematica 1.x releases ==

* [[Archivematica_1.15.1_and_Storage_Service_0.21.1_release_notes|'''Archivematica 1.15.1 and Storage Service 0.21.1 Release Notes''']] (Current release)
* [[Archivematica_1.15.0_and_Storage_Service_0.21.0_release_notes|'''Archivematica 1.15.0 and Storage Service 0.21.0 Release Notes''']]
* [[Archivematica_1.14.1_and_Storage_Service_0.20.1_release_notes|Archivematica 1.14.1 and Storage Service 0.20.1 Release Notes]]
* [[Archivematica_1.14.0_and_Storage_Service_0.20.0_release_notes|'''Archivematica 1.14.0 and Storage Service 0.20.0 Release Notes''']]
* [[Storage Service 0.19 Release Notes|'''Storage Service 0.19 Release Notes''']]
* [[Archivematica_1.13.2|Archivematica 1.13.2 Release Notes]]
* [[Archivematica_1.13.1_and_Storage_Service_0.18.1_release_notes|'''Archivematica 1.13.1 and Storage Service 0.18.1 Release Notes''']]
* [[Archivematica_1.13.0_and_Storage_Service_0.18.0_release_notes|'''Archivematica 1.13.0 and Storage Service 0.18.0 Release Notes''']]
* [[Archivematica_1.12.2|Archivematica 1.12.2 Release Notes]]
* [[Archivematica_1.12.1_and_Storage_Service_0.17.1_release_notes|Archivematica 1.12.1 and Storage Service 0.17.1 Release Notes]]
* [[Archivematica_1.12.0_and_Storage_Service_0.17.0_release_notes|'''Archivematica 1.12.0 and Storage Service 0.17.0 Release Notes''']]
* [[Archivematica_1.11.2_and_Storage_Service_0.16.1_release_notes|Archivematica 1.11.2 and Storage Service 0.16.1 Release Notes]]
* [[Archivematica_1.11.1|Archivematica 1.11.1 Release Notes]]
* [[Archivematica_1.11_and_Storage_Service_0.16_release_notes|'''Archivematica 1.11 and Storage Service 0.16 Release Notes''']]
* [[Archivematica_1.10.2|Archivematica 1.10.2 Release Notes]]
* [[Archivematica_1.10.1_release_notes|Archivematica 1.10.1 and Storage Service 0.15.1 Release Notes]]
* [[Archivematica_1.10_and_Storage_Service_0.15_release_notes|'''Archivematica 1.10 and Storage Service 0.15 Release Notes''']]
* [[Archivematica_1.9.3|Archivematica 1.9.3 Release Notes]]
* [[Archivematica_1.9.2_release_notes|Archivematica 1.9.2 Release Notes]]
* [[Archivematica_1.9.1_and_Storage_Service_0.14.1_release_notes|Archivematica 1.9.1 and Storage Service 0.14.1 Release Notes]]
* [[Archivematica_1.9_and_Storage_Service_0.14_release_notes|'''Archivematica 1.9 and Storage Service 0.14 Release Notes''']]
* [[Archivematica_1.8.1_release_notes|Archivematica 1.8.1 Release Notes]]
* [[Archivematica_1.8_and_Storage_Service_0.13_release_notes|'''Archivematica 1.8 and Storage Service 0.13 Release Notes''']]
* [[Archivematica 1.7.2_release_notes|Archivematica 1.7.2 Release Notes]]
* [[Storage Service 0.12 Release Notes|'''Storage Service 0.12 Release Notes''']]
* [[Archivematica 1.7.1_release_notes|Archivematica 1.7.1 Release Notes]]
* [[Storage Service 0.11.1 Release Notes]]
* [[Archivematica_1.7_and_Storage_Service_0.11_release_notes|'''Archivematica 1.7 and Storage Service 0.11 Release Notes''']]
* [[Archivematica_1.6.1_release_notes|Archivematica 1.6.1 Release Notes]]
* [[Archivematica_1.6_release_notes|'''Archivematica 1.6 Release Notes''']]
* [[Archivematica_1.5.1_Release_Notes|Archivematica 1.5.1 Release Notes]]
* [[Archivematica_1.5_Release_Notes|'''Archivematica 1.5 Release Notes''']]
* [[Archivematica_1.4.1_Release_Notes|Archivematica 1.4.1 Release Notes]]
* [[Archivematica_1.4_Release_Notes|'''Archivematica 1.4 Release Notes''']]
* [[Archivematica_1.3.2_Release_Notes|Archivematica 1.3.2 Release Notes]]
* [[Archivematica_1.3.1_Release_Notes|Archivematica 1.3.1 Release Notes]]
* [[Archivematica_1.3_Release_Notes|'''Archivematica 1.3 Release Notes''']]
* [[Archivematica_1.2_Release_Notes|'''Archivematica 1.2 Release Notes''']]
* [[Archivematica_1.1_Release_Notes|'''Archivematica 1.1 Release Notes''']]
* [[Archivematica_1.0_Release_Notes|'''Archivematica 1.0 Release Notes''']]

== Archivematica 0.x releases ==

* [[Archivematica_0.10-beta_Release_Notes|'''Archivematica 0.10 Release Notes''']]
* [[Archivematica_0.9_Release_Notes|'''Archivematica 0.9 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.8 Release Notes''']]
* [[Archivematica_0.7.1_Release_Notes|Archivematica 0.7.1 Release Notes]]
* [[Archivematica_0.7_Release_Notes|'''Archivematica 0.7 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.6 Release Notes''']]

== Templates ==

* [[Major_release_notes|Template for major releases]]
* [[Minor_release_notes|Template for minor releases]]

Archivematica 1.15.1 and Storage Service 0.21.1 release notes

2023-11-29T16:55:57Z

Dcerna: Archivematica 1.15.1 and Storage Service 0.21.1 release notes

Archivematica 1.15.0 and Storage Service 0.21.0 release notes

2023-10-06T16:35:26Z

Dcerna:

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.15.0 and Storage Service 0.21.0

'''Release date: TBD'''

== Environments ==

Please see the installation instructions [WIP].

Archivematica 1.15.0 and Storage Service 0.21.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== Support for Ubuntu 22.04 and Rocky Linux 9 ===

* Issue: https://github.com/archivematica/Issues/issues/1590

Archivematica 1.15 dropped support for Ubuntu 18.04 and CentOS 7.

=== MySQL 8.0 ===

* Issue: https://github.com/archivematica/Issues/issues/1618

Archivematica 1.15 dropped support for MySQL 5.x.

=== Python 3.9 ===

* Issue: https://github.com/archivematica/Issues/issues/1612

Archivematica 1.15 dropped support for Python 3.6.

=== Django 3.2 ===

* Issue: https://github.com/archivematica/Issues/issues/1279

Archivematica 1.15 dropped support for Django 1.11.

== Fixed ==

=== METS schema validation when loc.gov URLs are unreachable ===

* Issue: https://github.com/archivematica/Issues/issues/1266

Archivematica uses a local [https://en.wikipedia.org/wiki/XML_catalog XML catalog] to avoid contacting the loc.gov URLs.

=== Storage Service LDAP configuration ===

* Issue: https://github.com/archivematica/Issues/issues/1629

Please see the 1.15.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/22.

Archivematica 1.15.0 and Storage Service 0.21.0 release notes

2023-10-06T16:34:29Z

Dcerna: /* METS schema validation when loc.gov URLs are unreachable */

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.15.0 and Storage Service 0.21.0

'''Release date: TBD'''

== Environments ==

Please see the installation instructions [WIP].

Archivematica 1.15.0 and Storage Service 0.21.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== Support for Ubuntu 22.04 and Rocky Linux 9 ===

* Issue: https://github.com/archivematica/Issues/issues/1590

Archivematica 1.15 dropped support for Ubuntu 18.04 and CentOS 7.

=== MySQL 8.0 ===

* Issue: https://github.com/archivematica/Issues/issues/1618

Archivematica 1.15 dropped support for MySQL 5.x.

=== Python 3.9 ===

* Issue: https://github.com/archivematica/Issues/issues/1612

Archivematica 1.15 dropped support for Python 3.6.

=== Django 3.2 ===

* Issue: https://github.com/archivematica/Issues/issues/1279

Archivematica 1.15 dropped support for Django 1.11.

== Fixed ==

=== METS schema validation when loc.gov URLs are unreachable ===

* Issue: https://github.com/archivematica/Issues/issues/1266

Archivematica uses a local [XML catalog](https://en.wikipedia.org/wiki/XML_catalog) to avoid contacting the loc.gov URLs.

=== Storage Service LDAP configuration ===

* Issue: https://github.com/archivematica/Issues/issues/1629

Please see the 1.15.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/22.

Archivematica 1.15.0 and Storage Service 0.21.0 release notes

2023-10-06T16:32:54Z

Dcerna: Archivematica 1.15.0

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.15.0 and Storage Service 0.21.0

'''Release date: TBD'''

== Environments ==

Please see the installation instructions [WIP].

Archivematica 1.15.0 and Storage Service 0.21.0 have been tested in the following environments:

* Ubuntu 22.04 64-bit Server Edition
* Rocky Linux 9 x86_64

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Changed ==

=== Support for Ubuntu 22.04 and Rocky Linux 9 ===

* Issue: https://github.com/archivematica/Issues/issues/1590

Archivematica 1.15 dropped support for Ubuntu 18.04 and CentOS 7.

=== MySQL 8.0 ===

* Issue: https://github.com/archivematica/Issues/issues/1618

Archivematica 1.15 dropped support for MySQL 5.x.

=== Python 3.9 ===

* Issue: https://github.com/archivematica/Issues/issues/1612

Archivematica 1.15 dropped support for Python 3.6.

=== Django 3.2 ===

* Issue: https://github.com/archivematica/Issues/issues/1279

Archivematica 1.15 dropped support for Django 1.11.

== Fixed ==

=== METS schema validation when loc.gov URLs are unreachable ===

* Issue: https://github.com/archivematica/Issues/issues/1266

=== Storage Service LDAP configuration ===

* Issue: https://github.com/archivematica/Issues/issues/1629

Please see the 1.15.0 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/22.

Release Notes

2023-10-06T16:06:06Z

Dcerna: Archivematica 1.15.0

[[Main_Page|Home]] > Release Notes

== About ==

Release notes are prepared by Artefactual for each release of Archivematica. Most releases also have a corresponding release of the Storage System, and may also include corresponding releases for various dependencies and libraries (i.e. FIDO, Automation Tools) - be sure to check the release notes for more information.

Major releases are '''bolded''', minor releases are not.

Features, enhancements, and bug fixes are often sponsored by members of the Archivematica community who are dedicated to funding Archivematica's ongoing development and maintenance. Code contributors are individuals who write Archivematica code and [https://github.com/artefactual/archivematica/blob/stable/1.6.x/CONTRIBUTING.md| contribute it] back to the project. Archivematica couldn't continue to grow without sponsors and contributors - thank you!

Questions about a release or the release notes? Ask on the [https://groups.google.com/forum/#!forum/archivematica| Archivematica Google Group!]

== Security patches ==

* [[Log4j|Log4j vulnerability information]] Updated December 13, 2021

== Archivematica 1.x releases ==

* [[Archivematica_1.15.0_and_Storage_Service_0.21.0_release_notes|'''Archivematica 1.15.0 and Storage Service 0.21.0 Release Notes''']] (Next release)
* [[Archivematica_1.14.1_and_Storage_Service_0.20.1_release_notes|Archivematica 1.14.1 and Storage Service 0.20.1 Release Notes]] (Current release)
* [[Archivematica_1.14.0_and_Storage_Service_0.20.0_release_notes|'''Archivematica 1.14.0 and Storage Service 0.20.0 Release Notes''']]
* [[Storage Service 0.19 Release Notes|'''Storage Service 0.19 Release Notes''']]
* [[Archivematica_1.13.2|Archivematica 1.13.2 Release Notes]]
* [[Archivematica_1.13.1_and_Storage_Service_0.18.1_release_notes|'''Archivematica 1.13.1 and Storage Service 0.18.1 Release Notes''']]
* [[Archivematica_1.13.0_and_Storage_Service_0.18.0_release_notes|'''Archivematica 1.13.0 and Storage Service 0.18.0 Release Notes''']]
* [[Archivematica_1.12.2|Archivematica 1.12.2 Release Notes]]
* [[Archivematica_1.12.1_and_Storage_Service_0.17.1_release_notes|Archivematica 1.12.1 and Storage Service 0.17.1 Release Notes]]
* [[Archivematica_1.12.0_and_Storage_Service_0.17.0_release_notes|'''Archivematica 1.12.0 and Storage Service 0.17.0 Release Notes''']]
* [[Archivematica_1.11.2_and_Storage_Service_0.16.1_release_notes|Archivematica 1.11.2 and Storage Service 0.16.1 Release Notes]]
* [[Archivematica_1.11.1|Archivematica 1.11.1 Release Notes]]
* [[Archivematica_1.11_and_Storage_Service_0.16_release_notes|'''Archivematica 1.11 and Storage Service 0.16 Release Notes''']]
* [[Archivematica_1.10.2|Archivematica 1.10.2 Release Notes]]
* [[Archivematica_1.10.1_release_notes|Archivematica 1.10.1 and Storage Service 0.15.1 Release Notes]]
* [[Archivematica_1.10_and_Storage_Service_0.15_release_notes|'''Archivematica 1.10 and Storage Service 0.15 Release Notes''']]
* [[Archivematica_1.9.3|Archivematica 1.9.3 Release Notes]]
* [[Archivematica_1.9.2_release_notes|Archivematica 1.9.2 Release Notes]]
* [[Archivematica_1.9.1_and_Storage_Service_0.14.1_release_notes|Archivematica 1.9.1 and Storage Service 0.14.1 Release Notes]]
* [[Archivematica_1.9_and_Storage_Service_0.14_release_notes|'''Archivematica 1.9 and Storage Service 0.14 Release Notes''']]
* [[Archivematica_1.8.1_release_notes|Archivematica 1.8.1 Release Notes]]
* [[Archivematica_1.8_and_Storage_Service_0.13_release_notes|'''Archivematica 1.8 and Storage Service 0.13 Release Notes''']]
* [[Archivematica 1.7.2_release_notes|Archivematica 1.7.2 Release Notes]]
* [[Storage Service 0.12 Release Notes|'''Storage Service 0.12 Release Notes''']]
* [[Archivematica 1.7.1_release_notes|Archivematica 1.7.1 Release Notes]]
* [[Storage Service 0.11.1 Release Notes]]
* [[Archivematica_1.7_and_Storage_Service_0.11_release_notes|'''Archivematica 1.7 and Storage Service 0.11 Release Notes''']]
* [[Archivematica_1.6.1_release_notes|Archivematica 1.6.1 Release Notes]]
* [[Archivematica_1.6_release_notes|'''Archivematica 1.6 Release Notes''']]
* [[Archivematica_1.5.1_Release_Notes|Archivematica 1.5.1 Release Notes]]
* [[Archivematica_1.5_Release_Notes|'''Archivematica 1.5 Release Notes''']]
* [[Archivematica_1.4.1_Release_Notes|Archivematica 1.4.1 Release Notes]]
* [[Archivematica_1.4_Release_Notes|'''Archivematica 1.4 Release Notes''']]
* [[Archivematica_1.3.2_Release_Notes|Archivematica 1.3.2 Release Notes]]
* [[Archivematica_1.3.1_Release_Notes|Archivematica 1.3.1 Release Notes]]
* [[Archivematica_1.3_Release_Notes|'''Archivematica 1.3 Release Notes''']]
* [[Archivematica_1.2_Release_Notes|'''Archivematica 1.2 Release Notes''']]
* [[Archivematica_1.1_Release_Notes|'''Archivematica 1.1 Release Notes''']]
* [[Archivematica_1.0_Release_Notes|'''Archivematica 1.0 Release Notes''']]

== Archivematica 0.x releases ==

* [[Archivematica_0.10-beta_Release_Notes|'''Archivematica 0.10 Release Notes''']]
* [[Archivematica_0.9_Release_Notes|'''Archivematica 0.9 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.8 Release Notes''']]
* [[Archivematica_0.7.1_Release_Notes|Archivematica 0.7.1 Release Notes]]
* [[Archivematica_0.7_Release_Notes|'''Archivematica 0.7 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.6 Release Notes''']]

== Templates ==

* [[Major_release_notes|Template for major releases]]
* [[Minor_release_notes|Template for minor releases]]

Archivematica 1.14.0 and Storage Service 0.20.0 release notes

2023-07-20T14:52:31Z

Dcerna: /* Other changes */

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.14.0 and Storage Service 0.20.0

'''Release date: June 15, 2023'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.14/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.14.0 and Storage Service 0.20.0 have been tested in the following environments:

* Ubuntu 18.04 64-bit Server Edition
* CentOS 7 64-bit

Support for Ubuntu 22.04 and Rocky Linux 9 will be coming in the 1.15 release.

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Added ==

=== Metadata import, reingest and validation in XML ===

This is a new set of features that allows users to include metadata files in XML and have them parsed into the AIP METS file. Optionally, the metadata files can also be validated against an external or local schema. It also has improved the handling of updating or deleting metadata on reingest.

[https://github.com/archivematica/Issues/issues/1531 GitHub issue 1531]

[https://github.com/archivematica/Issues/issues/1537 GitHub issue 1537]

[https://archivematica.org/en/docs/archivematica-1.14/user-manual/transfer/import-metadata/#metadata-xml-validation Documentation]

This feature was sponsored by the Saxon State and University Library Dresden. Thank you!

=== Rclone spaces in the Storage Service ===

The [https://rclone.org/ Rclone] space allows for use of over 40 cloud providers with Archivematica as Transfer Source, AIP Store, DIP Store, and Replicator locations.

[https://github.com/archivematica/Issues/issues/1567 Github issue 1567]

[https://archivematica.org/en/docs/storage-service-0.20/administrators/#rclone Documentation]

== Changed ==

=== PRONOM v.109 ===

As of this Archivematica release, we are up to date to PRONOM v. 109.

[https://github.com/archivematica/Issues/issues/1592 GitHub issue 1592]

=== Other changes ===

* Python 2.7 removed [https://github.com/archivematica/Issues/issues/1506 GitHub issue 1506]
* Ability to override LDAP Attributes [https://github.com/archivematica/Issues/issues/1565 Github issue 1565] '''Contributed by Tom Misilo- thank you!'''

== Fixed ==

Please see the 1.14 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/20?closed=1.

Archivematica 1.14.0 and Storage Service 0.20.0 release notes

2023-07-20T14:49:04Z

Dcerna: /* Added */

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.14.0 and Storage Service 0.20.0

'''Release date: June 15, 2023'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.14/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.14.0 and Storage Service 0.20.0 have been tested in the following environments:

* Ubuntu 18.04 64-bit Server Edition
* CentOS 7 64-bit

Support for Ubuntu 22.04 and Rocky Linux 9 will be coming in the 1.15 release.

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Added ==

=== Metadata import, reingest and validation in XML ===

This is a new set of features that allows users to include metadata files in XML and have them parsed into the AIP METS file. Optionally, the metadata files can also be validated against an external or local schema. It also has improved the handling of updating or deleting metadata on reingest.

[https://github.com/archivematica/Issues/issues/1531 GitHub issue 1531]

[https://github.com/archivematica/Issues/issues/1537 GitHub issue 1537]

[https://archivematica.org/en/docs/archivematica-1.14/user-manual/transfer/import-metadata/#metadata-xml-validation Documentation]

This feature was sponsored by the Saxon State and University Library Dresden. Thank you!

=== Rclone spaces in the Storage Service ===

The [https://rclone.org/ Rclone] space allows for use of over 40 cloud providers with Archivematica as Transfer Source, AIP Store, DIP Store, and Replicator locations.

[https://github.com/archivematica/Issues/issues/1567 Github issue 1567]

[https://archivematica.org/en/docs/storage-service-0.20/administrators/#rclone Documentation]

== Changed ==

=== PRONOM v.109 ===

As of this Archivematica release, we are up to date to PRONOM v. 109.

[https://github.com/archivematica/Issues/issues/1592 GitHub issue 1592]

=== Other changes ===

* Python 2.7 removed [https://github.com/archivematica/Issues/issues/1506 GitHub issue 1506]
* rclone support in Storage Service [https://github.com/archivematica/Issues/issues/1567 GitHub issue 1567]
* Ability to override LDAP Attributes [https://github.com/archivematica/Issues/issues/1565 Github issue 1565] '''Contributed by Tom Misilo- thank you!'''

== Fixed ==

Please see the 1.14 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/20?closed=1.

Archivematica 1.14.0 and Storage Service 0.20.0 release notes

2023-07-20T14:46:36Z

Dcerna: /* Added RClone spaces note */

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.14.0 and Storage Service 0.20.0

'''Release date: June 15, 2023'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.14/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.14.0 and Storage Service 0.20.0 have been tested in the following environments:

* Ubuntu 18.04 64-bit Server Edition
* CentOS 7 64-bit

Support for Ubuntu 22.04 and Rocky Linux 9 will be coming in the 1.15 release.

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Added ==

=== Metadata import, reingest and validation in XML ===

This is a new set of features that allows users to include metadata files in XML and have them parsed into the AIP METS file. Optionally, the metadata files can also be validated against an external or local schema. It also has improved the handling of updating or deleting metadata on reingest.

[https://github.com/archivematica/Issues/issues/1531 GitHub issue 1531]

[https://github.com/archivematica/Issues/issues/1537 GitHub issue 1537]

[https://archivematica.org/en/docs/archivematica-1.14/user-manual/transfer/import-metadata/#metadata-xml-validation Documentation]

This feature was sponsored by the Saxon State and University Library Dresden. Thank you!

=== Rclone spaces in the Storage Service ===

The [https://archivematica.org/en/docs/storage-service-0.20/administrators/#rclone Rclone] space allows for use of over 40 cloud providers with Archivematica as Transfer Source, AIP Store, DIP Store, and Replicator locations.

[https://github.com/archivematica/Issues/issues/1567 Github issue 1567]

== Changed ==

=== PRONOM v.109 ===

As of this Archivematica release, we are up to date to PRONOM v. 109.

[https://github.com/archivematica/Issues/issues/1592 GitHub issue 1592]

=== Other changes ===

* Python 2.7 removed [https://github.com/archivematica/Issues/issues/1506 GitHub issue 1506]
* rclone support in Storage Service [https://github.com/archivematica/Issues/issues/1567 GitHub issue 1567]
* Ability to override LDAP Attributes [https://github.com/archivematica/Issues/issues/1565 Github issue 1565] '''Contributed by Tom Misilo- thank you!'''

== Fixed ==

Please see the 1.14 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/20?closed=1.

Release Notes

2023-07-19T16:48:51Z

Dcerna: /* Archivematica 1.x releases */

[[Main_Page|Home]] > Release Notes

== About ==

Release notes are prepared by Artefactual for each release of Archivematica. Most releases also have a corresponding release of the Storage System, and may also include corresponding releases for various dependencies and libraries (i.e. FIDO, Automation Tools) - be sure to check the release notes for more information.

Major releases are '''bolded''', minor releases are not.

Features, enhancements, and bug fixes are often sponsored by members of the Archivematica community who are dedicated to funding Archivematica's ongoing development and maintenance. Code contributors are individuals who write Archivematica code and [https://github.com/artefactual/archivematica/blob/stable/1.6.x/CONTRIBUTING.md| contribute it] back to the project. Archivematica couldn't continue to grow without sponsors and contributors - thank you!

Questions about a release or the release notes? Ask on the [https://groups.google.com/forum/#!forum/archivematica| Archivematica Google Group!]

== Security patches ==

* [[Log4j|Log4j vulnerability information]] Updated December 13, 2021

== Archivematica 1.x releases ==

* [[Archivematica_1.14.1_and_Storage_Service_0.20.1_release_notes|Archivematica 1.14.1 and Storage Service 0.20.1 Release Notes]] (Current release)
* [[Archivematica_1.14.0_and_Storage_Service_0.20.0_release_notes|'''Archivematica 1.14.0 and Storage Service 0.20.0 Release Notes''']]
* [[Storage Service 0.19 Release Notes|'''Storage Service 0.19 Release Notes''']]
* [[Archivematica_1.13.2|Archivematica 1.13.2 Release Notes]]
* [[Archivematica_1.13.1_and_Storage_Service_0.18.1_release_notes|'''Archivematica 1.13.1 and Storage Service 0.18.1 Release Notes''']]
* [[Archivematica_1.13.0_and_Storage_Service_0.18.0_release_notes|'''Archivematica 1.13.0 and Storage Service 0.18.0 Release Notes''']]
* [[Archivematica_1.12.2|Archivematica 1.12.2 Release Notes]]
* [[Archivematica_1.12.1_and_Storage_Service_0.17.1_release_notes|Archivematica 1.12.1 and Storage Service 0.17.1 Release Notes]]
* [[Archivematica_1.12.0_and_Storage_Service_0.17.0_release_notes|'''Archivematica 1.12.0 and Storage Service 0.17.0 Release Notes''']]
* [[Archivematica_1.11.2_and_Storage_Service_0.16.1_release_notes|Archivematica 1.11.2 and Storage Service 0.16.1 Release Notes]]
* [[Archivematica_1.11.1|Archivematica 1.11.1 Release Notes]]
* [[Archivematica_1.11_and_Storage_Service_0.16_release_notes|'''Archivematica 1.11 and Storage Service 0.16 Release Notes''']]
* [[Archivematica_1.10.2|Archivematica 1.10.2 Release Notes]]
* [[Archivematica_1.10.1_release_notes|Archivematica 1.10.1 and Storage Service 0.15.1 Release Notes]]
* [[Archivematica_1.10_and_Storage_Service_0.15_release_notes|'''Archivematica 1.10 and Storage Service 0.15 Release Notes''']]
* [[Archivematica_1.9.3|Archivematica 1.9.3 Release Notes]]
* [[Archivematica_1.9.2_release_notes|Archivematica 1.9.2 Release Notes]]
* [[Archivematica_1.9.1_and_Storage_Service_0.14.1_release_notes|Archivematica 1.9.1 and Storage Service 0.14.1 Release Notes]]
* [[Archivematica_1.9_and_Storage_Service_0.14_release_notes|'''Archivematica 1.9 and Storage Service 0.14 Release Notes''']]
* [[Archivematica_1.8.1_release_notes|Archivematica 1.8.1 Release Notes]]
* [[Archivematica_1.8_and_Storage_Service_0.13_release_notes|'''Archivematica 1.8 and Storage Service 0.13 Release Notes''']]
* [[Archivematica 1.7.2_release_notes|Archivematica 1.7.2 Release Notes]]
* [[Storage Service 0.12 Release Notes|'''Storage Service 0.12 Release Notes''']]
* [[Archivematica 1.7.1_release_notes|Archivematica 1.7.1 Release Notes]]
* [[Storage Service 0.11.1 Release Notes]]
* [[Archivematica_1.7_and_Storage_Service_0.11_release_notes|'''Archivematica 1.7 and Storage Service 0.11 Release Notes''']]
* [[Archivematica_1.6.1_release_notes|Archivematica 1.6.1 Release Notes]]
* [[Archivematica_1.6_release_notes|'''Archivematica 1.6 Release Notes''']]
* [[Archivematica_1.5.1_Release_Notes|Archivematica 1.5.1 Release Notes]]
* [[Archivematica_1.5_Release_Notes|'''Archivematica 1.5 Release Notes''']]
* [[Archivematica_1.4.1_Release_Notes|Archivematica 1.4.1 Release Notes]]
* [[Archivematica_1.4_Release_Notes|'''Archivematica 1.4 Release Notes''']]
* [[Archivematica_1.3.2_Release_Notes|Archivematica 1.3.2 Release Notes]]
* [[Archivematica_1.3.1_Release_Notes|Archivematica 1.3.1 Release Notes]]
* [[Archivematica_1.3_Release_Notes|'''Archivematica 1.3 Release Notes''']]
* [[Archivematica_1.2_Release_Notes|'''Archivematica 1.2 Release Notes''']]
* [[Archivematica_1.1_Release_Notes|'''Archivematica 1.1 Release Notes''']]
* [[Archivematica_1.0_Release_Notes|'''Archivematica 1.0 Release Notes''']]

== Archivematica 0.x releases ==

* [[Archivematica_0.10-beta_Release_Notes|'''Archivematica 0.10 Release Notes''']]
* [[Archivematica_0.9_Release_Notes|'''Archivematica 0.9 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.8 Release Notes''']]
* [[Archivematica_0.7.1_Release_Notes|Archivematica 0.7.1 Release Notes]]
* [[Archivematica_0.7_Release_Notes|'''Archivematica 0.7 Release Notes''']]
* [[Archivematica_0.8_Release_Notes|'''Archivematica 0.6 Release Notes''']]

== Templates ==

* [[Major_release_notes|Template for major releases]]
* [[Minor_release_notes|Template for minor releases]]

Archivematica 1.14.1 and Storage Service 0.20.1 release notes

2023-07-19T16:47:27Z

Dcerna: Created page with "Home > Release Notes > Archivematica 1.14.1 and Storage Service 0.20.1 '''Release date: July 19, 2023''' == Environments == Please see the [..."

[[Main_Page|Home]] > [[Release_Notes|Release Notes]] > Archivematica 1.14.1 and Storage Service 0.20.1

'''Release date: July 19, 2023'''

== Environments ==

Please see the [https://www.archivematica.org/en/docs/archivematica-1.14/admin-manual/installation-setup/installation/installation/#installation installation instructions].

Archivematica 1.14.1 and Storage Service 0.20.1 have been tested in the following environments:

* Ubuntu 18.04 64-bit Server Edition
* CentOS 7 64-bit

Support for Ubuntu 22.04 and Rocky Linux 9 will be coming in the 1.15 release.

For development purposes, most of our developers prefer to use Docker containers. These and all above environments are linked from the installation instructions above.

== Fixed ==

Please see the 1.14.1 milestone in GitHub for all issues addressed in this release: https://github.com/archivematica/Issues/milestone/23?closed=1.