..
Copyright (C) 2020-2024 TU Wien.
Invenio-Config-TUW is free software; you can redistribute it and/or
modify it under the terms of the MIT License; see LICENSE file for more
details.
====================
Invenio-Config-TUW
====================
Invenio package for tweaking InvenioRDM to the needs of TU Wien.
The following list is a quick overview of the most relevant customizations happening in this package:
* Configuration values
* Permission policies
* OIDC authentication handling
* E-Mail notification on errors
* User profile extension
* Integration with other TU Wien services
Details
=======
Configuration values
--------------------
The primary purpose of this Invenio package is to provide some baseline configuration for InvenioRDM to suit deployment at TU Wien.
These updated configurations include (but are not limited to) setting default values for record metadata and enabling access requests for restricted records per default.
Permission policies
-------------------
InvenioRDM is not just some sort of cheap storage platform where users can upload their data and update it at any time.
Instead, it is a platform intended to host digital objects that get [DOIs](https://www.doi.org/) assigned.
Since the idea behind DOIs (and persistent identifiers in general) is to point at the same content over time, it does not allow users to change the files after publication.
This is one of the unique features that the system offers that may not be immediately obvious to users.
To make sure that users understand the implications of using the system, we require a brief communication between the users and operators.
In contrast to vanilla InvenioRDM, having an account is not enough to create uploads in our system.
Instead, the creation of records requires the ``trusted-user`` role, which typically has to be given out by administrators.
Also, communities can be quite confusing in the beginning.
Thus, we restrict the creation of new communities for non-administrators.
OIDC authentication handling
----------------------------
We do not want to handle certain aspects like password management of user management in our system.
Instead, we offload authentication to a separate service, with which InvenioRDM communicates via OIDC.
Sometimes we have slightly non-standard requirements, which are satisfied by the authentication handler logic in this package.
E-Mail notification on errors
-----------------------------
This module defines a custom log handler for error-level logs which sends out notifications as e-mail to a set of configured recipient addresses.
User profile extension
----------------------
We forgot to secure the rights to curate metadata for uploads in our system in the first version of the terms of use.
So instead, we extended the user profiles to collect consent for curation individually per user.
Integration with other TU Wien services
---------------------------------------
One of the benefits of hosting InvenioRDM as an institutional repository is that it enables some conveniences by integrating with the local environment more.
For example, we integrate with [TISS](https://tiss.tuwien.ac.at/) by periodically querying it for TU Wien employees and adding their names to the controlled vocabulary of known ``names``.
Raw data
{
"_id": null,
"home_page": null,
"name": "invenio-config-tuw",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "configuration, invenio, tu wien",
"author": null,
"author_email": "\"Team of the Center for Research Data Management (TU Wien)\" <tudata@tuwien.ac.at>",
"download_url": "https://files.pythonhosted.org/packages/50/ee/389ea39a51b62860e1f62704ca30a0a5b89eb4ca6a26f8b24c4e042001b3/invenio_config_tuw-2024.3.0.tar.gz",
"platform": null,
"description": "..\n Copyright (C) 2020-2024 TU Wien.\n\n Invenio-Config-TUW is free software; you can redistribute it and/or\n modify it under the terms of the MIT License; see LICENSE file for more\n details.\n\n====================\n Invenio-Config-TUW\n====================\n\nInvenio package for tweaking InvenioRDM to the needs of TU Wien.\n\nThe following list is a quick overview of the most relevant customizations happening in this package:\n\n* Configuration values\n* Permission policies\n* OIDC authentication handling\n* E-Mail notification on errors\n* User profile extension\n* Integration with other TU Wien services\n\n\nDetails\n=======\n\nConfiguration values\n--------------------\n\nThe primary purpose of this Invenio package is to provide some baseline configuration for InvenioRDM to suit deployment at TU Wien.\nThese updated configurations include (but are not limited to) setting default values for record metadata and enabling access requests for restricted records per default.\n\n\nPermission policies\n-------------------\n\nInvenioRDM is not just some sort of cheap storage platform where users can upload their data and update it at any time.\nInstead, it is a platform intended to host digital objects that get [DOIs](https://www.doi.org/) assigned.\nSince the idea behind DOIs (and persistent identifiers in general) is to point at the same content over time, it does not allow users to change the files after publication.\n\nThis is one of the unique features that the system offers that may not be immediately obvious to users.\nTo make sure that users understand the implications of using the system, we require a brief communication between the users and operators.\n\nIn contrast to vanilla InvenioRDM, having an account is not enough to create uploads in our system.\nInstead, the creation of records requires the ``trusted-user`` role, which typically has to be given out by administrators.\n\nAlso, communities can be quite confusing in the beginning.\nThus, we restrict the creation of new communities for non-administrators.\n\n\nOIDC authentication handling\n----------------------------\n\nWe do not want to handle certain aspects like password management of user management in our system.\nInstead, we offload authentication to a separate service, with which InvenioRDM communicates via OIDC.\nSometimes we have slightly non-standard requirements, which are satisfied by the authentication handler logic in this package.\n\n\nE-Mail notification on errors\n-----------------------------\n\nThis module defines a custom log handler for error-level logs which sends out notifications as e-mail to a set of configured recipient addresses.\n\n\nUser profile extension\n----------------------\n\nWe forgot to secure the rights to curate metadata for uploads in our system in the first version of the terms of use.\nSo instead, we extended the user profiles to collect consent for curation individually per user.\n\n\nIntegration with other TU Wien services\n---------------------------------------\n\nOne of the benefits of hosting InvenioRDM as an institutional repository is that it enables some conveniences by integrating with the local environment more.\nFor example, we integrate with [TISS](https://tiss.tuwien.ac.at/) by periodically querying it for TU Wien employees and adding their names to the controlled vocabulary of known ``names``.\n",
"bugtrack_url": null,
"license": null,
"summary": "Workflow customizations and config overrides for TU Wien.",
"version": "2024.3.0",
"project_urls": {
"Repository": "https://gitlab.tuwien.ac.at/crdm/invenio-config-tuw"
},
"split_keywords": [
"configuration",
" invenio",
" tu wien"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "098b6430901061c5aafe09c7fbc714fdc95d3998bcd552500cfee262954906d9",
"md5": "f4208dcee373568f859a809f6c7b9cfd",
"sha256": "a3825c91c9311ae35345c6a99160b752febebabbdc6507f8063b5bd7e842ab62"
},
"downloads": -1,
"filename": "invenio_config_tuw-2024.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4208dcee373568f859a809f6c7b9cfd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 35525,
"upload_time": "2024-10-01T16:58:20",
"upload_time_iso_8601": "2024-10-01T16:58:20.597197Z",
"url": "https://files.pythonhosted.org/packages/09/8b/6430901061c5aafe09c7fbc714fdc95d3998bcd552500cfee262954906d9/invenio_config_tuw-2024.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "50ee389ea39a51b62860e1f62704ca30a0a5b89eb4ca6a26f8b24c4e042001b3",
"md5": "75361483bef50c79d78dd6f49870d739",
"sha256": "2ce4b317db390830398203fa48050a743b19098f3d77ed8af4dda466330277ee"
},
"downloads": -1,
"filename": "invenio_config_tuw-2024.3.0.tar.gz",
"has_sig": false,
"md5_digest": "75361483bef50c79d78dd6f49870d739",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 28839,
"upload_time": "2024-10-01T16:58:22",
"upload_time_iso_8601": "2024-10-01T16:58:22.224709Z",
"url": "https://files.pythonhosted.org/packages/50/ee/389ea39a51b62860e1f62704ca30a0a5b89eb4ca6a26f8b24c4e042001b3/invenio_config_tuw-2024.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-01 16:58:22",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "invenio-config-tuw"
}
JSON