You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/operate/customize/require_community.md
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# Require community for record publication
2
2
3
+
_Introduced in v13_
4
+
3
5
Institutional policies may require all published records to belong to at least one community. InvenioRDM enforces this requirement through the `RDM_COMMUNITY_REQUIRED_TO_PUBLISH` configuration parameter.
4
6
To activate this feature, open your `invenio.cfg` and add:
Copy file name to clipboardExpand all lines: docs/releases/v12/version-v12.0.0.md
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -130,6 +130,7 @@ Here is a quick summary of the myriad other improvements in this release:
130
130
- Great improvements in bulk serialization performance
131
131
- The communities REST endpoint accepts both UUID and slug in the URL
132
132
- Many new configuration variables (e.g., `COMMUNITIES_SEARCH_SORT_BY_VERIFIED`) to tune your instance
133
+
- The new `generator` HTML `meta` tag identifies the repository technology. This is used by services like [OpenDOAR](https://opendoar.ac.uk/) to correctly catalog open access repositories.
Copy file name to clipboardExpand all lines: docs/releases/v13/upgrade-v13.0.md
+17-19Lines changed: 17 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -26,22 +26,6 @@ invenio-cli, version 1.8.0
26
26
In case you are not inside a virtual environment, make sure that you prefix each `invenio`
27
27
command with `pipenv run`.
28
28
29
-
**Local development**
30
-
31
-
Changing the Python version in your development environment highly
32
-
depends on your setup, so we won't cover it here.
33
-
One way would be to use [PyEnv](https://github.com/pyenv/pyenv).
34
-
35
-
!!! warning "Risk of losing data"
36
-
37
-
Your virtual environment folder a.k.a., `venv` folder, may contain uploaded files. If you kept the default
38
-
location, it is in `<venv folder>/var/instance/data`. If you need to keep those files,
39
-
make sure you copy them over to the new `venv` folder in the same location.
40
-
The command `invenio files location list` shows the file upload location.
41
-
42
-
If you upgraded your python version, you should recreate your virtual environment before
43
-
running `invenio-cli` or `pipenv` commands below.
44
-
45
29
### Upgrade InvenioRDM
46
30
47
31
#### Requirements
@@ -75,6 +59,13 @@ This approach will create a new virtual environment and leaves the v12 one as-is
75
59
If you are using a docker image on your production instance this will be the
76
60
option you choose.
77
61
62
+
!!! warning "Risk of losing data"
63
+
64
+
Your virtual environment folder a.k.a., `venv` folder, may contain uploaded files. If you kept the default
65
+
location, it is in `<venv folder>/var/instance/data`. If you need to keep those files,
66
+
make sure you copy them over to the new `venv` folder in the same location.
67
+
The command `invenio files location list` shows the file upload location.
68
+
78
69
##### Step 1
79
70
80
71
- create a new virtual environment
@@ -193,7 +184,7 @@ If you choose to delete and re-create your search cluster as part of the upgrade
193
184
Be sure to repeat the [Rebuild search indices](#rebuild-search-indices) step to ensure your system is fully functional.
194
185
195
186
#### Jobs
196
-
The new Jobs feature uses a custom celery task scheduler which requires a separate celery beat. See the [related documentation](../../operate/customize/jobs.md#scheduler)on how to add it or [this change](https://github.com/inveniosoftware/cookiecutter-invenio-rdm/pull/314) in the InvenioRDM boilerplate for reference.
187
+
The new Jobs feature uses a custom celery task scheduler which requires a separate celery beat. See the [related documentation](../../operate/customize/jobs.md#scheduler) or [the scheduler service](https://github.com/inveniosoftware/cookiecutter-invenio-rdm/blob/ff6c652091d56e7a8aa0a90487f91352f70c4e33/%7B%7Bcookiecutter.project_shortname%7D%7D/docker-compose.full.yml) in the InvenioRDM boilerplate for how to add it.
197
188
198
189
!!! note
199
190
Be sure to run this additional Celery beat scheduler in your production or deployed environments. Without it, scheduled and on-demand jobs will not be executed.
@@ -216,10 +207,17 @@ To resolve this, simply add a custom [`types`](https://nginx.org/en/docs/http/ng
216
207
217
208
### Optional changes
218
209
219
-
#### Deprecated configurations
210
+
#### Deprecations
211
+
212
+
*`APP_ALLOWED_HOSTS`*
213
+
220
214
With the upgrade to Flask version 3, the configuration variable `APP_ALLOWED_HOSTS` has been renamed to `TRUSTED_HOSTS`. The value remains unchanged.
221
215
You should review your `invenio.cfg`, environment variables, and deployment configuration for any occurrences of the old variable name.
222
-
It is recommended to update all references to `TRUSTED_HOSTS` to avoid deprecation warnings in the console.
216
+
It is recommended to update all references to `TRUSTED_HOSTS` to avoid deprecation warnings in the console and prepare for its eventual complete removal.
217
+
218
+
*`invenio_records_resources.services.Link`*
219
+
220
+
Usage of `invenio_records_resources.services.Link` is deprecated in favor of `invenio_records_resources.services.EndpointLink` for InvenioRDM links and `invenio_records_resources.services.ExternalLink` for external third-party links. Replace instances of `Link` in your custom code, if any, appropriately. `Link` will be removed in a future major InvenioRDM release.
223
221
224
222
#### Display versions in administration panel
225
223
As described in the [release notes](./version-v13.0.0.md#miscellaneous-additions), you can now display the versions of your installed modules directly in the Administration panel.
Copy file name to clipboardExpand all lines: docs/releases/v13/version-v13.0.0.md
+26-28Lines changed: 26 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
_2025-07-21_
4
4
5
-
We're happy to announce the release of InvenioRDM v13.0! Version 13 will be maintained until at least 6 months following the next release. Visit our maintenance policy page to learn more.
5
+
We're happy to announce the release of InvenioRDM v13.0, the open-source repository platform for research data management, institutional repositories, and digital assets management! Version 13 will be maintained until at least 6 months following the next release. Visit our [maintenance policy page](../maintenance-policy.md) to learn more.
6
6
7
7
## Try it
8
8
@@ -33,7 +33,8 @@ The new `Compare Revisions` feature allows administrators to audit record update
33
33
You can learn how to compare records' revisions [here](../../use/administration.md#compare-revisions).
34
34
35
35
### Audit logs
36
-
InvenioRDM now comes with a new audit logs feature. See the [related documentation here](../../operate/customize/audit-logs.md).
36
+
InvenioRDM now comes with a [new audit logs feature](../../operate/customize/audit-logs.md) which allows administrators to track the history of actions surrounding a record such as creation, edits and publication.
@@ -48,7 +49,7 @@ Communities can now have their own theming with a custom font and colors, which
48
49
49
50

50
51
51
-
Themed communities benefit from a custom homepage, defined by changing its HTML template.
52
+
Themed communities can have a custom homepage defined by overriding the default community homepage template.
52
53
53
54
Read more about the [themes communities feature](../../operate/customize/look-and-feel/themed_communities.md).
54
55
@@ -68,15 +69,17 @@ Collections introduce a powerful new way to organize and curate records within y
68
69
Collections provide dedicated pages showing all records matching specific criteria.
69
70
///
70
71
71
-
**Hierarchical organization**
72
+
*Hierarchical organization*
73
+
72
74
Collections allow you to define hierarchical groupings of records, enabling users to browse content by subject, resource type, funding program, or any other metadata field.
73
75
74
76

75
77
/// caption
76
78
The collection browser provides an organized view of all available collections within a community.
77
79
///
78
80
79
-
**Common use cases**
81
+
*Common use cases*
82
+
80
83
- Group content by research disciplines using a hierarchical vocabulary
81
84
- Organize historical records by publication date
82
85
- Organize records by funding programs (Horizon 2020, NSF, institutional grants)
@@ -97,7 +100,7 @@ Curation checks in Zenodo's EU Open Research Repository
97
100
98
101
Read the detailed documentation for [Curation checks](../../operate/customize/curation-checks.md).
99
102
100
-
### Customizable compliance info when publishing
103
+
### Customizable compliance information when publishing
101
104
You can now fully customize the compliance information and checkboxes that users must acknowledge when publishing a record. This makes it easy to tailor the publishing workflow to your organization's policies or legal requirements.
102
105
103
106

@@ -110,16 +113,16 @@ You can now let users to choose if they need a DOI or not when uploading. See ho
110
113

111
114
112
115
### Extra PIDs schemes
113
-
InvenioRDM v13 allows you to extend the list of existing schemes for persistent identifiers to detect, validate and add support for your owns.
116
+
InvenioRDM v13 allows you to extend the list of existing persistent identifier schemes to detect, validate and support any additional ones you want.
See the [related documentation](../../operate/customize/metadata/custom_pids_schemes.md) how to add your own custom schemes.
120
+
See the [related documentation](../../operate/customize/metadata/custom_pids_schemes.md)for how to add your own custom schemes.
118
121
119
122
Under the hood, the Invenio [idutils](https://github.com/inveniosoftware/idutils) module handles validation and normalization of persistent identifiers used in scholarly communication, and existing customizations may be affected by changes in v13. The module has been restructured to use a configurable scheme system with a new entrypoint mechanism for registering your own identifier schemes.
120
123
121
124
### FAIR Signposting
122
-
With v13, you can now enable support for FAIR Signposting level 1 and 2. See [the related documentation](../../operate/customize/FAIR-signposting.md)for more information.
125
+
With v13, you can now enable [support for FAIR Signposting level 1 and 2](../../operate/customize/FAIR-signposting.md)which increases the discoverability and citability of your repository's content.
123
126
124
127
### Files uploader & S3-compatible storage
125
128
The new file uploader, powered by Uppy (disabled by default), delivers a faster, more intuitive, and modern file upload experience. It also enables advanced features such as **multipart file transfers** with **S3-compatible** storage backends.
@@ -130,11 +133,11 @@ Learn more about [file uploaders](../../operate/customize/file-uploads/uploader.
130
133
This release introduces a new Jobs feature, providing a comprehensive way to manage asynchronous tasks via the UI or REST API. Jobs are triggered via the admin UI or REST API, run using Celery, and support logging, argument validation, and result tracking. See the related documentation [here](../../use/administration.md#jobs).
131
134
132
135
#### ORCID and ROR integrations
133
-
You can now setup jobs to automatically and recurrently fetch ORCID and ROR latest databases.
136
+
You can automatically and recurrently fetch and ingest the latest ORCID and ROR data by creating a job.
134
137
135
138
For ORCID, read more on the [names vocabulary](../../operate/customize/vocabularies/names.md#using-orcid-public-data-sync) documentation page.
136
139
137
-
With the ROR job, you can automatically load funders or affiliations vocabulary from the InvenioRDM administration panel, and schedule updates with new ROR releases. Instructions can be found on the [affiliations vocabulary](../../operate/customize/vocabularies/affiliations.md) documentation page.
140
+
With the ROR job, you can automatically load the affiliations or funders vocabulary from the InvenioRDM administration panel, and schedule updates with new ROR releases. Instructions can be found on the [affiliations](../../operate/customize/vocabularies/affiliations.md)and [funding](../../operate/customize/vocabularies/funding.md)documentation pages respectively.
138
141
We have also upgraded the integration with ROR to version 2.0 and enhanced the metadata to include organization aliases, status, types, locations, and acronyms, making it easier to find the correct organization or funders.
139
142
140
143
#### EuroSciVoc subjects
@@ -159,7 +162,7 @@ We have introduced new metadata fields that will allow you to capture more usefu
159
162
The v13 release features an upgraded PDF previewer, now powered by [PDF.js v4](https://github.com/mozilla/pdf.js). This update resolves previous issues with failed previews for certain PDF files, providing a more reliable and seamless viewing experience.
160
163
161
164
### Requests sharing
162
-
When a record is shared, the review request is now also accessible. We have introduced a new search filter in `My Dashboard`, to easily find records shared with me.
165
+
When a record is shared, the review request is now also accessible. We have introduced a new search filter in `My Dashboard`, to easily find records shared with you.
163
166
164
167

165
168
@@ -169,12 +172,12 @@ Both users and records search have been enhanced to return more accurate results
169
172
Creators, affiliations and funders autocompletion has been improved so that suggestions appear faster and better match what you type.
170
173
171
174
### Sitemaps
172
-
InvenioRDM v13 introduces the automatic generation of sitemaps to help search engines and other crawlers discovering and indexing your repository's content. Sitemaps are even automatically linked in your `robots.txt`.
175
+
InvenioRDM v13 introduces the automatic generation of sitemaps to help search engines and other crawlers discover and index your repository's content. Sitemaps are even automatically linked in your `robots.txt`.
173
176
174
-
See the [related documentation](../../operate/customize/sitemaps.md) to learn how to configure it.
177
+
See the [related documentation](../../operate/customize/sitemaps.md) to learn how to configure their generation.
175
178
176
179
### Miscellaneous additions
177
-
Here is a quick summary of the myriad other improvements in this release:
180
+
Here is a quick summary of the myriad of other improvements in this release:
178
181
179
182
- A convenient "Copy" button has been added next to the DOI (when enabled) and export formats, allowing users to instantly copy these values to their clipboard with a single click without manually selecting or exporting the content:
180
183

@@ -200,22 +203,25 @@ Here is a quick summary of the myriad other improvements in this release:
200
203
- Following the [latest COUNTER spec](https://www.countermetrics.org/code-of-practice/), the [list of robots and machines](https://github.com/inveniosoftware/counter-robots) have been updated to ensure the stats are counted on human usage.
201
204
- Logging: the Flask root logger level has been changed from `undefined` to `DEBUG`. This enables all log messages to pass through by default, instead of being blocked. If you have implemented custom logging handlers, ensure that you have defined the logging level and verify your logging verbosity in deployed environments to avoid excessive logs.
202
205
- The issue related to storage quota per record for a given user has been solved. You can now define different storage quotas per record.
203
-
- InvenioRDM v13 introduces the `generator` HTML `meta` tag to identify the repository technology. This is used by services like [OpenDOAR](https://opendoar.ac.uk/) to correctly catalog open access repositories.
204
-
The generator string will be `InvenioRDM v13.0`. You can change it in your `invenio.cfg` by overriding the variable `THEME_GENERATOR` or setting it to `None` to disable the meta tag.
205
206
- MathJax: when enabled, it will now render mathematical formulas also in the landing page citation box, search results and request's comments pages.
207
+
- Easier link generation: it's now possible to use `from invenio_base import invenio_url_for` to generate API links in the UI application and vice versa. When configuring services, `from invenio_records_resources.services import EndpointLink` now replaces `Link` which establishes a single source of truth for links.
206
208
- ...and many more bug fixes!
207
209
208
-
###Experimental
210
+
## Experimental additions
209
211
InvenioRDM v13 introduces experimental support for a modern development toolchain, including [uv](https://github.com/astral-sh/uv) (as a replacement for pipenv), [Rspack](https://www.rspack.dev/) (as a replacement for webpack), and [pnpm](https://pnpm.io/) (as a replacement for npm). These tools significantly improve the developer and system administration experience by offering faster installs, better performance, and more efficient workflows.
210
212
211
213
These tools are **disabled by default** and will be tested further in the coming months. If you are interested in trying them out and providing feedback, please get in touch with the [maintainers team](https://github.com/orgs/inveniosoftware/teams/core-maintainers).
212
214
215
+
## Deprecations
216
+
- Direct Python imports of identifier schemes (e.g., `from idutils.isbn import normalize_isbn`) are now deprecated and will be removed in future versions. If you have custom code that directly imports scheme modules, you'll need to update it to use the new API.
217
+
- Usage of `invenio_records_resources.services.Link` is deprecated in favor of `invenio_records_resources.services.EndpointLink` for InvenioRDM links and `invenio_records_resources.services.ExternalLink` for external third-party links. `Link` will be removed in a future major InvenioRDM release.
218
+
213
219
## Breaking changes
214
220
- The minimum required OpenSearch version is now **v2.12**. This change is necessary due to a bug in earlier OpenSearch versions that affects the handling of `geo-shape` fields introduced in InvenioRDM v13. See the [upgrade guide](upgrade-v13.0.md#opensearch-version) for more information.
215
221
- The new search improvements and the enhanced subjects and awards features require the recreation of the search mappings for Subjects, Awards, Records _(including percolators)_, Drafts and Communities. See the [upgrade guide](upgrade-v13.0.md#rebuild-search-indices) for more information.
216
222
- The integration with the new ROR schema v2 requires to re-import both the affiliations and funders vocabularies. See the [upgrade guide](upgrade-v13.0.md#updated-affiliations-and-funders) for more information.
217
223
- The upgrade of the PDF previewer requires a small change to the webserver configuration. See the [upgrade guide](upgrade-v13.0.md) for more information.
218
-
- Direct Python imports of identifier schemes (e.g., `from idutils.isbn import normalize_isbn`) are now deprecated and will be removed in future versions. If you have custom code that directly imports scheme modules, you'll need to update it to use the new API.
224
+
219
225
220
226
## Requirements
221
227
@@ -243,7 +249,7 @@ The development work of this impressive release wouldn't have been possible with
243
249
- Alex Ioannidis
244
250
- Alzbeta Pokorna
245
251
- Anika Churilova
246
-
- Austin
252
+
- Austin Sharp
247
253
- Brian Kelly
248
254
- Carlin MacKenzie
249
255
- Christoph Ladurner
@@ -254,16 +260,13 @@ The development work of this impressive release wouldn't have been possible with
254
260
- ducica
255
261
- Eduard Nitu
256
262
- Emil Dandanell Agerschou
257
-
- enitu
258
263
- Eric Newman
259
264
- Eric Phetteplace
260
265
- Esteban J. G. Gabancho
261
266
- Fatimah Zulfiqar
262
267
- Felipe Carlos
263
268
- Florian Gantner
264
269
- Furkan Kalkan
265
-
- furkankalkan
266
-
- Gantner, Florian Klaus
267
270
- Guillaume Viger
268
271
- Hrafn Malmquist
269
272
- Ian W. Scott
@@ -276,7 +279,6 @@ The development work of this impressive release wouldn't have been possible with
276
279
- Martin Fenner
277
280
- Martin Obersteiner
278
281
- Matt Carson
279
-
- Max
280
282
- Maximilian Moser
281
283
- mb-wali
282
284
- Michael Groh
@@ -288,15 +290,11 @@ The development work of this impressive release wouldn't have been possible with
0 commit comments