Configuration Variables Reference

This document lists all configuration variables used by oarepo-config and related extensions. It is automatically generated from:

  • The Flask application’s configuration (via invenio_app.factory.create_app())

  • The docstrings in oarepo_config/* modules

  • Configuration files from installed invenio_ and oarepo_ extensions

How to Use This Document

  1. Summary Table: Quickly find which configure_* functions set each variable.

  2. Detailed Reference: For each variable, see its default value, type, source, and which configure_* functions reference it.


Summary Table

Variable Name

Type

Referenced By

ACCESS_​ACTION_​CACHE_​PREFIX

str

-

ACCESS_​CACHE

NoneType

-

ACCESS_​LOAD_​SYSTEM_​ROLE_​NEEDS

bool

-

ACCOUNTS

bool

-

ACCOUNTS_​BASE_​TEMPLATE

str

-

ACCOUNTS_​CONFIRM_​EMAIL_​ENDPOINT

NoneType

-

ACCOUNTS_​COVER_​TEMPLATE

str

-

ACCOUNTS_​DEFAULT_​EMAIL_​VISIBILITY

str

-

ACCOUNTS_​DEFAULT_​USERS_​VERIFIED

bool

-

ACCOUNTS_​DEFAULT_​USER_​VISIBILITY

str

-

ACCOUNTS_​FORGOT_​PASSWORD_​EMAIL_​RATELIMIT

NoneType

-

ACCOUNTS_​FORGOT_​PASSWORD_​EMAIL_​RATELIMIT_​KEY_​PREFIX

str

-

ACCOUNTS_​FORGOT_​PASSWORD_​EMAIL_​RATELIMIT_​MSG

LazyString

-

ACCOUNTS_​JWT_​ALOGORITHM

str

-

ACCOUNTS_​JWT_​CREATION_​FACTORY

str

-

ACCOUNTS_​JWT_​DECODE_​FACTORY

str

-

ACCOUNTS_​JWT_​DOM_​TOKEN

bool

-

ACCOUNTS_​JWT_​DOM_​TOKEN_​TEMPLATE

str

-

ACCOUNTS_​JWT_​ENABLE

bool

-

ACCOUNTS_​JWT_​EXPIRATION_​DELTA

timedelta

-

ACCOUNTS_​JWT_​SECRET_​KEY

str

-

ACCOUNTS_​LOCAL_​LOGIN_​ENABLED

bool

configure_generic_parameters

ACCOUNTS_​LOGIN_​RATELIMIT

NoneType

-

ACCOUNTS_​LOGIN_​RATELIMIT_​KEY_​PREFIX

str

-

ACCOUNTS_​LOGIN_​RATELIMIT_​MSG

LazyString

-

ACCOUNTS_​LOGIN_​VIEW_​FUNCTION

unknown

configure_generic_parameters

ACCOUNTS_​REGISTER_​BLUEPRINT

NoneType

-

ACCOUNTS_​RESET_​PASSWORD_​ENDPOINT

NoneType

-

ACCOUNTS_​REST_​AUTH_​VIEWS

dict

-

ACCOUNTS_​REST_​CONFIRM_​EMAIL_​ENDPOINT

str

-

ACCOUNTS_​REST_​RESET_​PASSWORD_​ENDPOINT

str

-

ACCOUNTS_​RETENTION_​PERIOD

timedelta

-

ACCOUNTS_​SEND_​CONFIRMATION_​RATELIMIT

NoneType

-

ACCOUNTS_​SEND_​CONFIRMATION_​RATELIMIT_​KEY_​PREFIX

str

-

ACCOUNTS_​SEND_​CONFIRMATION_​RATELIMIT_​MSG

LazyString

-

ACCOUNTS_​SESSION_​ACTIVITY_​ENABLED

bool

-

ACCOUNTS_​SESSION_​REDIS_​URL

NoneType

configure_generic_parameters

ACCOUNTS_​SESSION_​STORE_​FACTORY

str

-

ACCOUNTS_​SETTINGS_​SECURITY_​TEMPLATE

str

-

ACCOUNTS_​SETTINGS_​TEMPLATE

str

-

ACCOUNTS_​SITENAME

LazyString

-

ACCOUNTS_​USERINFO_​HEADERS

bool

-

ACCOUNTS_​USERNAME_​REGEX

str

-

ACCOUNTS_​USERNAME_​RULES_​TEXT

LazyString

-

ACCOUNTS_​USER_​PREFERENCES_​SCHEMA

UserPreferencesSchema

-

ACCOUNTS_​USER_​PROFILE_​SCHEMA

UserProfileSchema

-

ACCOUNTS_​USE_​CELERY

bool

-

ADMINISTRATION_​APPNAME

str

-

ADMINISTRATION_​BASE_​TEMPLATE

str

-

ADMINISTRATION_​DASHBOARD_​VIEW

str

-

ADMINISTRATION_​DISPLAY_​VERSIONS

list

-

ADMINISTRATION_​THEME_​BASE_​TEMPLATE

str

configure_ui

ADMIN_​BASE_​TEMPLATE

str

-

ALEMBIC

dict

-

ALEMBIC_​CONTEXT

dict

-

ALLOWED_​HTML_​ATTRS

dict

-

ALLOWED_​HTML_​TAGS

list

-

APPLICATION_​ROOT

str

-

APP_​ALLOWED_​HOSTS

configured by function

configure_generic_parameters

APP_​DEFAULT_​SECURE_​HEADERS

dict

configure_generic_parameters, configure_ui

APP_​ENABLE_​SECURE_​HEADERS

bool

-

APP_​HEALTH_​BLUEPRINT_​ENABLED

bool

-

APP_​LOGS_​PERMISSION_​POLICY

unknown

configure_jobs

APP_​RDM_​ADMIN_​EMAIL_​RECIPIENT

unknown

-

APP_​RDM_​DEPOSIT_​FORM_​AUTOCOMPLETE_​NAMES

unknown

-

APP_​RDM_​DEPOSIT_​FORM_​CUSTOM_​FIELD_​DEFAULTS

unknown

-

APP_​RDM_​DEPOSIT_​FORM_​DEFAULTS

dict

-

APP_​RDM_​DEPOSIT_​FORM_​PUBLISH_​MODAL_​EXTRA

unknown

-

APP_​RDM_​DEPOSIT_​FORM_​QUOTA

unknown

configure_generic_parameters, configure_files

APP_​RDM_​DEPOSIT_​FORM_​TEMPLATE

unknown

-

APP_​RDM_​DEPOSIT_​NG_​FILES_​UI_​ENABLED

unknown

configure_ui

APP_​RDM_​DETAIL_​SIDE_​BAR_​TEMPLATES

unknown

configure_ui

APP_​RDM_​DISPLAY_​DECIMAL_​FILE_​SIZES

unknown

-

APP_​RDM_​FILES_​INTEGRITY_​REPORT_​SUBJECT

unknown

-

APP_​RDM_​FILES_​INTEGRITY_​REPORT_​TEMPLATE

unknown

-

APP_​RDM_​IDENTIFIER_​SCHEMES_​UI

unknown

configure_generic_parameters

APP_​RDM_​MODERATION_​REQUEST_​FACETS

dict

-

APP_​RDM_​MODERATION_​REQUEST_​SEARCH

dict

-

APP_​RDM_​MODERATION_​REQUEST_​SORT_​OPTIONS

dict

-

APP_​RDM_​PAGES

unknown

-

APP_​RDM_​RECORDS_​EXPORT_​URL

unknown

-

APP_​RDM_​RECORD_​EXPORTERS

unknown

-

APP_​RDM_​RECORD_​LANDING_​PAGE_​EXTERNAL_​LINKS

list

-

APP_​RDM_​RECORD_​LANDING_​PAGE_​FAIR_​SIGNPOSTING_​LEVEL_​1_​ENABLED

unknown

-

APP_​RDM_​RECORD_​LANDING_​PAGE_​TEMPLATE

str

-

APP_​RDM_​RECORD_​THUMBNAIL_​SIZES

unknown

-

APP_​RDM_​ROUTES

dict

-

APP_​RDM_​SUBCOMMUNITIES_​LABEL

unknown

-

APP_​RDM_​USER_​DASHBOARD_​ROUTES

dict

-

APP_​REQUESTID_​HEADER

str

-

APP_​THEME

NoneType

configure_ui

ASSETS_​BUILDER

configured by function

configure_ui

AUDIT_​LOGS_​DISABLED_​ACTIONS

set

-

AUDIT_​LOGS_​ENABLED

bool

-

AUDIT_​LOGS_​FACETS

dict

-

AUDIT_​LOGS_​SEARCH

dict

-

AUDIT_​LOGS_​SORT_​OPTIONS

dict

-

BABEL_​DEFAULT_​LOCALE

str

configure_generic_parameters

BABEL_​DEFAULT_​TIMEZONE

unknown

configure_generic_parameters

BANNERS_​CATEGORIES

list

-

BANNERS_​CATEGORIES_​TO_​STYLE

unknown

-

BANNERS_​SEARCH

dict

-

BANNERS_​SORT_​OPTIONS

dict

-

BASE_​TEMPLATE

str

configure_ui

BROKER_​URL

str

configure_generic_parameters

CACHE_​IS_​AUTHENTICATED_​CALLBACK

NoneType

-

CACHE_​KEY_​PREFIX

str

-

CACHE_​REDIS_​URL

str

configure_generic_parameters

CACHE_​TYPE

str

-

CELERY_​ACCEPT_​CONTENT

list

-

CELERY_​BEAT_​SCHEDULE

unknown

configure_cron

CELERY_​BROKER_​URL

str

configure_generic_parameters

CELERY_​RESULT_​BACKEND

str

configure_generic_parameters

CELERY_​RESULT_​SERIALIZER

str

-

CELERY_​TASK_​SERIALIZER

str

-

CHECKS_​COMMUNITIES_​SERVICE_​COMPONENTS

unknown

-

CHECKS_​ENABLED

bool

configure_llm

CHECKS_​GENERIC_​COMMUNITY

str

configure_llm

COLLECTIONS_​MAX_​COLLECTIONS_​PER_​TREE

int

-

COLLECTIONS_​MAX_​DEPTH

int

-

COLLECTIONS_​MAX_​TREES

int

-

COLLECTIONS_​PERMISSION_​POLICY

unknown

-

COLLECT_​STATIC_​ROOT

str

-

COLLECT_​STORAGE

str

configure_generic_parameters

COMMUNITIES_​ALLOW_​MEMBERSHIP_​REQUESTS

bool

-

COMMUNITIES_​ALLOW_​RESTRICTED

bool

-

COMMUNITIES_​ALWAYS_​SHOW_​CREATE_​LINK

bool

-

COMMUNITIES_​COLLECTIONS_​ENABLED

bool

-

COMMUNITIES_​CUSTOM_​FIELDS

list

-

COMMUNITIES_​CUSTOM_​FIELDS_​UI

list

-

COMMUNITIES_​DEFAULT_​RECORD_​SUBMISSION_​POLICY

RecordSubmissionPolicyEnum

-

COMMUNITIES_​ERROR_​HANDLERS

unknown

-

COMMUNITIES_​FACETS

dict

-

COMMUNITIES_​IDENTITIES_​CACHE_​HANDLER

str

-

COMMUNITIES_​IDENTITIES_​CACHE_​REDIS_​URL

str

configure_generic_parameters

COMMUNITIES_​IDENTITIES_​CACHE_​TIME

int

-

COMMUNITIES_​INVITATIONS_​EXPIRES_​IN

timedelta

-

COMMUNITIES_​INVITATIONS_​SEARCH

dict

-

COMMUNITIES_​INVITATIONS_​SORT_​OPTIONS

dict

-

COMMUNITIES_​LOGO_​MAX_​FILE_​SIZE

int

-

COMMUNITIES_​MEMBERSHIP_​REQUESTS_​EXPIRES_​IN

timedelta

-

COMMUNITIES_​MEMBERSHIP_​REQUESTS_​FACETS

dict

-

COMMUNITIES_​MEMBERSHIP_​REQUESTS_​SEARCH

dict

-

COMMUNITIES_​MEMBERS_​FACETS

dict

-

COMMUNITIES_​MEMBERS_​SEARCH

dict

-

COMMUNITIES_​MEMBERS_​SERVICE_​COMPONENTS

list

-

COMMUNITIES_​MEMBERS_​SORT_​OPTIONS

dict

-

COMMUNITIES_​NAMESPACES

dict

-

COMMUNITIES_​OAI_​SETS_​PREFIX

str

-

COMMUNITIES_​PERMISSION_​POLICY

configured by function

configure_communities

COMMUNITIES_​RECORDS_​SEARCH

unknown

-

COMMUNITIES_​RECORDS_​SEARCH_​ALL

bool

-

COMMUNITIES_​REGISTER_​UI_​BLUEPRINT

configured by function

configure_communities

COMMUNITIES_​REQUESTS_​SEARCH

dict

-

COMMUNITIES_​ROLES

list

configure_communities

COMMUNITIES_​ROUTES

dict

-

COMMUNITIES_​SEARCH

dict

-

COMMUNITIES_​SEARCH_​SORT_​BY_​VERIFIED

bool

-

COMMUNITIES_​SERVICE_​COMPONENTS

list

-

COMMUNITIES_​SORT_​OPTIONS

dict

-

COMMUNITIES_​SUBCOMMUNITIES_​FACETS

dict

-

COMMUNITIES_​SUBCOMMUNITIES_​SEARCH

dict

-

COMMUNITIES_​SUB_​INVITATION_​REQUEST_​CLS

unknown

-

COMMUNITIES_​SUB_​REQUEST_​CLS

unknown

-

CORS_​EXPOSE_​HEADERS

unknown

-

CORS_​RESOURCES

unknown

-

CORS_​SEND_​WILDCARD

unknown

-

COVER_​TEMPLATE

str

configure_ui

CROSSREF_​ADDITIONAL_​PREFIXES

list

-

CROSSREF_​DEPOSITOR

str

-

CROSSREF_​EMAIL

str

-

CROSSREF_​ENABLED

bool

-

CROSSREF_​FORMAT

str

-

CROSSREF_​PASSWORD

str

-

CROSSREF_​PREFIX

str

-

CROSSREF_​REGISTRANT

str

-

CROSSREF_​TEST_​MODE

bool

-

CROSSREF_​URL

str

-

CROSSREF_​USERNAME

str

-

CSRF_​ALLOWED_​CHARS

str

-

CSRF_​COOKIE_​NAME

str

-

CSRF_​COOKIE_​SAMESITE

str

-

CSRF_​FORCE_​SECURE_​REFERER

bool

-

CSRF_​HEADER

str

-

CSRF_​METHODS

list

-

CSRF_​SECRET_​SALT

str

-

CSRF_​TOKEN_​EXPIRES_​IN

int

-

CSRF_​TOKEN_​GRACE_​PERIOD

int

-

CSRF_​TOKEN_​LENGTH

int

-

DASHBOARD_​RECORD_​CREATE_​URL

configured by function

configure_generic_parameters, configure_ui

DATACITE_​ADDITIONAL_​PREFIXES

list

-

DATACITE_​DATACENTER_​SYMBOL

str

-

DATACITE_​ENABLED

bool

-

DATACITE_​FORMAT

str

-

DATACITE_​PASSWORD

str

-

DATACITE_​PREFIX

str

-

DATACITE_​TEST_​MODE

bool

configure_generic_parameters

DATACITE_​URL

str

-

DATACITE_​USERNAME

str

-

DB_​VERSIONING

bool

-

DB_​VERSIONING_​USER_​MODEL

unknown

-

DEBUG

bool

-

DEBUG_​TB_​INTERCEPT_​REDIRECTS

unknown

-

DEFAULT_​COMMUNITIES_​CUSTOM_​FIELDS

list

-

DEFAULT_​COMMUNITIES_​CUSTOM_​FIELDS_​UI

list

-

DEFAULT_​WORKFLOW_​EVENTS

dict

-

DEPLOYMENT_​VERSION

configured by function

configure_ui

DISPLAY_​NEW_​COMMUNITIES

bool

-

DISPLAY_​USER_​COMMUNITIES

bool

-

DOI_​SETTINGS_​FACETS

dict

-

DOI_​SETTINGS_​SEARCH

dict

-

DOI_​SETTINGS_​SORT_​OPTIONS

dict

-

EINFRA

configured by function

configure_einfra_oidc

EINFRA_​API_​URL

str

-

EINFRA_​CAPABILITIES_​ATTRIBUTE_​NAME

str

-

EINFRA_​COMMUNITY_​INVITATION_​SYNCHRONIZATION

bool

-

EINFRA_​COMMUNITY_​MEMBER_​SYNCHRONIZATION

bool

-

EINFRA_​COMMUNITY_​SYNCHRONIZATION

bool

-

EINFRA_​DEFAULT_​INVITATION_​LANGUAGE

str

-

EINFRA_​ENTITLEMENT_​NAMESPACES

set

-

EINFRA_​ENTITLEMENT_​PREFIX

str

-

EINFRA_​LAST_​DUMP_​PATH

str

-

EINFRA_​LOGIN_​APP

configured by function

configure_einfra_oidc

EINFRA_​RSA_​KEY

bytes

-

EINFRA_​USER_​DISPLAY_​NAME_​ATTRIBUTE

str

-

EINFRA_​USER_​ID_​DUMP_​ATTRIBUTE

str

-

EINFRA_​USER_​ID_​SEARCH_​ATTRIBUTE

str

-

EINFRA_​USER_​ORGANIZATION_​ATTRIBUTE

str

-

EINFRA_​USER_​PREFERRED_​MAIL_​ATTRIBUTE

str

-

EXPLAIN_​TEMPLATE_​LOADING

bool

-

FILES_​REST_​ALLOW_​RANGE_​REQUESTS

bool

-

FILES_​REST_​CHECKSUM_​VERIFICATION_​URI_​PREFIXES

unknown

-

FILES_​REST_​DEFAULT_​MAX_​FILE_​SIZE

NoneType

configure_files

FILES_​REST_​DEFAULT_​QUOTA_​SIZE

NoneType

configure_generic_parameters, configure_files

FILES_​REST_​DEFAULT_​STORAGE_​CLASS

str

configure_generic_parameters

FILES_​REST_​FILE_​TAGS_​HEADER

str

-

FILES_​REST_​FILE_​URI_​MAX_​LEN

int

-

FILES_​REST_​MIN_​FILE_​SIZE

int

-

FILES_​REST_​MULTIPART_​CHUNKSIZE_​MAX

int

-

FILES_​REST_​MULTIPART_​CHUNKSIZE_​MIN

int

-

FILES_​REST_​MULTIPART_​EXPIRES

timedelta

-

FILES_​REST_​MULTIPART_​MAX_​PARTS

int

-

FILES_​REST_​MULTIPART_​PART_​FACTORIES

list

-

FILES_​REST_​OBJECT_​KEY_​MAX_​LEN

int

-

FILES_​REST_​PERMISSION_​FACTORY

str

-

FILES_​REST_​SIZE_​LIMITERS

str

-

FILES_​REST_​STORAGE_​CLASS_​LIST

dict

configure_generic_parameters

FILES_​REST_​STORAGE_​FACTORY

str

configure_generic_parameters

FILES_​REST_​STORAGE_​PATH_​DIMENSIONS

int

-

FILES_​REST_​STORAGE_​PATH_​SPLIT_​LENGTH

int

-

FILES_​REST_​TASK_​WAIT_​INTERVAL

int

-

FILES_​REST_​TASK_​WAIT_​MAX_​SECONDS

int

-

FILES_​REST_​UPLOAD_​FACTORIES

list

-

FILES_​REST_​XSENDFILE_​ENABLED

bool

-

FILES_​REST_​XSENDFILE_​RESPONSE_​FUNC

unknown

-

FORMATTER_​BADGES_​ALLOWED_​TITLES

list

-

FORMATTER_​BADGES_​ENABLE

bool

-

FORMATTER_​BADGES_​MAX_​CACHE_​AGE

int

-

FORMATTER_​BADGES_​TITLE_​MAPPING

dict

-

HANDLE_​URL

str

-

HEADER_​TEMPLATE

unknown

configure_ui

I18N_​DEFAULT_​REDIRECT_​ENDPOINT

NoneType

-

I18N_​JS_​DISTR_​EXCEPTIONAL_​PACKAGE_​MAP

dict

-

I18N_​LANGUAGES

list

configure_generic_parameters

I18N_​SESSION_​KEY

str

-

I18N_​SET_​LANGUAGE_​URL

str

-

I18N_​TRANSIFEX_​JS_​RESOURCES_​MAP

dict

-

I18N_​TRANSLATIONS_​PATHS

list

-

I18N_​USER_​LANG_​ATTR

str

-

IIIF_​API_​DECORATOR_​HANDLER

unknown

-

IIIF_​API_​INFO_​RESPONSE_​SKELETON

dict

-

IIIF_​CACHE_​HANDLER

str

-

IIIF_​CACHE_​IGNORE_​ERRORS

bool

-

IIIF_​CACHE_​REDIS_​URL

str

-

IIIF_​CACHE_​TIME

int

-

IIIF_​CONVERTERS

tuple

-

IIIF_​FORMATS

dict

-

IIIF_​FORMATS_​PIL_​MAP

dict

-

IIIF_​GIF_​TEMP_​FOLDER_​PATH

str

-

IIIF_​MODE

dict

-

IIIF_​PREVIEW_​TEMPLATE

str

-

IIIF_​QUALITIES

tuple

-

IIIF_​SIMPLE_​PREVIEWER_​NATIVE_​EXTENSIONS

list

-

IIIF_​SIMPLE_​PREVIEWER_​SIZE

str

-

IIIF_​TILES_​CONVERTER_​PARAMS

dict

-

IIIF_​TILES_​GENERATION_​ENABLED

bool

-

IIIF_​TILES_​STORAGE_​BASE_​PATH

str

-

IIIF_​TILES_​VALID_​EXTENSIONS

list

-

IIIF_​VALIDATIONS

dict

-

INDEXER_​BEFORE_​INDEX_​HOOKS

list

-

INDEXER_​BULK_​REQUEST_​TIMEOUT

int

-

INDEXER_​DEFAULT_​INDEX

NoneType

-

INDEXER_​MAX_​BULK_​CONSUMERS

int

-

INDEXER_​MQ_​EXCHANGE

unknown

-

INDEXER_​MQ_​PUBLISH_​KWARGS

dict

-

INDEXER_​MQ_​QUEUE

unknown

-

INDEXER_​MQ_​ROUTING_​KEY

str

-

INDEXER_​RECORD_​TO_​INDEX

str

-

INDEXER_​REPLACE_​REFS

bool

-

INFO_​ENDPOINT_​COMPONENTS

list

-

INSTANCE_​THEME_​FILE

configured by function

configure_ui

INVENIO_​CACHE_​TYPE

configured by function

configure_generic_parameters

INVENIO_​RDM_​ENABLED

bool

-

INVENIO_​VOCABULARY_​TYPE_​METADATA

dict

configure_vocabulary

JAVASCRIPT_​PACKAGES_​MANAGER

configured by function

configure_ui

JOBS_​DEFAULT_​QUEUE

NoneType

-

JOBS_​FACETS

dict

-

JOBS_​LOGGING

bool

-

JOBS_​LOGGING_​INDEX

str

-

JOBS_​LOGGING_​LEVEL

str

configure_jobs

JOBS_​LOGGING_​RETENTION_​DAYS

int

-

JOBS_​LOGS_​BATCH_​SIZE

int

-

JOBS_​LOGS_​MAX_​RESULTS

int

-

JOBS_​PERMISSION_​POLICY

unknown

-

JOBS_​QUEUES

dict

-

JOBS_​RUNS_​PERMISSION_​POLICY

unknown

-

JOBS_​SEARCH

dict

-

JOBS_​SORT_​OPTIONS

dict

-

JOBS_​TASKS_​PERMISSION_​POLICY

unknown

-

JSONSCHEMAS_​ENDPOINT

str

-

JSONSCHEMAS_​HOST

str

configure_generic_parameters

JSONSCHEMAS_​LOADER_​CLS

NoneType

-

JSONSCHEMAS_​LOCAL_​REFRESOLVER_​URI_​SCHEME

str

-

JSONSCHEMAS_​REGISTER_​ENDPOINTS_​API

bool

-

JSONSCHEMAS_​REGISTER_​ENDPOINTS_​UI

bool

-

JSONSCHEMAS_​REPLACE_​REFS

bool

-

JSONSCHEMAS_​RESOLVER_​CLS

str

-

JSONSCHEMAS_​RESOLVE_​SCHEMA

bool

-

JSONSCHEMAS_​SCHEMAS

NoneType

-

JSONSCHEMAS_​URL_​SCHEME

str

-

LOGGING_​CONSOLE

bool

-

LOGGING_​CONSOLE_​LEVEL

NoneType

-

LOGGING_​CONSOLE_​PYWARNINGS

bool

-

LOGGING_​FS_​BACKUPCOUNT

int

-

LOGGING_​FS_​LEVEL

str

-

LOGGING_​FS_​LOGFILE

NoneType

-

LOGGING_​FS_​MAXBYTES

int

-

LOGGING_​FS_​PYWARNINGS

bool

-

LOGGING_​SENTRY_​CELERY

bool

-

LOGGING_​SENTRY_​CLASS

NoneType

-

LOGGING_​SENTRY_​INIT_​KWARGS

NoneType

-

LOGGING_​SENTRY_​LEVEL

str

-

LOGGING_​SENTRY_​PYWARNINGS

bool

-

LOGGING_​SENTRY_​REDIS

bool

-

LOGGING_​SENTRY_​SQLALCHEMY

bool

-

MAIL_​DEBUG

bool

-

MAIL_​DEFAULT_​REPLY_​TO

NoneType

-

MAIL_​DEFAULT_​SENDER

unknown

configure_generic_parameters

MAIL_​MAX_​ATTACHMENT_​SIZE

int

-

MAIL_​MAX_​RETRIES

int

-

MAIL_​MIN_​LOGGING_​LEVEL

int

-

MAIL_​SUPPRESS_​SEND

bool

configure_generic_parameters

MATOMO_​ANALYTICS_​SITE_​ID

configured by function

configure_ui

MATOMO_​ANALYTICS_​TEMPLATE

configured by function

configure_ui

MATOMO_​ANALYTICS_​URL

configured by function

configure_ui

MAX_​CONTENT_​LENGTH

NoneType

-

MAX_​COOKIE_​SIZE

int

-

MAX_​FORM_​MEMORY_​SIZE

int

-

MAX_​FORM_​PARTS

int

-

MULTIPROFILER_​BASE_​TEMPLATE

unknown

-

MULTIPROFILER_​IGNORED_​ENDPOINTS

unknown

-

MULTIPROFILER_​PERMISSION

unknown

-

NOTIFICATIONS_​BACKENDS

dict

-

NOTIFICATIONS_​BUILDERS

dict

-

NOTIFICATIONS_​ENTITY_​RESOLVERS

set

-

NOTIFICATIONS_​GROUP_​EMAIL_​DOMAIN

NoneType

-

NOTIFICATIONS_​SETTINGS_​VIEW_​FUNCTION

NoneType

-

NOTIFICATION_​RECIPIENTS_​RESOLVERS

dict

-

OAISERVER_​ADMIN_​EMAILS

list

-

OAISERVER_​BASE_​TEMPLATE

str

-

OAISERVER_​CACHE_​KEY

str

-

OAISERVER_​CELERY_​TASK_​CHUNK_​SIZE

int

-

OAISERVER_​COMPRESSIONS

list

-

OAISERVER_​CONTROL_​NUMBER_​FETCHER

str

-

OAISERVER_​CREATED_​KEY

str

-

OAISERVER_​DELETE_​PERCOLATOR_​FUNCTION

str

-

OAISERVER_​DESCRIPTIONS

list

-

OAISERVER_​GETRECORD_​FETCHER

str

-

OAISERVER_​GRANULARITY

str

-

OAISERVER_​ID_​FETCHER

str

-

OAISERVER_​ID_​PREFIX

str

configure_generic_parameters

OAISERVER_​LAST_​UPDATE_​KEY

str

-

OAISERVER_​METADATA_​FORMATS

OAIServerMetadataFormats

-

OAISERVER_​NEW_​PERCOLATOR_​FUNCTION

str

-

OAISERVER_​PAGE_​SIZE

int

-

OAISERVER_​PERCOLATOR_​DEDICATED_​INDEX

bool

-

OAISERVER_​PROTOCOL_​VERSION

str

-

OAISERVER_​QUERY_​PARSER

unknown

-

OAISERVER_​QUERY_​PARSER_​FIELDS

list

-

OAISERVER_​RECORD_​CLS

str

-

OAISERVER_​RECORD_​INDEX

str

-

OAISERVER_​RECORD_​LIST_​SETS_​FETCHER

str

-

OAISERVER_​RECORD_​SETS_​FETCHER

str

-

OAISERVER_​REGISTER_​RECORD_​SIGNALS

bool

-

OAISERVER_​REGISTER_​SET_​SIGNALS

bool

-

OAISERVER_​REPOSITORY_​NAME

str

configure_oai

OAISERVER_​RESUMPTION_​TOKEN_​EXPIRE_​TIME

int

-

OAISERVER_​SEARCH_​CLS

str

-

OAISERVER_​SET_​RECORDS_​QUERY_​FETCHER

str

-

OAISERVER_​XSL_​URL

NoneType

-

OAREPO_​CHECKS_​DEFAULT_​CHAT_​EINFRA_​CLIENT

configured by function

configure_llm

OAREPO_​CHECKS_​DEFAULT_​LLM_​CLIENT

configured by function

configure_llm

OAREPO_​CHECKS_​LLM_​CLIENTS

configured by function

configure_llm

OAREPO_​COMMUNITIES_​DEFAULT_​WORKFLOW

str

-

OAREPO_​MODELS

dict

-

OAREPO_​PERMISSIONS_​PRESETS

dict

-

OAREPO_​REQUESTS_​DEFAULT_​RECEIVER

str

-

OAREPO_​UI_​JINJAX_​FILTERS

dict

-

OAREPO_​UI_​JINJAX_​GLOBALS

dict

-

OAREPO_​UI_​LESS_​COMPONENTS

list

-

OAREPO_​UI_​MULTILINGUAL_​FIELD_​LANGUAGES

list

-

OAREPO_​UI_​OVERRIDES

set

-

OAREPO_​UI_​RECORD_​ACTIONS

set

-

OAREPO_​UI_​RESULT_​LIST_​ITEM_​REGISTRATION_​CALLBACKS

list

-

OAREPO_​VOCABULARIES_​PERMISSIONS_​PRESETS

dict

-

OAREPO_​VOCABULARIES_​SORT_​CF

list

-

OAREPO_​VOCABULARIES_​SUGGEST_​CF

list

-

OAREPO_​VOCABULARIES_​UI_​RESOURCE

str

-

OAREPO_​VOCABULARIES_​UI_​RESOURCE_​CONFIG

str

-

OAREPO_​VOCABULARY_​TYPE_​RESOURCE

unknown

-

OAREPO_​VOCABULARY_​TYPE_​RESOURCE_​CONFIG

unknown

-

OAREPO_​VOCABULARY_​TYPE_​SERVICE

unknown

-

OAREPO_​VOCABULARY_​TYPE_​SERVICE_​CONFIG

unknown

-

OAUTH2SERVER_​ALLOWED_​GRANT_​TYPES

set

-

OAUTH2SERVER_​ALLOWED_​RESPONSE_​TYPES

set

-

OAUTH2SERVER_​ALLOWED_​URLENCODE_​CHARACTERS

str

-

OAUTH2SERVER_​BASE_​TEMPLATE

str

-

OAUTH2SERVER_​CLIENT_​ID_​SALT_​LEN

int

-

OAUTH2SERVER_​CLIENT_​SECRET_​SALT_​LEN

int

-

OAUTH2SERVER_​COVER_​TEMPLATE

str

-

OAUTH2SERVER_​JWT_​AUTH_​HEADER

str

-

OAUTH2SERVER_​JWT_​AUTH_​HEADER_​TYPE

str

-

OAUTH2SERVER_​JWT_​VERIFICATION_​FACTORY

str

-

OAUTH2SERVER_​SETTINGS_​TEMPLATE

str

-

OAUTH2SERVER_​TOKEN_​PERSONAL_​SALT_​LEN

int

-

OAUTH2_​CACHE_​TYPE

str

-

OAUTH2_​PROVIDER_​ERROR_​ENDPOINT

str

-

OAUTHCLIENT_​AUTO_​REDIRECT_​TO_​EXTERNAL_​LOGIN

bool

configure_generic_parameters

OAUTHCLIENT_​BASE_​TEMPLATE

str

-

OAUTHCLIENT_​COVER_​TEMPLATE

str

-

OAUTHCLIENT_​LOGIN_​USER_​TEMPLATE_​PARENT

str

-

OAUTHCLIENT_​REMOTE_​APPS

dict

configure_generic_parameters, configure_einfra_oidc

OAUTHCLIENT_​REST_​DEFAULT_​ERROR_​REDIRECT_​URL

str

-

OAUTHCLIENT_​REST_​DEFAULT_​RESPONSE_​HANDLER

NoneType

-

OAUTHCLIENT_​REST_​REMOTE_​APPS

dict

-

OAUTHCLIENT_​SESSION_​KEY_​PREFIX

str

-

OAUTHCLIENT_​SETTINGS_​TEMPLATE

str

-

OAUTHCLIENT_​SIGNUP_​FORM

unknown

-

OAUTHCLIENT_​SIGNUP_​TEMPLATE

str

-

OAUTHCLIENT_​SITENAME

LazyString

-

OAUTHCLIENT_​STATE_​ENABLED

bool

-

OAUTHCLIENT_​STATE_​EXPIRES

int

-

OAUTHCLIENT_​TOKEN_​EXPIRES_​LEEWAY

int

-

ORCID_​PUBLIC_​DUMP_​S3_​BUCKET_​NAME

str

-

PAGES_​ALLOWED_​EXTRA_​HTML_​ATTRS

dict

-

PAGES_​ALLOWED_​EXTRA_​HTML_​TAGS

list

-

PAGES_​BASE_​TEMPLATE

str

-

PAGES_​DEFAULT_​TEMPLATE

str

-

PAGES_​FACETS

dict

-

PAGES_​SEARCH

dict

-

PAGES_​SORT_​OPTIONS

dict

-

PAGES_​TEMPLATES

list

-

PAGES_​WHITELIST_​CONFIG_​KEYS

list

-

PERMANENT_​SESSION_​LIFETIME

timedelta

-

PIDSTORE_​APP_​LOGGER_​HANDLERS

bool

-

PIDSTORE_​DATACITE_​DOI_​PREFIX

str

-

PIDSTORE_​OBJECT_​ENDPOINTS

dict

-

PIDSTORE_​RECID_​FIELD

str

-

PIDSTORE_​RECORDID_​OPTIONS

dict

-

PREFERRED_​URL_​SCHEME

str

-

PREVIEWABLE_​ZIP_​PREVIEWER_​NATIVE_​EXTENSIONS

list

-

PREVIEWER_​ABSTRACT_​TEMPLATE

str

-

PREVIEWER_​BASE_​CSS_​BUNDLES

list

-

PREVIEWER_​BASE_​JS_​BUNDLES

list

-

PREVIEWER_​BASE_​TEMPLATE

str

-

PREVIEWER_​CHARDET_​BYTES

int

-

PREVIEWER_​CHARDET_​CONFIDENCE

float

-

PREVIEWER_​CONTAINER_​ITEM_​PREFERENCE

list

-

PREVIEWER_​CSV_​MAX_​BYTES

int

-

PREVIEWER_​CSV_​SNIFFER_​ALLOWED_​DELIMITERS

NoneType

-

PREVIEWER_​CSV_​VALIDATION_​BYTES

int

-

PREVIEWER_​MAX_​FILE_​SIZE_​BYTES

int

-

PREVIEWER_​MAX_​IMAGE_​SIZE_​BYTES

float

-

PREVIEWER_​PDF_​JS_​DOCUMENT_​INIT_​PARAMS

NoneType

-

PREVIEWER_​PDF_​JS_​ENABLE_​SCRIPTING

bool

-

PREVIEWER_​PREFERENCE

list

-

PREVIEWER_​RECORD_​FILE_​FACOTRY

NoneType

-

PREVIEWER_​TXT_​MAX_​BYTES

int

-

PREVIEWER_​WEB_​ARCHIVE_​RANGE_​REQUESTS

bool

-

PREVIEWER_​ZIP_​MAX_​FILES

int

-

PROPAGATE_​EXCEPTIONS

NoneType

-

PROVIDE_​AUTOMATIC_​OPTIONS

bool

-

PUBLISH_​REQUEST_​TYPES

list

-

QUEUES_​BROKER_​URL

NoneType

-

QUEUES_​CONNECTION_​POOL

unknown

-

QUEUES_​DEFINITIONS

list

-

RATELIMIT_​APPLICATION

unknown

-

RATELIMIT_​AUTHENTICATED_​USER

str

configure_generic_parameters

RATELIMIT_​ENABLED

bool

-

RATELIMIT_​GUEST_​USER

str

configure_generic_parameters

RATELIMIT_​HEADERS_​ENABLED

bool

-

RATELIMIT_​KEY_​FUNC

NoneType

-

RATELIMIT_​PER_​ENDPOINT

dict

-

RATELIMIT_​STORAGE_​URI

str

-

RATELIMIT_​STRATEGY

str

-

RDM_​ALLOW_​EXTERNAL_​DOI_​VERSIONING

bool

-

RDM_​ALLOW_​METADATA_​ONLY_​RECORDS

bool

configure_files

RDM_​ALLOW_​OWNERS_​REMOVE_​COMMUNITY_​FROM_​RECORD

bool

-

RDM_​ALLOW_​RESTRICTED_​RECORDS

bool

-

RDM_​ARCHIVE_​DOWNLOAD_​ENABLED

bool

-

RDM_​CITATION_​STYLES

list

-

RDM_​CITATION_​STYLES_​DEFAULT

str

-

RDM_​COMMUNITIES_​ROUTES

dict

-

RDM_​COMMUNITY_​CONTENT_​MODERATION_​HANDLERS

list

-

RDM_​COMMUNITY_​INCLUSION_​REQUEST_​CLS

unknown

-

RDM_​COMMUNITY_​REQUIRED_​TO_​PUBLISH

bool

-

RDM_​COMMUNITY_​SUBMISSION_​REQUEST_​CLS

unknown

-

RDM_​CONTENT_​MODERATION_​HANDLERS

list

-

RDM_​CUSTOM_​FIELDS

list

-

RDM_​CUSTOM_​FIELDS_​UI

list

-

RDM_​DATACITE_​DUMP_​OPENAIRE_​ACCESS_​RIGHTS

bool

-

RDM_​DATACITE_​FUNDER_​IDENTIFIERS_​PRIORITY

tuple

-

RDM_​DEFAULT_​FILES_​ENABLED

bool

-

RDM_​DETAIL_​SIDE_​BAR_​MANAGE_​ATTRIBUTES_​EXTENSION_​TEMPLATE

unknown

-

RDM_​FACETS

unknown

-

RDM_​FILES_​DEFAULT_​MAX_​ADDITIONAL_​QUOTA_​SIZE

int

-

RDM_​FILES_​DEFAULT_​MAX_​FILE_​SIZE

int

configure_files

RDM_​FILES_​DEFAULT_​QUOTA_​SIZE

int

configure_files

RDM_​FILE_​MODIFICATION_​PERIOD

timedelta

-

RDM_​FILE_​MODIFICATION_​POLICY

unknown

-

RDM_​IIIF_​MANIFEST_​FORMATS

list

-

RDM_​IMMEDIATE_​FILE_​MODIFICATION_​ENABLED

bool

-

RDM_​IMMEDIATE_​FILE_​MODIFICATION_​POLICIES

list

-

RDM_​IMMEDIATE_​QUOTA_​INCREASE_​ENABLED

bool

-

RDM_​IMMEDIATE_​QUOTA_​INCREASE_​POLICIES

list

-

RDM_​IMMEDIATE_​RECORD_​DELETION_​CHECKLIST

list

-

RDM_​IMMEDIATE_​RECORD_​DELETION_​ENABLED

bool

-

RDM_​IMMEDIATE_​RECORD_​DELETION_​POLICIES

list

-

RDM_​LOCK_​EDIT_​PUBLISHED_​FILES

unknown

-

RDM_​MEDIA_​FILES_​DEFAULT_​MAX_​FILE_​SIZE

int

-

RDM_​MEDIA_​FILES_​DEFAULT_​QUOTA_​SIZE

int

-

RDM_​NAMESPACES

dict

-

RDM_​NEW_​RECORD_​VERSION_​REVIEW_​POLICY

unknown

-

RDM_​NOTIFICATIONS_​BUILDERS

dict

-

RDM_​OAI_​PMH_​FACETS

dict

-

RDM_​OAI_​PMH_​SEARCH

dict

-

RDM_​OAI_​PMH_​SORT_​OPTIONS

dict

-

RDM_​OPTIONAL_​DOI_​VALIDATOR

unknown

-

RDM_​PARENT_​PERSISTENT_​IDENTIFIERS

dict

-

RDM_​PARENT_​PERSISTENT_​IDENTIFIER_​PROVIDERS

list

-

RDM_​PERMISSION_​POLICY

unknown

-

RDM_​PERSISTENT_​IDENTIFIERS

dict

-

RDM_​PERSISTENT_​IDENTIFIER_​PROVIDERS

list

-

RDM_​QUOTA_​INCREASE_​POLICY

unknown

-

RDM_​RECORDS_​ACCESS_​SERVICE_​CLASS

str

-

RDM_​RECORDS_​ALLOW_​RESTRICTION_​AFTER_​GRACE_​PERIOD

bool

-

RDM_​RECORDS_​COMMUNITY_​RECORDS_​CONFIG_​CLASS

str

-

RDM_​RECORDS_​COMMUNITY_​RECORDS_​SERVICE_​CLASS

str

-

RDM_​RECORDS_​CONTAINER_​EXTENSIONS

list

-

RDM_​RECORDS_​ERROR_​HANDLERS

dict

add_model

RDM_​RECORDS_​IDENTIFIERS_​SCHEMES

dict

-

RDM_​RECORDS_​LOCATION_​SCHEMES

dict

-

RDM_​RECORDS_​MAX_​FILES_​COUNT

int

configure_files

RDM_​RECORDS_​MAX_​MEDIA_​FILES_​COUNT

int

-

RDM_​RECORDS_​PERSONORG_​SCHEMES

dict

-

RDM_​RECORDS_​PIDS_​SERVICE_​CLASS

str

-

RDM_​RECORDS_​RELATED_​IDENTIFIERS_​SCHEMES

dict

-

RDM_​RECORDS_​REQUIRE_​SECRET_​LINKS_​EXPIRATION

bool

-

RDM_​RECORDS_​RESOURCE_​CLASS

str

-

RDM_​RECORDS_​RESOURCE_​CONFIG_​CLASS

str

-

RDM_​RECORDS_​RESTRICTION_​GRACE_​PERIOD

timedelta

-

RDM_​RECORDS_​REVIEWS

list

-

RDM_​RECORDS_​REVIEW_​SERVICE_​CLASS

str

-

RDM_​RECORDS_​SERVICE_​CLASS

str

-

RDM_​RECORDS_​SERVICE_​COMPONENTS

list

-

RDM_​RECORDS_​SERVICE_​CONFIG_​CLASS

str

-

RDM_​RECORDS_​UI_​EDIT_​URL

str

-

RDM_​RECORDS_​USER_​FIXTURE_​PASSWORDS

dict

-

RDM_​RECORD_​DELETION_​POLICY

unknown

-

RDM_​RECORD_​FILE_​EXTRACTORS

list

-

RDM_​REQUESTS_​ROUTES

dict

-

RDM_​REQUEST_​RECORD_​DELETION_​CHECKLIST

list

-

RDM_​REQUEST_​RECORD_​DELETION_​ENABLED

bool

-

RDM_​REQUEST_​RECORD_​DELETION_​POLICIES

list

-

RDM_​RESOURCE_​ACCESS_​TOKENS_​ENABLED

bool

-

RDM_​RESOURCE_​ACCESS_​TOKENS_​JWT_​LIFETIME

timedelta

-

RDM_​RESOURCE_​ACCESS_​TOKENS_​SUBJECT_​SCHEMA

unknown

-

RDM_​RESOURCE_​ACCESS_​TOKENS_​WHITELISTED_​JWT_​ALGORITHMS

list

-

RDM_​RESOURCE_​ACCESS_​TOKEN_​REQUEST_​ARG

str

-

RDM_​SEARCH

unknown

-

RDM_​SEARCH_​DRAFTS

unknown

-

RDM_​SEARCH_​SORT_​BY_​VERIFIED

bool

-

RDM_​SEARCH_​USER_​COMMUNITIES

dict

-

RDM_​SEARCH_​USER_​REQUESTS

dict

-

RDM_​SEARCH_​VERSIONING

dict

-

RDM_​SORT_​OPTIONS

dict

-

RDM_​STATS_​EXCLUDE_​PREVIEW_​FILE_​DOWNLOAD_​EVENTS

bool

-

RDM_​USER_​MODERATION_​ENABLED

bool

-

RECAPTCHA_​PRIVATE_​KEY

unknown

-

RECAPTCHA_​PUBLIC_​KEY

unknown

-

RECORDS_​FILES_​REST_​ENDPOINTS

dict

-

RECORDS_​PERMISSIONS_​RECORD_​POLICY

str

-

RECORDS_​REFRESOLVER_​CLS

NoneType

configure_generic_parameters

RECORDS_​REFRESOLVER_​STORE

NoneType

configure_generic_parameters

RECORDS_​RESOURCES_​ALLOW_​EMPTY_​FILES

bool

-

RECORDS_​RESOURCES_​ARCHIVE_​DOWNLOAD_​MAX_​SIZE

NoneType

-

RECORDS_​RESOURCES_​DEFAULT_​TRANSFER_​TYPE

str

-

RECORDS_​RESOURCES_​EXTRACTED_​STREAM_​CHUNK_​SIZE

int

-

RECORDS_​RESOURCES_​FILES_​ALLOWED_​DOMAINS

list

-

RECORDS_​RESOURCES_​IMAGE_​FORMATS

list

-

RECORDS_​RESOURCES_​TRANSFERS

list

-

RECORDS_​RESOURCES_​ZIP_​FORMATS

list

-

RECORDS_​RESOURCES_​ZIP_​MAX_​ENTRIES

int

-

RECORDS_​RESOURCES_​ZIP_​MAX_​HEADER_​SIZE

int

-

RECORDS_​RESOURCES_​ZIP_​MAX_​LISTING_​ENTRIES

int

-

RECORDS_​RESOURCES_​ZIP_​MAX_​RATIO

float

-

RECORDS_​RESOURCES_​ZIP_​MAX_​TOTAL_​UNCOMPRESSED

int

-

RECORDS_​REST_​DEFAULT_​CREATE_​PERMISSION_​FACTORY

unknown

-

RECORDS_​REST_​DEFAULT_​DELETE_​PERMISSION_​FACTORY

unknown

-

RECORDS_​REST_​DEFAULT_​LIST_​PERMISSION_​FACTORY

unknown

-

RECORDS_​REST_​DEFAULT_​LOADERS

unknown

-

RECORDS_​REST_​DEFAULT_​READ_​PERMISSION_​FACTORY

unknown

-

RECORDS_​REST_​DEFAULT_​RESULTS_​SIZE

unknown

-

RECORDS_​REST_​DEFAULT_​SORT

unknown

-

RECORDS_​REST_​DEFAULT_​UPDATE_​PERMISSION_​FACTORY

unknown

-

RECORDS_​REST_​ENDPOINTS

list

configure_generic_parameters

RECORDS_​REST_​FACETS

unknown

-

RECORDS_​REST_​FACETS_​POST_​FILTERS_​PROPAGATE

unknown

-

RECORDS_​REST_​SEARCH_​ERROR_​HANDLERS

unknown

-

RECORDS_​REST_​SORT_​OPTIONS

unknown

-

RECORDS_​UI_​BASE_​TEMPLATE

str

-

RECORDS_​UI_​DEFAULT_​PERMISSION_​FACTORY

NoneType

-

RECORDS_​UI_​ENDPOINTS

dict

configure_ui

RECORDS_​UI_​EXPORT_​FORMATS

dict

-

RECORDS_​UI_​LOGIN_​ENDPOINT

str

-

RECORDS_​UI_​TOMBSTONE_​TEMPLATE

str

-

RECORDS_​VALIDATION_​TYPES

dict

-

RECORD_​ROUTES

configured by function

configure_generic_parameters

RELATED_​RESOURCES_​DEFAULT_​RESOURCE_​TYPE

str

-

RELATED_​RESOURCES_​DEFAULT_​TIMEOUT

int

-

RELATED_​RESOURCES_​RECORD_​UI_​SCHEMA

str

-

RELATED_​RESOURCES_​RESOURCE_​CLASS

str

-

RELATED_​RESOURCES_​RESOURCE_​CONFIG_​CLASS

str

-

RELATED_​RESOURCES_​SERVICE_​CLASS

str

-

RELATED_​RESOURCES_​SERVICE_​CONFIG_​CLASS

str

-

REMEMBER_​COOKIE_​DURATION

unknown

-

REPOSITORY_​DESCRIPTION

configured by function

configure_ui

REPOSITORY_​KEYWORDS

configured by function

configure_ui

REPOSITORY_​NAME

configured by function

configure_ui

REPOSITORY_​SUBTITLE

configured by function

configure_ui

REPOSITORY_​SUPPORT_​CONTACT

configured by function

configure_ui

REQUESTS_​ACTION_​COMPONENTS

list

-

REQUESTS_​ALLOWED_​RECEIVERS

list

-

REQUESTS_​COMMENTS_​ALLOWED_​EXTRA_​HTML_​ATTRS

dict

-

REQUESTS_​COMMENTS_​ALLOWED_​EXTRA_​HTML_​TAGS

list

-

REQUESTS_​COMMENT_​PREVIEW_​LIMIT

int

-

REQUESTS_​ENTITY_​RESOLVERS

list

-

REQUESTS_​ERROR_​HANDLERS

unknown

-

REQUESTS_​EVENTS_​SERVICE_​COMPONENTS

list

-

REQUESTS_​FACETS

dict

-

REQUESTS_​FILES_​DEFAULT_​MAX_​FILE_​SIZE

int

-

REQUESTS_​FILES_​DEFAULT_​QUOTA_​SIZE

int

-

REQUESTS_​LOCKING_​ENABLED

bool

-

REQUESTS_​MODERATION_​ROLE

str

-

REQUESTS_​PERMISSION_​POLICY

unknown

-

REQUESTS_​REGISTERED_​EVENT_​TYPES

list

-

REQUESTS_​REGISTERED_​TYPES

list

-

REQUESTS_​RESOURCE_​CLASS

unknown

-

REQUESTS_​RESOURCE_​CONFIG_​CLASS

unknown

-

REQUESTS_​REVIEWERS_​ENABLED

bool

-

REQUESTS_​REVIEWERS_​MAX_​NUMBER

int

-

REQUESTS_​ROUTES

dict

-

REQUESTS_​SEARCH

dict

-

REQUESTS_​SERVICE_​CLASS

unknown

-

REQUESTS_​SERVICE_​CONFIG_​CLASS

unknown

-

REQUESTS_​SORT_​OPTIONS

dict

-

REQUESTS_​TIMELINE_​PAGE_​SIZE

int

-

REQUESTS_​USER_​MODERATION_​FACETS

dict

-

REQUESTS_​USER_​MODERATION_​SEARCH

dict

-

REQUESTS_​USER_​MODERATION_​SORT_​OPTIONS

dict

-

REST_​CSRF_​ENABLED

unknown

-

REST_​ENABLE_​CORS

unknown

-

REST_​MIMETYPE_​QUERY_​ARG_​NAME

unknown

-

ROR_​CLIENT_​ID

configured by function

configure_generic_parameters

S3_​ACCESS_​KEY_​ID

NoneType

configure_generic_parameters

S3_​CONFIG_​EXTRA

dict

-

S3_​DEFAULT_​BLOCK_​SIZE

int

-

S3_​ENDPOINT_​URL

NoneType

configure_generic_parameters

S3_​MAXIMUM_​NUMBER_​OF_​PARTS

int

-

S3_​REGION_​NAME

NoneType

-

S3_​SECRET_​ACCESS_​KEY

NoneType

configure_generic_parameters

S3_​SIGNATURE_​VERSION

str

-

S3_​UPLOAD_​URL_​EXPIRATION

int

-

S3_​URL_​EXPIRATION

int

-

SEARCH_​CLIENT_​CONFIG

NoneType

configure_generic_parameters

SEARCH_​ELASTIC_​HOSTS

NoneType

-

SEARCH_​HOSTS

NoneType

configure_generic_parameters

SEARCH_​INDEX_​PREFIX

str

configure_generic_parameters

SEARCH_​MAPPINGS

NoneType

-

SEARCH_​RESULTS_​MIN_​SCORE

NoneType

-

SEARCH_​UI_​BASE_​TEMPLATE

NoneType

-

SEARCH_​UI_​HEADER_​TEMPLATE

NoneType

-

SEARCH_​UI_​JSTEMPLATE_​COUNT

str

-

SEARCH_​UI_​JSTEMPLATE_​ERROR

str

-

SEARCH_​UI_​JSTEMPLATE_​FACETS

str

-

SEARCH_​UI_​JSTEMPLATE_​LOADING

str

-

SEARCH_​UI_​JSTEMPLATE_​PAGINATION

str

-

SEARCH_​UI_​JSTEMPLATE_​RANGE

str

-

SEARCH_​UI_​JSTEMPLATE_​RANGE_​OPTIONS

dict

-

SEARCH_​UI_​JSTEMPLATE_​RESULTS

str

-

SEARCH_​UI_​JSTEMPLATE_​SELECT_​BOX

str

-

SEARCH_​UI_​JSTEMPLATE_​SORT_​ORDER

str

-

SEARCH_​UI_​SEARCH_​API

str

-

SEARCH_​UI_​SEARCH_​CONFIG_​GEN

dict

-

SEARCH_​UI_​SEARCH_​INDEX

str

-

SEARCH_​UI_​SEARCH_​TEMPLATE

str

configure_ui

SEARCH_​UI_​SEARCH_​VIEW

unknown

configure_ui

SECRET_​KEY

str

configure_generic_parameters

SECRET_​KEY_​FALLBACKS

NoneType

-

SECURITY_​AUTO_​LOGIN_​AFTER_​CONFIRM

bool

-

SECURITY_​BLUEPRINT_​NAME

str

-

SECURITY_​CHANGEABLE

bool

configure_generic_parameters

SECURITY_​CHANGE_​PASSWORD_​TEMPLATE

str

-

SECURITY_​CHANGE_​SALT

str

-

SECURITY_​CHANGE_​URL

str

-

SECURITY_​CLI_​ROLES_​NAME

str

-

SECURITY_​CLI_​USERS_​NAME

str

-

SECURITY_​CONFIRMABLE

bool

configure_generic_parameters

SECURITY_​CONFIRM_​EMAIL_​WITHIN

str

-

SECURITY_​CONFIRM_​ERROR_​VIEW

NoneType

-

SECURITY_​CONFIRM_​SALT

str

-

SECURITY_​CONFIRM_​URL

str

-

SECURITY_​DEFAULT_​HTTP_​AUTH_​REALM

str

-

SECURITY_​DEFAULT_​REMEMBER_​ME

bool

-

SECURITY_​DEPRECATED_​HASHING_​SCHEMES

list

-

SECURITY_​DEPRECATED_​PASSWORD_​SCHEMES

list

-

SECURITY_​EMAIL_​HTML

bool

-

SECURITY_​EMAIL_​PLAINTEXT

bool

-

SECURITY_​EMAIL_​SUBJECT_​CONFIRM

str

-

SECURITY_​EMAIL_​SUBJECT_​PASSWORD_​CHANGE_​NOTICE

str

-

SECURITY_​EMAIL_​SUBJECT_​PASSWORD_​NOTICE

str

-

SECURITY_​EMAIL_​SUBJECT_​PASSWORD_​RESET

str

-

SECURITY_​EMAIL_​SUBJECT_​REGISTER

str

-

SECURITY_​FLASH_​MESSAGES

bool

-

SECURITY_​FORGOT_​PASSWORD_​TEMPLATE

str

-

SECURITY_​HASHING_​SCHEMES

list

-

SECURITY_​I18N_​DIRNAME

str

-

SECURITY_​I18N_​DOMAIN

str

-

SECURITY_​LOGIN_​SALT

str

-

SECURITY_​LOGIN_​URL

str

-

SECURITY_​LOGIN_​USER_​TEMPLATE

str

-

SECURITY_​LOGIN_​WITHIN

str

-

SECURITY_​LOGIN_​WITHOUT_​CONFIRMATION

bool

configure_generic_parameters

SECURITY_​LOGOUT_​URL

str

-

SECURITY_​MSG_​ALREADY_​CONFIRMED

tuple

-

SECURITY_​MSG_​CONFIRMATION_​EXPIRED

tuple

-

SECURITY_​MSG_​CONFIRMATION_​REQUEST

tuple

-

SECURITY_​MSG_​CONFIRMATION_​REQUIRED

tuple

-

SECURITY_​MSG_​CONFIRM_​REGISTRATION

tuple

-

SECURITY_​MSG_​DISABLED_​ACCOUNT

tuple

-

SECURITY_​MSG_​EMAIL_​ALREADY_​ASSOCIATED

tuple

-

SECURITY_​MSG_​EMAIL_​CONFIRMED

tuple

-

SECURITY_​MSG_​EMAIL_​NOT_​PROVIDED

tuple

-

SECURITY_​MSG_​FORGOT_​PASSWORD

tuple

-

SECURITY_​MSG_​INVALID_​CONFIRMATION_​TOKEN

tuple

-

SECURITY_​MSG_​INVALID_​EMAIL_​ADDRESS

tuple

-

SECURITY_​MSG_​INVALID_​LOGIN_​TOKEN

tuple

-

SECURITY_​MSG_​INVALID_​PASSWORD

tuple

-

SECURITY_​MSG_​INVALID_​REDIRECT

tuple

-

SECURITY_​MSG_​INVALID_​RESET_​PASSWORD_​TOKEN

tuple

-

SECURITY_​MSG_​LOCAL_​LOGIN_​DISABLED

tuple

-

SECURITY_​MSG_​LOGIN

tuple

-

SECURITY_​MSG_​LOGIN_​EMAIL_​SENT

tuple

-

SECURITY_​MSG_​LOGIN_​EXPIRED

tuple

-

SECURITY_​MSG_​PASSWORD_​BREACHED

tuple

-

SECURITY_​MSG_​PASSWORD_​BREACHED_​SITE_​ERROR

tuple

-

SECURITY_​MSG_​PASSWORD_​CHANGE

tuple

-

SECURITY_​MSG_​PASSWORD_​CHANGE_​DISABLED

tuple

-

SECURITY_​MSG_​PASSWORD_​INVALID_​LENGTH

tuple

-

SECURITY_​MSG_​PASSWORD_​IS_​THE_​SAME

tuple

-

SECURITY_​MSG_​PASSWORD_​MISMATCH

tuple

-

SECURITY_​MSG_​PASSWORD_​NOT_​PROVIDED

tuple

-

SECURITY_​MSG_​PASSWORD_​NOT_​SET

tuple

-

SECURITY_​MSG_​PASSWORD_​RECOVERY_​DISABLED

tuple

-

SECURITY_​MSG_​PASSWORD_​RESET

tuple

-

SECURITY_​MSG_​PASSWORD_​RESET_​DISABLED

tuple

-

SECURITY_​MSG_​PASSWORD_​RESET_​EXPIRED

tuple

-

SECURITY_​MSG_​PASSWORD_​RESET_​REQUEST

tuple

-

SECURITY_​MSG_​PASSWORD_​TOO_​SIMPLE

tuple

-

SECURITY_​MSG_​REFRESH

tuple

-

SECURITY_​MSG_​REGISTRATION_​DISABLED

tuple

-

SECURITY_​MSG_​RETYPE_​PASSWORD_​MISMATCH

tuple

-

SECURITY_​MSG_​UNAUTHORIZED

tuple

-

SECURITY_​MSG_​USER_​DOES_​NOT_​EXIST

tuple

-

SECURITY_​PASSWORD_​BREACHED_​COUNT

int

-

SECURITY_​PASSWORD_​CHECK_​BREACHED

bool

-

SECURITY_​PASSWORD_​COMPLEXITY_​CHECKER

NoneType

-

SECURITY_​PASSWORD_​HASH

str

-

SECURITY_​PASSWORD_​LENGTH_​MIN

int

-

SECURITY_​PASSWORD_​SALT

str

-

SECURITY_​PASSWORD_​SCHEMES

list

-

SECURITY_​PASSWORD_​SINGLE_​HASH

list

-

SECURITY_​POST_​CHANGE_​VIEW

NoneType

-

SECURITY_​POST_​CONFIRM_​VIEW

NoneType

-

SECURITY_​POST_​LOGIN_​VIEW

str

-

SECURITY_​POST_​LOGOUT_​VIEW

str

-

SECURITY_​POST_​REGISTER_​VIEW

NoneType

-

SECURITY_​POST_​RESET_​VIEW

NoneType

-

SECURITY_​RECOVERABLE

bool

configure_generic_parameters

SECURITY_​REGISTERABLE

bool

configure_generic_parameters

SECURITY_​REGISTER_​URL

str

-

SECURITY_​REGISTER_​USER_​TEMPLATE

str

-

SECURITY_​RESET_​PASSWORD_​TEMPLATE

str

-

SECURITY_​RESET_​PASSWORD_​WITHIN

str

-

SECURITY_​RESET_​SALT

str

-

SECURITY_​RESET_​URL

str

-

SECURITY_​SEND_​CONFIRMATION_​TEMPLATE

str

-

SECURITY_​SEND_​LOGIN_​TEMPLATE

str

-

SECURITY_​SEND_​PASSWORD_​CHANGE_​EMAIL

bool

-

SECURITY_​SEND_​PASSWORD_​RESET_​EMAIL

bool

-

SECURITY_​SEND_​PASSWORD_​RESET_​NOTICE_​EMAIL

bool

-

SECURITY_​SEND_​REGISTER_​EMAIL

bool

-

SECURITY_​SUBDOMAIN

NoneType

-

SECURITY_​TOKEN_​AUTHENTICATION_​HEADER

str

-

SECURITY_​TOKEN_​AUTHENTICATION_​KEY

str

-

SECURITY_​TOKEN_​MAX_​AGE

NoneType

-

SECURITY_​TRACKABLE

bool

-

SECURITY_​URL_​PREFIX

NoneType

-

SECURITY_​USER_​IDENTITY_​ATTRIBUTES

list

-

SECURITY_​ZXCVBN_​MINIMUM_​SCORE

int

-

SEND_​FILE_​MAX_​AGE_​DEFAULT

NoneType

configure_generic_parameters

SENTRY_​DSN

NoneType

-

SERVER_​NAME

NoneType

-

SESSION_​COOKIE_​DOMAIN

NoneType

configure_generic_parameters

SESSION_​COOKIE_​HTTPONLY

bool

-

SESSION_​COOKIE_​NAME

str

-

SESSION_​COOKIE_​PARTITIONED

bool

-

SESSION_​COOKIE_​PATH

NoneType

-

SESSION_​COOKIE_​SAMESITE

str

-

SESSION_​COOKIE_​SECURE

bool

configure_generic_parameters

SESSION_​KEY_​BITS

int

-

SESSION_​RANDOM_​SOURCE

SystemRandom

-

SESSION_​REFRESH_​EACH_​REQUEST

bool

-

SETTINGS_​TEMPLATE

str

configure_ui

SITEMAP_​MAX_​ENTRY_​COUNT

int

-

SITEMAP_​ROOT_​VIEW_​ENABLED

bool

-

SITEMAP_​SECTIONS

list

-

SITE_​API_​URL

str

configure_generic_parameters

SITE_​UI_​URL

str

configure_generic_parameters

SQLALCHEMY_​BINDS

dict

-

SQLALCHEMY_​DATABASE_​URI

str

configure_generic_parameters

SQLALCHEMY_​ECHO

bool

-

SQLALCHEMY_​ENGINE_​OPTIONS

dict

-

SQLALCHEMY_​RECORD_​QUERIES

bool

-

SQLALCHEMY_​TRACK_​MODIFICATIONS

bool

-

STATS_​AGGREGATIONS

dict

-

STATS_​EVENTS

dict

-

STATS_​EVENTS_​UTC_​DATETIME_​ENABLED

bool

-

STATS_​MQ_​EXCHANGE

unknown

-

STATS_​PERMISSION_​FACTORY

unknown

-

STATS_​QUERIES

dict

-

STATS_​REGISTER_​INDEX_​TEMPLATES

bool

-

STATS_​REGISTER_​RECEIVERS

bool

configure_stats

TEMPLATES_​AUTO_​RELOAD

NoneType

-

TESTING

bool

-

THEME_​401_​TEMPLATE

str

-

THEME_​403_​TEMPLATE

str

-

THEME_​404_​TEMPLATE

str

-

THEME_​429_​TEMPLATE

str

-

THEME_​500_​TEMPLATE

str

-

THEME_​BASE_​TEMPLATE

str

-

THEME_​COVER_​TEMPLATE

str

-

THEME_​CSS_​TEMPLATE

configured by function

configure_ui

THEME_​ERROR_​TEMPLATE

str

-

THEME_​FOOTER_​TEMPLATE

str

configure_ui

THEME_​FRONTPAGE

bool

configure_ui

THEME_​FRONTPAGE_​LOGO

configured by function

configure_ui

THEME_​FRONTPAGE_​TEMPLATE

str

configure_ui

THEME_​FRONTPAGE_​TITLE

LazyString

configure_ui

THEME_​GENERATOR

str

-

THEME_​GOOGLE_​SITE_​VERIFICATION

list

-

THEME_​HEADER_​LOGIN_​TEMPLATE

str

configure_ui

THEME_​HEADER_​TEMPLATE

str

configure_ui

THEME_​ICONS

dict

-

THEME_​JAVASCRIPT_​TEMPLATE

str

configure_ui

THEME_​LOGO

str

configure_ui

THEME_​LOGO_​ADMIN

str

-

THEME_​MATHJAX_​CDN

str

-

THEME_​META_​ROBOT_​TAGS

list

-

THEME_​SEARCHBAR

bool

-

THEME_​SEARCH_​ENDPOINT

str

configure_ui

THEME_​SETTINGS_​TEMPLATE

str

-

THEME_​SHOW_​FRONTPAGE_​INTRO_​SECTION

unknown

configure_ui

THEME_​SITENAME

LazyString

configure_ui

THEME_​SITEURL

str

-

THEME_​TRACKINGCODE_​TEMPLATE

str

configure_ui

THEME_​TWITTERHANDLE

unknown

-

TRAP_​BAD_​REQUEST_​ERRORS

NoneType

-

TRAP_​HTTP_​EXCEPTIONS

bool

-

TRUSTED_​HOSTS

NoneType

-

TYPE_​CHECKING

bool

-

USERPROFILES

bool

-

USERPROFILES_​BASE_​TEMPLATE

str

-

USERPROFILES_​EMAIL_​ENABLED

bool

-

USERPROFILES_​EXTEND_​SECURITY_​FORMS

bool

-

USERPROFILES_​PROFILE_​TEMPLATE

str

-

USERPROFILES_​PROFILE_​URL

str

-

USERPROFILES_​READ_​ONLY

bool

configure_generic_parameters, configure_einfra_oidc

USERPROFILES_​SETTINGS_​TEMPLATE

str

-

USERS_​RESOURCES_​AVATAR_​COLORS

list

-

USERS_​RESOURCES_​DOMAINS_​ORG_​SCHEMA

unknown

-

USERS_​RESOURCES_​DOMAINS_​SEARCH

dict

-

USERS_​RESOURCES_​DOMAINS_​SEARCH_​FACETS

dict

-

USERS_​RESOURCES_​DOMAINS_​SORT_​OPTIONS

dict

-

USERS_​RESOURCES_​GROUPS_​ADMIN_​FACETS

dict

-

USERS_​RESOURCES_​GROUPS_​ADMIN_​SEARCH

dict

-

USERS_​RESOURCES_​GROUPS_​ADMIN_​SORT_​OPTIONS

dict

-

USERS_​RESOURCES_​GROUPS_​ENABLED

bool

-

USERS_​RESOURCES_​MODERATION_​LOCK_​DEFAULT_​TIMEOUT

int

-

USERS_​RESOURCES_​MODERATION_​LOCK_​RENEWAL_​TIMEOUT

int

-

USERS_​RESOURCES_​PROTECTED_​GROUP_​NAMES

list

-

USERS_​RESOURCES_​SEARCH

dict

-

USERS_​RESOURCES_​SEARCH_​FACETS

dict

-

USERS_​RESOURCES_​SERVICE_​SCHEMA

unknown

-

USERS_​RESOURCES_​SORT_​OPTIONS

dict

-

USER_​DASHBOARD_​MENU_​OVERRIDES

dict

-

USE_​X_​SENDFILE

bool

-

VCS_​TEMPLATE_​INDEX

unknown

-

VCS_​TEMPLATE_​INDEX_​ITEM

unknown

-

VCS_​TEMPLATE_​RELEASE_​ITEM

unknown

-

VCS_​TEMPLATE_​REPO_​SWITCH

unknown

-

VCS_​TEMPLATE_​VIEW

unknown

-

VOCABULARIES_​AFFILIATIONS_​EDMO_​COUNTRY_​MAPPING

dict

-

VOCABULARIES_​AFFILIATION_​SCHEMES

dict

configure_generic_parameters

VOCABULARIES_​AWARDS_​EC_​ROR_​ID

str

-

VOCABULARIES_​AWARDS_​OPENAIRE_​FUNDERS

dict

-

VOCABULARIES_​AWARD_​SCHEMES

dict

-

VOCABULARIES_​CF

list

-

VOCABULARIES_​CUSTOM_​VOCABULARY_​TYPES

list

-

VOCABULARIES_​DATASTREAM_​READERS

dict

configure_generic_parameters, configure_datastreams

VOCABULARIES_​DATASTREAM_​TRANSFORMERS

dict

configure_generic_parameters, configure_datastreams

VOCABULARIES_​DATASTREAM_​WRITERS

dict

configure_generic_parameters, configure_datastreams

VOCABULARIES_​FACET_​CACHE_​SIZE

int

-

VOCABULARIES_​FACET_​CACHE_​TTL

int

-

VOCABULARIES_​FUNDER_​DOI_​PREFIX

str

-

VOCABULARIES_​FUNDER_​SCHEMES

dict

configure_generic_parameters

VOCABULARIES_​IDENTIFIER_​SCHEMES

dict

-

VOCABULARIES_​NAMES_​SCHEMES

dict

configure_generic_parameters

VOCABULARIES_​ORCID_​ACCESS_​KEY

str

-

VOCABULARIES_​ORCID_​ORG_​IDS_​MAPPING_​PATH

NoneType

-

VOCABULARIES_​ORCID_​SECRET_​KEY

str

-

VOCABULARIES_​ORCID_​SUMMARIES_​BUCKET

str

-

VOCABULARIES_​ORCID_​SYNC_​MAX_​WORKERS

int

-

VOCABULARIES_​ORCID_​SYNC_​SINCE

dict

-

VOCABULARIES_​RESOURCE_​CONFIG

unknown

configure_generic_parameters

VOCABULARIES_​SERVICE_​CONFIG

unknown

configure_generic_parameters

VOCABULARIES_​SUBJECTS_​EUROSCIVOC_​FILE_​URL

str

-

VOCABULARIES_​SUBJECTS_​GEMET_​FILE_​URL

str

-

VOCABULARIES_​SUBJECTS_​NVS_​FILE_​URL

str

-

VOCABULARIES_​SUBJECTS_​SCHEMES

dict

-

VOCABULARIES_​TYPES_​SEARCH

dict

-

VOCABULARIES_​TYPES_​SORT_​OPTIONS

dict

-

VOCABULARY_​TYPE_​UI_​RESOURCE

str

-

VOCABULARY_​TYPE_​UI_​RESOURCE_​CONFIG

str

-

WEBPACKEXT_​MANIFEST_​PATH

str

-

WEBPACKEXT_​NPM_​PKG_​CLS

configured by function

configure_ui

WEBPACKEXT_​PROJECT

str

configure_ui

WEBPACKEXT_​PROJECT_​BUILDDIR

str

-

WEBPACKEXT_​PROJECT_​DISTDIR

str

-

WEBPACKEXT_​PROJECT_​DISTURL

str

-

WORKFLOWS

dict

-

WORKFLOWS_​DEFAULT_​WORKFLOW

str

-

Detailed Variable Reference

ACCESS_ACTION_CACHE_PREFIX

Prefix for actions cached when used in dynamic permissions.

Invenio RDM Default Value

'Permission::action::'

Type

str

Source

invenio-access


ACCESS_CACHE

A cache instance or an importable string pointing to the cache instance.

Invenio RDM Default Value

None

Type

NoneType

Sources

invenio-access; invenio-app-rdm


ACCESS_LOAD_SYSTEM_ROLE_NEEDS

Enables the loading of system role needs when users’ identity change.

Invenio RDM Default Value

True

Type

bool

Source

invenio-access


ACCOUNTS

Tells if the templates should use the accounts module.

If False, you won’t be able to login via the web UI.

Invenio RDM Default Value

True

Type

bool

Source

invenio-accounts


ACCOUNTS_BASE_TEMPLATE

Default Value

'invenio_theme/page.html'

Type

str

Source

unknown


ACCOUNTS_CONFIRM_EMAIL_ENDPOINT

Value to be used for the confirmation email link in the UI application.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-accounts


ACCOUNTS_COVER_TEMPLATE

Default Value

'invenio_theme/page_cover.html'

Type

str

Source

unknown


ACCOUNTS_DEFAULT_EMAIL_VISIBILITY

Default Email visibility value can be set to either ‘restricted’ or ‘public’.

Invenio RDM Default Value

'restricted'

Type

str

Source

invenio-accounts


ACCOUNTS_DEFAULT_USERS_VERIFIED

Default verified status: if set to ‘True’, users are verified by default.

Invenio RDM Default Value

False

Type

bool

Source

invenio-accounts


ACCOUNTS_DEFAULT_USER_VISIBILITY

Default User visibility value can be set to either ‘restricted’ or ‘public’.

Invenio RDM Default Value

'restricted'

Type

str

Source

invenio-accounts


ACCOUNTS_FORGOT_PASSWORD_EMAIL_RATELIMIT

Flask-Limiter rate limit string for forgot-password requests per account.

Example: "3 per hour". Disabled when None.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-accounts


ACCOUNTS_FORGOT_PASSWORD_EMAIL_RATELIMIT_KEY_PREFIX

Prefix used to namespace forgot-password per-account limiter keys.

Invenio RDM Default Value

'accounts.fp_email'

Type

str

Source

invenio-accounts


ACCOUNTS_FORGOT_PASSWORD_EMAIL_RATELIMIT_MSG

Invenio RDM Default Value

l'Too many password-reset requests for this account. Please try again later.'

Type

LazyString

Source

invenio-accounts


ACCOUNTS_JWT_ALOGORITHM

Set JWT encryption alogirthm.

Invenio RDM Default Value

'HS256'

Type

str

Source

invenio-accounts


ACCOUNTS_JWT_CREATION_FACTORY

Import path of factory used to generate JWT.

Invenio RDM Default Value

'invenio_accounts.utils:jwt_create_token'

Type

str

Source

invenio-accounts


ACCOUNTS_JWT_DECODE_FACTORY

Import path of factory used to decode JWT.

Invenio RDM Default Value

'invenio_accounts.utils:jwt_decode_token'

Type

str

Source

invenio-accounts


ACCOUNTS_JWT_DOM_TOKEN

Register JWT context processor.

{% if current_user.is_authenticated %}
    {{ jwt() }}
{% endif %}

This will generate a hidden field as follows:

<input type="hidden" name="authorized_token" value="xxx">

On your API call you can use it with simple javascript, an example using jQuery is the following:

$.ajax({
    url: '/example',
    method: 'POST',
    beforeSend: function(request) {
        request.setRequestHeader(
            'Authorization',
            'Bearer ' + $('[name=authorized_token]').val()
        );
    },
});

Invenio RDM Default Value

True

Type

bool

Source

invenio-accounts


ACCOUNTS_JWT_DOM_TOKEN_TEMPLATE

Template for the context processor.

Invenio RDM Default Value

'invenio_accounts/jwt.html'

Type

str

Source

invenio-accounts


ACCOUNTS_JWT_ENABLE

Enable JWT support.

Note

More details about JWT

Invenio RDM Default Value

True

Type

bool

Source

invenio-accounts


ACCOUNTS_JWT_EXPIRATION_DELTA

Token expiration period for JWT.

Invenio RDM Default Value

datetime.timedelta(days=1)

Type

timedelta

Source

invenio-accounts


ACCOUNTS_JWT_SECRET_KEY

Secret key for JWT.

Note

If is set to None it will use the SECRET_KEY.

Invenio RDM Default Value

'CHANGE_ME'

Type

str

Source

invenio-accounts


*ACCOUNTS_LOCAL_LOGIN_ENABLED

Whether or not login with local account credentials should be enabled.

Invenio RDM Default Value

True

Type

bool

Source

invenio-accounts

Set by

configure_generic_parameters()


ACCOUNTS_LOGIN_RATELIMIT

Flask-Limiter rate limit string for login requests per account.

Example: "5 per 15 minutes". Disabled when None.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-accounts


ACCOUNTS_LOGIN_RATELIMIT_KEY_PREFIX

Prefix used to namespace login per-account limiter keys.

Invenio RDM Default Value

'accounts.login'

Type

str

Source

invenio-accounts


ACCOUNTS_LOGIN_RATELIMIT_MSG

Invenio RDM Default Value

l'Too many login attempts for this account. Please try again later.'

Type

LazyString

Source

invenio-accounts


*ACCOUNTS_LOGIN_VIEW_FUNCTION

The view function to use for the login endpoint.

This can be either an import string, or the view function itself. If set to None, the default login view function from Flask-Security will be left as is.

Invenio RDM Default Value

login

Type

unknown

Source

invenio-accounts

Set by

configure_generic_parameters()


ACCOUNTS_REGISTER_BLUEPRINT

Register the Security blueprint or not.

It can be used to override the register_blueprint option.

Note

If the value is None, then the blueprint is not registered.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-accounts


ACCOUNTS_RESET_PASSWORD_ENDPOINT

Value to be used for the confirmation email link in the UI application.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-accounts


ACCOUNTS_REST_AUTH_VIEWS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-accounts

{'change_password': 'invenio_accounts.views.rest:ChangePasswordView',
 'confirm_email': 'invenio_accounts.views.rest:ConfirmEmailView',
 'forgot_password': 'invenio_accounts.views.rest:ForgotPasswordView',
 'login': 'invenio_accounts.views.rest:LoginView',
 'logout': 'invenio_accounts.views.rest:LogoutView',
 'register': 'invenio_accounts.views.rest:RegisterView',
 'reset_password': 'invenio_accounts.views.rest:ResetPasswordView',
 'send_confirmation': 'invenio_accounts.views.rest:SendConfirmationEmailView',
 'sessions_item': 'invenio_accounts.views.rest:SessionsItemView',
 'sessions_list': 'invenio_accounts.views.rest:SessionsListView',
 'user_info': 'invenio_accounts.views.rest:UserInfoView'}

ACCOUNTS_REST_CONFIRM_EMAIL_ENDPOINT

Value to be used for the confirmation email link in the API application.

Can be a Flask endpoint (e.g. “invenio_accounts_rest_auth.confirm_email”), or a URL part (e.g. “https://ui.example.com/confirm-email”, “/confirm-email”).

This will be used to build an absolute URL, thus if e.g. a hostname isn’t included, the one from the current request’s context will be used.

Invenio RDM Default Value

'/confirm/{token}'

Type

str

Source

invenio-accounts


ACCOUNTS_REST_RESET_PASSWORD_ENDPOINT

Value to be used for the reset password link in the API application.

Can be a Flask endpoint (e.g. “invenio_accounts_rest_auth.reset_password”), or a URL part (e.g. “https://ui.example.com/reset-password”, “/reset-password”).

This will be used to build an absolute URL, thus if e.g. a hostname isn’t included, the one from the current request’s context will be used.

Invenio RDM Default Value

'/lost-password/{token}'

Type

str

Source

invenio-accounts


ACCOUNTS_RETENTION_PERIOD

Invenio RDM Default Value

datetime.timedelta(days=30)

Type

timedelta

Source

invenio-accounts


ACCOUNTS_SEND_CONFIRMATION_RATELIMIT

Flask-Limiter rate limit string for send-confirmation requests per account.

Example: "3 per hour". Disabled when None.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-accounts


ACCOUNTS_SEND_CONFIRMATION_RATELIMIT_KEY_PREFIX

Prefix used to namespace send-confirmation per-account limiter keys.

Invenio RDM Default Value

'accounts.cf_email'

Type

str

Source

invenio-accounts


ACCOUNTS_SEND_CONFIRMATION_RATELIMIT_MSG

Invenio RDM Default Value

l'Too many confirmation-email requests for this account. Please try again later.'

Type

LazyString

Source

invenio-accounts


ACCOUNTS_SESSION_ACTIVITY_ENABLED

Enable session activity tracking.

Invenio RDM Default Value

True

Type

bool

Source

invenio-accounts


*ACCOUNTS_SESSION_REDIS_URL

Redis URL used by the module as a cache system for sessions.

Invenio RDM Default Value

None

Type

NoneType

Sources

invenio-accounts; invenio-app-rdm

Set by

configure_generic_parameters()


ACCOUNTS_SESSION_STORE_FACTORY

Invenio RDM Default Value

'invenio_accounts.sessions:default_session_store_factory'

Type

str

Source

invenio-accounts


ACCOUNTS_SETTINGS_SECURITY_TEMPLATE

Template for the account security page.

Invenio RDM Default Value

'invenio_accounts/settings/security.html'

Type

str

Source

invenio-accounts


ACCOUNTS_SETTINGS_TEMPLATE

Default Value

'invenio_theme/page_settings.html'

Type

str

Source

unknown


ACCOUNTS_SITENAME

Default Value

l'Invenio'

Type

LazyString

Source

unknown


ACCOUNTS_USERINFO_HEADERS

If True, add X-Session-ID and X-User-ID to the HTTP response.

Invenio RDM Default Value

False

Type

bool

Sources

invenio-accounts; invenio-app-rdm


ACCOUNTS_USERNAME_REGEX

The regular expression used for validating usernames.

Note

When this configuration value is overridden, the value for ACCOUNTS_USERNAME_RULES_TEXT should be updated as well, to reflect the changes.

Invenio RDM Default Value

'^[a-zA-Z][a-zA-Z0-9-_]{2,255}$'

Type

str

Source

invenio-accounts


ACCOUNTS_USERNAME_RULES_TEXT

Invenio RDM Default Value

l'Username must start with a letter, be at least three characters long and only contain alphanumeric...

Type

LazyString

Source

invenio-accounts


ACCOUNTS_USER_PREFERENCES_SCHEMA

The schema to use for validation of the user preferences.

Invenio RDM Default Value

<UserPreferencesSchema(many=False)>

Type

UserPreferencesSchema

Sources

invenio-accounts; invenio-app-rdm


ACCOUNTS_USER_PROFILE_SCHEMA

The schema to use for validation of the user profile.

Invenio RDM Default Value

<UserProfileSchema(many=False)>

Type

UserProfileSchema

Source

invenio-accounts


ACCOUNTS_USE_CELERY

Tells if the module should use Celery or not.

By default, it uses Celery if it can find it.

Invenio RDM Default Value

False

Type

bool

Source

invenio-accounts


ADMINISTRATION_APPNAME

Name of the Flask-Admin app (also the page title of admin panel).

Invenio RDM Default Value

'Invenio-Administration'

Type

str

Source

invenio-administration


ADMINISTRATION_BASE_TEMPLATE

Admin panel base template. By default (None) uses the Flask-Admin template.

Invenio RDM Default Value

'invenio_administration/base.html'

Type

str

Source

invenio-administration


ADMINISTRATION_DASHBOARD_VIEW

Invenio RDM Default Value

'invenio_administration.views.dashboard.AdminDashboardView'

Type

str

Source

invenio-administration


ADMINISTRATION_DISPLAY_VERSIONS

Display packages versions in the admin panel side bar.

Accepts a list of tuples in the format (package name, version). Example: [(“my-app”, “v1.3.2”)]

Invenio RDM Default Value

<list>

Type

list

Sources

invenio-administration; invenio-app-rdm

[]

*ADMINISTRATION_THEME_BASE_TEMPLATE

Administration base template.

Invenio RDM Default Value

'invenio_theme/page.html'

Type

str

Sources

invenio-administration; invenio-app-rdm

Set by

configure_ui()


ADMIN_BASE_TEMPLATE

Base template for the administration interface.

The template changes the administration interface from using a standard Bootstrap interface to using AdminLTE 2.

The variable is defined in Invenio-Admin which will use the value defined here if Invenio-Theme is installed.

Invenio RDM Default Value

'invenio_theme/page_admin.html'

Type

str

Source

invenio-theme


ALEMBIC

Default Value

<dict>

Type

dict

Source

unknown

{'script_location': '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_db/alembic',
 'version_locations': [('invenio_oauth2server',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_oauth2server/alembic'),
                       ('invenio_rdm_records',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_rdm_records/alembic'),
                       ('jobs',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_jobs/alembic'),
                       ('invenio_pidstore',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_pidstore/alembic'),
                       ('invenio_audit_logs',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_audit_logs/alembic'),
                       ('invenio_records_files',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_records_files/alembic'),
                       ('invenio_communities',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_communities/alembic'),
                       ('invenio_collections',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_collections/alembic'),
                       ('invenio_banners',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_banners/alembic'),
                       ('invenio_pages',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_pages/alembic'),
                       ('invenio_records',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_records/alembic'),
                       ('invenio_vocabularies',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_vocabularies/alembic'),
                       ('invenio_requests',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_requests/alembic'),
                       ('invenio_oauthclient',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_oauthclient/alembic'),
                       ('invenio_oaiserver',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_oaiserver/alembic'),
                       ('oarepo_doi',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/oarepo_doi/alembic'),
                       ('invenio_access',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_access/alembic'),
                       ('oarepo_vocabularies',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/oarepo_vocabularies/alembic'),
                       ('invenio_accounts',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_accounts/alembic'),
                       ('oarepo_requests',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/oarepo_requests/alembic'),
                       ('invenio_checks',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_checks/alembic'),
                       ('invenio_files_rest',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_files_rest/alembic'),
                       ('invenio_userprofiles',
                        '/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/invenio_userprofiles/alembic')]}

ALEMBIC_CONTEXT

Default Value

<dict>

Type

dict

Source

unknown

{'compare_server_default': True,
 'compare_type': True,
 'transaction_per_migration': True}

ALLOWED_HTML_ATTRS

Default Value

<dict>

Type

dict

Source

unknown

{'*': ['class'],
 'a': ['href', 'title', 'name', 'class', 'rel'],
 'abbr': ['title'],
 'acronym': ['title']}

ALLOWED_HTML_TAGS

Default Value

<list>

Type

list

Source

unknown

['a',
 'abbr',
 'acronym',
 'b',
 'blockquote',
 'br',
 'code',
 'div',
 'table',
 'tbody',
 'td',
 'th',
 'tr',
 'em',
 'h1',
 'h2',
 'h3',
 'h4',
 'h5',
 'i',
 'li',
 'ol',
 'p',
 'pre',
 'span',
 'strike',
 'strong',
 'sub',
 'sup',
 'u',
 'ul']

APPLICATION_ROOT

Default Value

'/'

Type

str

Source

unknown


*APP_ALLOWED_HOSTS

Type

configured by function

Source

oarepo-config

Set by

configure_generic_parameters()


*APP_DEFAULT_SECURE_HEADERS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app

Set by

configure_generic_parameters(), configure_ui()

{'content_security_policy': {'default-src': ["'self'"], 'object-src': ["'none'"]},
 'content_security_policy_report_only': False,
 'content_security_policy_report_uri': None,
 'force_file_save': False,
 'force_https': True,
 'force_https_permanent': False,
 'frame_options': 'sameorigin',
 'frame_options_allow_from': None,
 'session_cookie_http_only': True,
 'session_cookie_secure': True,
 'strict_transport_security': True,
 'strict_transport_security_include_subdomains': True,
 'strict_transport_security_max_age': 31556926,
 'strict_transport_security_preload': False}

APP_ENABLE_SECURE_HEADERS

Enable Secure Headers. (Default: True)

In case you want to disable completely Talisman, you can set to False.

Remember that, for development purpose, setting `DEBUG = True` is already enough to disable any side effects such as force https.

Note

W3C

Invenio RDM Default Value

True

Type

bool

Source

invenio-app


APP_HEALTH_BLUEPRINT_ENABLED

Enable the ping (healthcheck) blueprint. (Default: False)

Invenio RDM Default Value

True

Type

bool

Source

invenio-app


*APP_LOGS_PERMISSION_POLICY

Permission policy for job logs.

Invenio RDM Default Value

JobLogsPermissionPolicy

Type

unknown

Source

invenio-jobs

Set by

configure_jobs()


APP_RDM_ADMIN_EMAIL_RECIPIENT

Admin e-mail

Invenio RDM Default Value

'info@inveniosoftware.org'

Type

unknown

Source

invenio-app-rdm


APP_RDM_DEPOSIT_FORM_AUTOCOMPLETE_NAMES

Behavior for autocomplete names search field for creators/contributors.

Available options:

  • search (default): Show search field and form always.

  • search_only: Only show search field. Form displayed after selection or explicit “manual” entry.

  • off: Only show person form (no search field).

Invenio RDM Default Value

'search'

Type

unknown

Source

invenio-app-rdm


APP_RDM_DEPOSIT_FORM_CUSTOM_FIELD_DEFAULTS

Default values for custom fields in new records in the deposit UI.

The keys denote the dot-separated path, where in the record’s custom field values should be set (see invenio-records.dictutils). If the value is callable, its return value will be used for the field (e.g. lambda/function for dynamic calculation of values).

Invenio RDM Default Value

<dict>

Type

unknown

Source

invenio-app-rdm

{}

APP_RDM_DEPOSIT_FORM_DEFAULTS

OARepo Default Value

<dict>

Type

dict

Sources

oarepo-rdm; invenio-app-rdm

{'publication_date': <function <lambda> at 0x7f4c7f5959b0>}

APP_RDM_DEPOSIT_FORM_PUBLISH_MODAL_EXTRA

Additional text/html to be displayed in the publish and submit for review modal.

Invenio RDM Default Value

''

Type

unknown

Source

invenio-app-rdm


*APP_RDM_DEPOSIT_FORM_QUOTA

Invenio RDM Default Value

<dict>

Type

unknown

Source

invenio-app-rdm

Set by

configure_generic_parameters(), configure_files()

{
    'maxFiles': 100,
    'maxStorage': RDM_FILES_DEFAULT_QUOTA_SIZE,
}

APP_RDM_DEPOSIT_FORM_TEMPLATE

Deposit page’s form template.

Invenio RDM Default Value

'invenio_app_rdm/records/deposit.html'

Type

unknown

Source

invenio-app-rdm


*APP_RDM_DEPOSIT_NG_FILES_UI_ENABLED

Feature toggle to enable the next-generation (NG) file uploader UI in the deposit form.

When enabled, the deposit form will use the new Uppy.io-based file uploader, replacing the current file upload interface.

Invenio RDM Default Value

False

Type

unknown

Source

invenio-app-rdm

Set by

configure_ui()


*APP_RDM_DETAIL_SIDE_BAR_TEMPLATES

Invenio RDM Default Value

<list>

Type

unknown

Source

invenio-app-rdm

Set by

configure_ui()

[
    'invenio_app_rdm/records/details/side_bar/manage_menu.html',
    'invenio_app_rdm/records/details/side_bar/metrics.html',
    'invenio_app_rdm/records/details/side_bar/versions.html',
    'invenio_app_rdm/records/details/side_bar/external_resources.html',
    'invenio_app_rdm/records/details/side_bar/communities.html',
    'invenio_app_rdm/records/details/side_bar/keywords_subjects.html',
    'invenio_app_rdm/records/details/side_bar/details.html',
    'invenio_app_rdm/records/details/side_bar/locations.html',
    'invenio_app_rdm/records/details/side_bar/licenses.html',
    'invenio_app_rdm/records/details/side_bar/citations.html',
    'invenio_app_rdm/records/details/side_bar/export.html',
    'invenio_app_rdm/records/details/side_bar/technical_metadata.html',
]

APP_RDM_DISPLAY_DECIMAL_FILE_SIZES

Display the file sizes in powers of 1000 (KB, …) or 1024 (KiB, …).

Invenio RDM Default Value

True

Type

unknown

Source

invenio-app-rdm


APP_RDM_FILES_INTEGRITY_REPORT_SUBJECT

Files integrity report subject

Invenio RDM Default Value

_('Files integrity report')

Type

unknown

Source

invenio-app-rdm


APP_RDM_FILES_INTEGRITY_REPORT_TEMPLATE

Invenio RDM Default Value

'invenio_app_rdm/files_integrity_report/email/files_integrity_report.html'

Type

unknown

Source

invenio-app-rdm


*APP_RDM_IDENTIFIER_SCHEMES_UI

Invenio RDM Default Value

<dict>

Type

unknown

Source

invenio-app-rdm

Set by

configure_generic_parameters()

{
    'orcid': {
        'url_prefix': 'http://orcid.org/',
        'icon': 'images/orcid.svg',
        'label': 'ORCID',
    },
    'ror': {
        'url_prefix': 'https://ror.org/',
        'icon': 'images/ror-icon.svg',
        'label': 'ROR',
    },
    'gnd': {
        'url_prefix': 'http://d-nb.info/gnd/',
        'icon': 'images/gnd-icon.svg',
        'label': 'GND',
    },
}

APP_RDM_MODERATION_REQUEST_FACETS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app-rdm

{'is_open': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c833968b0>,
             'ui': {'field': 'is_open'}},
 'status': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c833d16d0>,
            'ui': {'field': 'status'}}}

APP_RDM_MODERATION_REQUEST_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app-rdm

{'bestmatch': {'fields': ['_score'], 'title': 'Best match'},
 'newest': {'fields': ['-created'], 'title': 'Newest'},
 'newestactivity': {'fields': ['-last_activity_at'], 'title': 'Newest activity'},
 'oldest': {'fields': ['created'], 'title': 'Oldest'},
 'oldestactivity': {'fields': ['last_activity_at'], 'title': 'Oldest activity'}}

APP_RDM_PAGES

Register static pages with predefined initial content from ‘pages.yaml’ file.

Example: {

“about”: “/about”, “terms”: “/terms”, “privacy-policy”: “/privacy-policy”,

}

Invenio RDM Default Value

<dict>

Type

unknown

Source

invenio-app-rdm

{}

APP_RDM_RECORDS_EXPORT_URL

Invenio RDM Default Value

'/records/<pid_value>/export/<export_format>'

Type

unknown

Source

invenio-app-rdm


APP_RDM_RECORD_EXPORTERS

Invenio RDM Default Value

<dict>

Type

unknown

Source

invenio-app-rdm

{
    'json': {
        'name': _('JSON'),
        'serializer': 'flask_resources.serializers:JSONSerializer',
        'params': {
            'options': {
                'indent': 2,
                'sort_keys': True,
            },
        },
        'content-type': 'application/json',
        'filename': '{id}.json',
    },
    'json-ld': {
        'name': _('JSON-LD'),
        'serializer': 'invenio_rdm_records.resources.serializers:SchemaorgJSONLDSerializer',
        'content-type': 'application/ld+json',
        'filename': '{id}.json',
    },
    'csl': {
        'name': _('CSL'),
        'serializer': 'invenio_rdm_records.resources.serializers:CSLJSONSerializer',
        'params': {
            'options': {
                'indent': 2,
                'sort_keys': True,
            },
        },
        'content-type': 'application/vnd.citationstyles.csl+json',
        'filename': '{id}.json',
    },
    'datacite-json': {
        'name': _('DataCite JSON'),
        'serializer': 'invenio_rdm_records.resources.serializers:DataCite45JSONSerializer',
        'params': {
            'options': {
                'indent': 2,
                'sort_keys': True,
            },
        },
        'content-type': 'application/vnd.datacite.datacite+json',
        'filename': '{id}.json',
    },
    'datacite-xml': {
        'name': _('DataCite XML'),
        'serializer': 'invenio_rdm_records.resources.serializers:DataCite45XMLSerializer',
        'params': {},
        'content-type': 'application/vnd.datacite.datacite+xml',
        'filename': '{id}.xml',
    },
    'dublincore': {
        'name': _('Dublin Core XML'),
        'serializer': 'invenio_rdm_records.resources.serializers:DublinCoreXMLSerializer',
        'params': {},
        'content-type': 'application/x-dc+xml',
        'filename': '{id}.xml',
    },
    'marcxml': {
        'name': _('MARCXML'),
        'serializer': 'invenio_rdm_records.resources.serializers:MARCXMLSerializer',
        'params': {},
        'content-type': 'application/marcxml+xml',
        'filename': '{id}.xml',
    },
    'bibtex': {
        'name': _('BibTeX'),
        'serializer': 'invenio_rdm_records.resources.serializers:BibtexSerializer',
        'params': {},
        'content-type': 'application/x-bibtex',
        'filename': '{id}.bib',
    },
    'geojson': {
        'name': _('GeoJSON'),
        'serializer': 'invenio_rdm_records.resources.serializers:GeoJSONSerializer',
        'params': {
            'options': {
                'indent': 2,
                'sort_keys': True,
            },
        },
        'content-type': 'application/vnd.geo+json',
        'filename': '{id}.geojson',
    },
    'dcat-ap': {
        'name': _('DCAT'),
        'serializer': 'invenio_rdm_records.resources.serializers:DCATSerializer',
        'params': {},
        'content-type': 'application/dcat+xml',
        'filename': '{id}.xml',
    },
    'codemeta': {
        'name': _('Codemeta'),
        'serializer': 'invenio_rdm_records.resources.serializers:CodemetaSerializer',
        'params': {},
        'content-type': 'application/ld+json',
        'filename': '{id}.json',
    },
    'cff': {
        'name': _('Citation File Format'),
        'serializer': 'invenio_rdm_records.resources.serializers:CFFSerializer',
        'params': {},
        'content-type': 'application/x-yaml',
        'filename': '{id}.yaml',
    },
    'datapackage': {
        'name': _('Data Package JSON'),
        'serializer': 'invenio_rdm_records.resources.serializers:DataPackageSerializer',
        'params': {},
        'content-type': 'application/ld+json',
        'filename': '{id}.json',
    },
}

APP_RDM_RECORD_LANDING_PAGE_FAIR_SIGNPOSTING_LEVEL_1_ENABLED

Invenio RDM Default Value

False

Type

unknown

Source

invenio-app-rdm


APP_RDM_RECORD_LANDING_PAGE_TEMPLATE

OARepo Default Value

'oarepo_rdm/record_detail_iframe.html'

Type

str

Sources

oarepo-rdm; invenio-app-rdm


APP_RDM_RECORD_THUMBNAIL_SIZES

Allowed record thumbnail sizes.

Invenio RDM Default Value

<list>

Type

unknown

Source

invenio-app-rdm

[
    10,
    50,
    100,
    250,
    750,
    1200,
]

APP_RDM_ROUTES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app-rdm

{'dashboard_home': '/me',
 'deposit_create': '/uploads/new',
 'deposit_edit': '/uploads/<pid_value>',
 'help_search': '/help/search',
 'help_statistics': '/help/statistics',
 'help_versioning': '/help/versioning',
 'index': '/',
 'record_container_item_download': '/records/<pid_value>/files/<path:filename>/container/<path:path>',
 'record_container_item_preview': '/records/<pid_value>/preview/<path:filename>/container/<path:path>',
 'record_detail': '/records/<pid_value>',
 'record_export': '/records/<pid_value>/export/<export_format>',
 'record_file_download': '/records/<pid_value>/files/<path:filename>',
 'record_file_preview': '/records/<pid_value>/preview/<path:filename>',
 'record_from_pid': '/<any({schemes}):pid_scheme>/<path:pid_value>',
 'record_latest': '/records/<pid_value>/latest',
 'record_media_file_download': '/records/<pid_value>/media-files/<path:filename>',
 'record_search': '/search',
 'record_thumbnail': '/records/<pid_value>/thumb<int:size>',
 'robots': '/robots.txt'}

APP_RDM_SUBCOMMUNITIES_LABEL

Label for the subcommunities in the community browse page.

Invenio RDM Default Value

_('Subcommunities')

Type

unknown

Source

invenio-app-rdm


APP_RDM_USER_DASHBOARD_ROUTES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app-rdm

{'communities': '/me/communities', 'requests': '/me/requests', 'uploads': '/me/uploads'}

APP_REQUESTID_HEADER

Name of header containing a request id (max length 200 characters).

If set, the request id will be extracted from the header and set on the global Flask g request object. The extracted request id can be used by other Invenio modules - e.g. Invenio-Logging could include it in log messages.

The request id can be used to trace requests between systems to make troubleshooting easier.

You can configure Nginx 1.10+ to automatically generate a request id and add it as a header to both the upstream WSGI server and downstream client:

add_header X-Request-ID $request_id;

Set to None to not extract a request id.

Invenio RDM Default Value

'X-Request-Id'

Type

str

Source

invenio-app


*APP_THEME

Application-wide themes list used for template and assets lookup.

The value is a list of theme strings applied in a fallback fashion in the order they are specified:

APP_THEME = ['my-overlay', 'semantic-ui']

From the above example, templates and assets with the my-overlay prefix will be looked up first, and if not found the semantic-ui prefix will be used. If none of the lookups are successful, a non-prefixed lookup is done.

Invenio RDM Default Value

None

Type

NoneType

Sources

invenio-app; invenio-app-rdm

Set by

configure_ui()


*ASSETS_BUILDER

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


AUDIT_LOGS_DISABLED_ACTIONS

Disabled actions to be excluded from the audit logs. To find all the available actions, check the entry points in the invenio_audit_logs.actions group. ```python >>> from invenio_base.utils import entry_points >>> [ep.name for ep in entry_points(group=”invenio_audit_logs.actions”)]


| **Invenio RDM Default Value** | `<set>` |
|--------------|-----------|
| **Type** | set |
| **Source** | [invenio-audit-logs](https://github.com/inveniosoftware/invenio-audit-logs/blob/master/invenio_audit_logs/config.py#L52) |

set()


---

(audit-logs-enabled)=
### AUDIT_LOGS_ENABLED

```{eval-rst}
Feature flag. Disabled by default.

Invenio RDM Default Value

False

Type

bool

Source

invenio-audit-logs


AUDIT_LOGS_FACETS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-audit-logs

{'action_name': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c82480390>,
                 'ui': {'field': 'action'}},
 'resource': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c8245baf0>,
              'ui': {'field': 'resource.type'}}}

AUDIT_LOGS_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-audit-logs

{'bestmatch': {'fields': ['_score'], 'title': 'Best match'},
 'newest': {'fields': ['-@timestamp'], 'title': 'Newest'},
 'oldest': {'fields': ['@timestamp'], 'title': 'Oldest'}}

*BABEL_DEFAULT_LOCALE

Default locale (language).

Invenio RDM Default Value

'en'

Type

str

Source

invenio-app-rdm

Set by

configure_generic_parameters()


*BABEL_DEFAULT_TIMEZONE

Default time zone.

Invenio RDM Default Value

'Europe/Zurich'

Type

unknown

Source

invenio-app-rdm

Set by

configure_generic_parameters()


BANNERS_CATEGORIES

Invenio RDM Default Value

<list>

Type

list

Source

invenio-banners

[('info', l'Info'), ('warning', l'Warning'), ('other', l'Other')]

BANNERS_CATEGORIES_TO_STYLE

Function to transform the banner category to a specific Semantic-UI class.

Invenio RDM Default Value

style_category

Type

unknown

Source

invenio-banners


BANNERS_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-banners

{'active': {'fields': ['active'], 'title': l'Active'},
 'end_datetime': {'fields': ['end_datetime'], 'title': l'End DateTime'},
 'start_datetime': {'fields': ['start_datetime'], 'title': l'Start DateTime'},
 'url_path': {'fields': ['url_path'], 'title': l'URL path'}}

*BASE_TEMPLATE

Base template for user facing pages.

The template provides a basic skeleton which takes care of loading assets, embedding header metadata and define basic template blocks. All other user facing templates usually extends from this template and thus changing this template allows to change design and layout of Invenio.

Invenio RDM Default Value

'invenio_theme/page.html'

Type

str

Sources

invenio-theme; invenio-app-rdm

Set by

configure_ui()


*BROKER_URL

URL of message broker for Celery 3 (default is RabbitMQ).

Invenio RDM Default Value

'redis://localhost:6379/0'

Type

str

Sources

invenio-celery; invenio-app-rdm

Set by

configure_generic_parameters()


CACHE_IS_AUTHENTICATED_CALLBACK

Import path to callback.

Callback is executed to determine if request is authenticated.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-cache


CACHE_KEY_PREFIX

Cache key prefix.

Invenio RDM Default Value

'cache::'

Type

str

Source

invenio-cache


*CACHE_REDIS_URL

Redis location and database.

Invenio RDM Default Value

'redis://localhost:6379/0'

Type

str

Sources

invenio-cache; invenio-app-rdm

Set by

configure_generic_parameters()


CACHE_TYPE

Cache type.

Please refer to Flask-Caching documentation for other cache types.

Invenio RDM Default Value

'flask_caching.backends.redis'

Type

str

Sources

invenio-cache; invenio-app-rdm


CELERY_ACCEPT_CONTENT

A whitelist of content-types/serializers.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-celery

['json', 'msgpack', 'yaml']

*CELERY_BEAT_SCHEDULE

Invenio RDM Default Value

<dict>

Type

unknown

Source

invenio-app-rdm

Set by

configure_cron()

{
    'indexer': {
        'task': 'invenio_records_resources.tasks.manage_indexer_queues',
        'schedule': timedelta(seconds=10),
    },
    'accounts_sessions': {
        'task': 'invenio_accounts.tasks.clean_session_table',
        'schedule': timedelta(minutes=60),
    },
    'accounts_ips': {
        'task': 'invenio_accounts.tasks.delete_ips',
        'schedule': timedelta(hours=6),
    },
    'update_domain_status': {
        'task': 'invenio_accounts.tasks.update_domain_status',
        'schedule': timedelta(hours=4),
    },
    'draft_resources': {
        'task': 'invenio_drafts_resources.services.records.tasks.cleanup_drafts',
        'schedule': timedelta(minutes=60),
    },
    'rdm_records': {
        'task': 'invenio_rdm_records.services.tasks.update_expired_embargos',
        'schedule': crontab(minute=2, hour=0),
    },
    'expire_requests': {
        'task': 'invenio_requests.tasks.check_expired_requests',
        'schedule': crontab(minute=3, hour=0),
    },
    'file-checks': {
        'task': 'invenio_files_rest.tasks.schedule_checksum_verification',
        'schedule': timedelta(hours=1),
        'kwargs': {
            'batch_interval': {
                'hours': 1,
            },
            'frequency': {
                'days': 14,
            },
            'max_count': 0,
            'files_query': 'invenio_app_rdm.utils.files.checksum_verification_files_query',
        },
    },
    'file-integrity-report': {
        'task': 'invenio_app_rdm.tasks.file_integrity_report',
        'schedule': crontab(minute=0, hour=7),
    },
    'stats-process-events': {
        **StatsEventTask,
        'schedule': crontab(minute='25,55'),
    },
    'stats-aggregate-events': {
        **StatsAggregationTask,
        'schedule': crontab(minute=0),
    },
    'reindex-stats': StatsRDMReindexTask,
    'clear-cache': {
        'task': 'invenio_communities.tasks.clear_cache',
        'schedule': crontab(minute=0, hour=1),
    },
    'clean-access-request-tokens': {
        'task': 'invenio_rdm_records.requests.access.tasks.clean_expired_request_access_tokens',
        'schedule': crontab(minute=4, hour=0),
    },
    'delete-job-logs': {
        'task': 'invenio_jobs.logging.tasks.delete_logs',
        'schedule': crontab(minute=5, hour=0),
    },
    'update_sitemap': {
        'task': 'invenio_sitemap.tasks.update_sitemap_cache',
        'schedule': crontab(minute=0, hour=2),
    },
    'update-collections-size': {
        'task': 'invenio_rdm_records.collections.tasks.update_collections_size',
        'schedule': timedelta(hours=1),
    },
}

*CELERY_BROKER_URL

Broker settings.

Invenio RDM Default Value

'redis://localhost:6379/0'

Type

str

Sources

invenio-celery; invenio-app-rdm

Set by

configure_generic_parameters()


*CELERY_RESULT_BACKEND

The backend used to store task results.

Invenio RDM Default Value

'redis://localhost:6379/1'

Type

str

Sources

invenio-celery; invenio-app-rdm

Set by

configure_generic_parameters()


CELERY_RESULT_SERIALIZER

Result serialization format. Default is msgpack.

Invenio RDM Default Value

'msgpack'

Type

str

Source

invenio-celery


CELERY_TASK_SERIALIZER

The default serialization method to use. Default is msgpack.

Invenio RDM Default Value

'msgpack'

Type

str

Source

invenio-celery


CHECKS_COMMUNITIES_SERVICE_COMPONENTS

Extra components that are registered to COMMUNITIES_SERVICE_COMPONENTS.

The default (RegisterCheckComponent) will create a LLM configuration for a community whenever it is added/modified.

OARepo Default Value

<list>

Type

unknown

Source

oarepo-checks

[
    RegisterCheckComponent,
]

*CHECKS_ENABLED

Enable checks.

Invenio RDM Default Value

False

Type

bool

Source

invenio-checks

Set by

configure_llm()


*CHECKS_GENERIC_COMMUNITY

A slug of community that is used for LLM prompt when record does not belong to a community.

OARepo Default Value

'generic-community'

Type

str

Source

oarepo-checks

Set by

configure_llm()


COLLECTIONS_MAX_COLLECTIONS_PER_TREE

Maximum number of collections allowed per tree.

This counts all collections in a tree, regardless of depth. Set to 0 for unlimited collections. Default: 100

Invenio RDM Default Value

100

Type

int

Source

invenio-collections


COLLECTIONS_MAX_DEPTH

Maximum depth for collection hierarchies.

Depth 0 = root collections Depth 1 = children of root Depth 2 = grandchildren (not allowed by default)

Setting this to 1 allows 2 levels: root + children only. Setting this to 2 would allow 3 levels: root + children + grandchildren.

Invenio RDM Default Value

1

Type

int

Source

invenio-collections


COLLECTIONS_MAX_TREES

Maximum number of collection trees allowed per namespace.

Set to 0 for unlimited trees. Default: 10

Invenio RDM Default Value

10

Type

int

Source

invenio-collections


COLLECTIONS_PERMISSION_POLICY

Permission policy used by invenio-collections for managing collection trees.

Invenio RDM Default Value

CommunityPermissionPolicy

Type

unknown

Source

invenio-communities


COLLECT_STATIC_ROOT

Default Value

'/opt/hostedtoolcache/Python/3.14.6/x64/var/instance/static'

Type

str

Source

unknown


*COLLECT_STORAGE

Static files collection method (defaults to copying files).

Invenio RDM Default Value

'flask_collect.storage.link'

Type

str

Source

invenio-app-rdm

Set by

configure_generic_parameters()


COMMUNITIES_ALLOW_MEMBERSHIP_REQUESTS

Feature flag for membership request.

Invenio RDM Default Value

False

Type

bool

Source

invenio-communities


COMMUNITIES_ALLOW_RESTRICTED

Invenio RDM Default Value

True

Type

bool

Source

invenio-communities


COMMUNITIES_COLLECTIONS_ENABLED

Feature flag to enable/disable collections feature.

Invenio RDM Default Value

False

Type

bool

Source

invenio-communities


COMMUNITIES_CUSTOM_FIELDS

Communities custom fields definition.

Of the shape:

[
    <custom-field-class-type(name='field')>,
    # ...
    <custom-field-class-type(name='fieldN')>'
]

For example:

[
    TextCF(name="experiment"),
    ...
]

Invenio RDM Default Value

<list>

Type

list

Source

invenio-communities

[<oarepo_communities.services.custom_fields.workflow.WorkflowCF object at 0x7f4c7c7ef4d0>,
 <oarepo_communities.services.custom_fields.workflow.WorkflowCF object at 0x7f4c7c2c1bd0>]

COMMUNITIES_CUSTOM_FIELDS_UI

Communities custom fields UI configuration.

Of the shape:

[{
    section: <section_name>,
    fields: [
        {
            field: "path-to-field",  # this should be validated against the defined fields in `RDM_CUSTOM_FIELDS`
            ui_widget: "<ui-widget-name>",  # predefined or user defined ui widget
            props: {
                label:"<ui-label-to-display>",
                placeholder:"<placeholder-passed-to-widget>",
                icon:"<icon-passed-to-widget>",
                description:"<description-passed-to-widget>",
            }
        },
    ],

    # ...
}]

For example:

[{
    "section": "CERN Experiment"
    "fields" : [{
        field: "experiment",  # this should be validated against the defined fields in `RDM_CUSTOM_FIELDS`
        ui_widget: "CustomTextField",  # user defined widget in my-site
        props: {
            label: "Experiment",
            placeholder: "Type an experiment...",
            icon: "pencil",
            description: "You should fill this field with one of the experiments e.g LHC, ATLAS etc.",
        }
    },
    ...
}]

Invenio RDM Default Value

<list>

Type

list

Source

invenio-communities

[{'fields': [{'field': 'workflow',
              'props': {'description': l'Default workflow for the community if workflow is not specified when depositing a record.',
                        'label': l'Default workflow',
                        'options': []},
              'ui_widget': 'Dropdown'},
             {'field': 'allowed_workflows',
              'props': {'description': l'Workflows allowed for the community.',
                        'label': l'Allowed workflows',
                        'multiple': True,
                        'options': []},
              'ui_widget': 'Dropdown'}],
  'section': l'Workflows'}]

COMMUNITIES_DEFAULT_RECORD_SUBMISSION_POLICY

Default value of record submission policy community access setting.

Invenio RDM Default Value

<RecordSubmissionPolicyEnum.OPEN: 'open'>

Type

RecordSubmissionPolicyEnum

Source

invenio-communities


COMMUNITIES_ERROR_HANDLERS

Invenio RDM Default Value

<dict>

Type

unknown

Source

invenio-app-rdm

{
    **community_error_handlers,
    InvalidCommunityVisibility: create_error_handler(lambda e: HTTPJSONException(code=400, description=e.reason)),
}

COMMUNITIES_FACETS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-communities

{'type': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c827f15b0>,
          'ui': {'field': 'type'}},
 'visibility': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c82709d00>,
                'ui': {'field': 'visibility'}}}

COMMUNITIES_IDENTITIES_CACHE_HANDLER

Invenio RDM Default Value

'invenio_communities.cache.redis:IdentityRedisCache'

Type

str

Source

invenio-communities


*COMMUNITIES_IDENTITIES_CACHE_REDIS_URL

Invenio RDM Default Value

'redis://localhost:6379/4'

Type

str

Source

invenio-communities

Set by

configure_generic_parameters()


COMMUNITIES_IDENTITIES_CACHE_TIME

Invenio RDM Default Value

86400

Type

int

Source

invenio-communities


COMMUNITIES_INVITATIONS_EXPIRES_IN

Default amount of time before an invitation expires.

Invenio RDM Default Value

datetime.timedelta(days=30)

Type

timedelta

Source

invenio-communities


COMMUNITIES_INVITATIONS_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-communities

{'bestmatch': {'fields': ['_score'], 'title': l'Best match'},
 'name': {'fields': ['user.profile.full_name.keyword'], 'title': l'Name'},
 'newest': {'fields': ['-created'], 'title': l'Newest'},
 'oldest': {'fields': ['created'], 'title': l'Oldest'}}

COMMUNITIES_LOGO_MAX_FILE_SIZE

Community logo size quota, in bytes.

Invenio RDM Default Value

1000000

Type

int

Source

invenio-communities


COMMUNITIES_MEMBERSHIP_REQUESTS_EXPIRES_IN

Default amount of time before a membership request expires.

Invenio RDM Default Value

datetime.timedelta(days=30)

Type

timedelta

Source

invenio-communities


COMMUNITIES_MEMBERSHIP_REQUESTS_FACETS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-communities

{'role': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c8270b680>,
          'ui': {'field': 'role'}},
 'status': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c833d16d0>,
            'ui': {'field': 'role'}}}

COMMUNITIES_MEMBERS_FACETS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-communities

{'role': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c8270b680>,
          'ui': {'field': 'role'}},
 'visibility': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c8260a650>,
                'ui': {'field': 'visible'}}}

COMMUNITIES_MEMBERS_SERVICE_COMPONENTS

Default Value

<list>

Type

list

Source

unknown

[<class 'oarepo_oidc_einfra.services.components.aai_invitations.AAIInvitationComponent'>,
 <class 'invenio_records_resources.services.records.components.metadata.MetadataComponent'>,
 <class 'invenio_communities.members.services.components.CommunityMemberCachingComponent'>]

COMMUNITIES_MEMBERS_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-communities

{'bestmatch': {'fields': ['_score'], 'title': l'Best match'},
 'name': {'fields': ['user.profile.full_name.keyword'], 'title': l'Name'},
 'newest': {'fields': ['-created'], 'title': l'Newest'},
 'oldest': {'fields': ['created'], 'title': l'Oldest'}}

COMMUNITIES_NAMESPACES

Custom fields namespaces.

For example:

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-communities

{}

COMMUNITIES_OAI_SETS_PREFIX

Invenio RDM Default Value

'community-'

Type

str

Source

invenio-communities


*COMMUNITIES_PERMISSION_POLICY

Type

configured by function

Source

oarepo-config

Set by

configure_communities()


COMMUNITIES_RECORDS_SEARCH_ALL

Default Value

False

Type

bool

Source

unknown


*COMMUNITIES_REGISTER_UI_BLUEPRINT

Type

configured by function

Source

oarepo-config

Set by

configure_communities()


*COMMUNITIES_ROLES

Invenio RDM Default Value

<list>

Type

list

Source

invenio-communities

Set by

configure_communities()

[{'can_view': True,
  'description': l'Can view restricted records.',
  'name': 'reader',
  'title': l'Reader'},
 {'can_curate': True,
  'can_view': True,
  'description': l'Can curate records and view restricted records.',
  'name': 'curator',
  'title': l'Curator'},
 {'can_curate': True,
  'can_manage': True,
  'can_manage_roles': ['manager', 'curator', 'reader'],
  'can_view': True,
  'description': l'Can manage members, curate records and view restricted records.',
  'name': 'manager',
  'title': l'Manager'},
 {'can_curate': True,
  'can_manage': True,
  'can_manage_roles': ['owner', 'manager', 'curator', 'reader'],
  'can_view': True,
  'description': l'Full administrative access to the entire community.',
  'is_owner': True,
  'name': 'owner',
  'title': l'Owner'}]

COMMUNITIES_ROUTES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-communities

{'about': '/communities/<pid_value>/about',
 'curation_policy': '/communities/<pid_value>/curation-policy',
 'deprecated_new': '/communities/new',
 'deprecated_search': '/communities/search',
 'frontpage': '/communities',
 'invitations': '/communities/<pid_value>/invitations',
 'members': '/communities/<pid_value>/members',
 'membership_requests': '/communities/<pid_value>/membership-requests',
 'my_communities': '/me/communities',
 'new': '/communities-new',
 'new_subcommunity': '/communities/<pid_value>/subcommunities/new',
 'requests': '/communities/<pid_value>/requests',
 'search': '/communities-search',
 'settings': '/communities/<pid_value>/settings',
 'settings_collections': '/communities/<pid_value>/settings/collections',
 'settings_pages': '/communities/<pid_value>/settings/pages',
 'settings_privileges': '/communities/<pid_value>/settings/privileges',
 'settings_submission_policy': '/communities/<pid_value>/settings/submission-policy',
 'subcommunities': '/communities/<pid_value>/browse/subcommunities',
 'upload': '/communities/<pid_value>/upload'}

COMMUNITIES_SEARCH_SORT_BY_VERIFIED

Sort communities by ‘verified’ first.

Invenio RDM Default Value

False

Type

bool

Source

invenio-communities


COMMUNITIES_SERVICE_COMPONENTS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-app-rdm

[<class 'oarepo_oidc_einfra.services.components.aai_communities.CommunityAAIComponent'>,
 <class 'invenio_records_resources.services.records.components.metadata.MetadataComponent'>,
 <class 'invenio_communities.communities.services.components.CommunityThemeComponent'>,
 <class 'invenio_communities.communities.services.components.CustomFieldsComponent'>,
 <class 'invenio_communities.communities.services.components.PIDComponent'>,
 <class 'invenio_records_resources.services.records.components.relations.RelationsComponent'>,
 <class 'invenio_communities.communities.services.components.CommunityAccessComponent'>,
 <class 'invenio_communities.communities.services.components.OwnershipComponent'>,
 <class 'invenio_communities.communities.services.components.FeaturedCommunityComponent'>,
 <class 'invenio_communities.communities.services.components.OAISetComponent'>,
 <class 'invenio_communities.communities.services.components.CommunityDeletionComponent'>,
 <class 'invenio_communities.communities.services.components.ChildrenComponent'>,
 <class 'invenio_communities.communities.services.components.CommunityParentComponent'>,
 <class 'oarepo_checks.services.components.register_check_config.RegisterCheckComponent'>]

COMMUNITIES_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-communities

{'bestmatch': {'fields': ['_score'], 'title': l'Best match'},
 'newest': {'fields': ['-created'], 'title': l'Newest'},
 'newestactivity': {'fields': ['-last_activity_at'], 'title': l'Newest activity'},
 'oldest': {'fields': ['created'], 'title': l'Oldest'},
 'oldestactivity': {'fields': ['last_activity_at'], 'title': l'Oldest activity'},
 'updated-asc': {'fields': ['updated'], 'title': l'Least recently updated'},
 'updated-desc': {'fields': ['-updated'], 'title': l'Recently updated'},
 'version': {'fields': ['-versions.index'], 'title': l'Version'}}

COMMUNITIES_SUBCOMMUNITIES_FACETS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-communities

{'type': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c827f15b0>,
          'ui': {'field': 'type'}},
 'visibility': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c82709d00>,
                'ui': {'field': 'visibility'}}}

COMMUNITIES_SUB_INVITATION_REQUEST_CLS

RDM specific request type for subcommunity invitations.

Invenio RDM Default Value

RDMSubCommunityInvitationRequest

Type

unknown

Source

invenio-app-rdm


COMMUNITIES_SUB_REQUEST_CLS

RDM specific request type for subcommunities.

Invenio RDM Default Value

RDMSubCommunityRequest

Type

unknown

Source

invenio-app-rdm


CORS_EXPOSE_HEADERS

Invenio RDM Default Value

<list>

Type

unknown

Source

invenio-rest

[
    'ETag',
    'Link',
    'X-RateLimit-Limit',
    'X-RateLimit-Remaining',
    'X-RateLimit-Reset',
    'Content-Type',
]

CORS_RESOURCES

Dictionary for configuring CORS for endpoints.

See Flask-CORS for further details.

Note

Overwrites Flask-CORS configuration.

Invenio RDM Default Value

'*'

Type

unknown

Source

invenio-rest


CORS_SEND_WILDCARD

Sending wildcard CORS header.

Note

Overwrites Flask-CORS configuration.

Invenio RDM Default Value

True

Type

unknown

Source

invenio-rest


*COVER_TEMPLATE

Cover page template normally used e.g. for login and sign up pages.

Invenio RDM Default Value

'invenio_theme/page_cover.html'

Type

str

Sources

invenio-theme; invenio-app-rdm

Set by

configure_ui()


CROSSREF_ADDITIONAL_PREFIXES

List of additional Crossref DOI prefixes supported for registration.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[]

CROSSREF_DEPOSITOR

Crossref depositor name.

Invenio RDM Default Value

''

Type

str

Source

invenio-rdm-records


CROSSREF_EMAIL

Crossref depositor email.

Invenio RDM Default Value

''

Type

str

Source

invenio-rdm-records


CROSSREF_ENABLED

Flag to enable/disable Crossref DOI registration.

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


CROSSREF_FORMAT

A string used for formatting the DOI or a callable.

If set to a string, you can used {prefix} and {id} inside the string.

You can also provide a callable instead:

def make_doi(prefix, record):
    return f"{prefix}/{record.pid.pid_value}"

CROSSREF_FORMAT = make_doi

Invenio RDM Default Value

'{prefix}/{id}'

Type

str

Source

invenio-rdm-records


CROSSREF_PASSWORD

Crossref password.

Invenio RDM Default Value

''

Type

str

Source

invenio-rdm-records


CROSSREF_PREFIX

Crossref DOI prefix.

Invenio RDM Default Value

''

Type

str

Source

invenio-rdm-records


CROSSREF_REGISTRANT

Crossref registrant.

Invenio RDM Default Value

''

Type

str

Source

invenio-rdm-records


CROSSREF_TEST_MODE

Crossref test mode enabled.

Invenio RDM Default Value

True

Type

bool

Source

invenio-rdm-records


CROSSREF_URL

OARepo Default Value

'https://api.crossref.org/works/doi'

Type

str

Source

oarepo-related-resources


CROSSREF_USERNAME

Crossref username.

Invenio RDM Default Value

''

Type

str

Source

invenio-rdm-records


CSRF_ALLOWED_CHARS

Default Value

'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'

Type

str

Source

unknown


CSRF_FORCE_SECURE_REFERER

Default Value

True

Type

bool

Source

unknown


CSRF_HEADER

Default Value

'X-CSRFToken'

Type

str

Source

unknown


CSRF_METHODS

Default Value

<list>

Type

list

Source

unknown

['POST', 'PUT', 'PATCH', 'DELETE']

CSRF_SECRET_SALT

Default Value

'invenio-csrf-token'

Type

str

Source

unknown


CSRF_TOKEN_EXPIRES_IN

Default Value

86400

Type

int

Source

unknown


CSRF_TOKEN_GRACE_PERIOD

Default Value

604800

Type

int

Source

unknown


CSRF_TOKEN_LENGTH

Default Value

32

Type

int

Source

unknown


*DASHBOARD_RECORD_CREATE_URL

Type

configured by function

Source

oarepo-config

Set by

configure_generic_parameters(), configure_ui()


DATACITE_ADDITIONAL_PREFIXES

List of additional DataCite DOI prefixes supported for registration.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[]

DATACITE_DATACENTER_SYMBOL

DataCite data center symbol.

This is only required if you want your records to be harvestable (OAI-PMH) in DataCite XML format.

Invenio RDM Default Value

''

Type

str

Source

invenio-rdm-records


DATACITE_ENABLED

Flag to enable/disable DataCite DOI registration.

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


DATACITE_FORMAT

A string used for formatting the DOI or a callable.

If set to a string, you can used {prefix} and {id} inside the string.

You can also provide a callable instead:

def make_doi(prefix, record):
    return f"{prefix}/{record.pid.pid_value}"

DATACITE_FORMAT = make_doi

Invenio RDM Default Value

'{prefix}/{id}'

Type

str

Source

invenio-rdm-records


DATACITE_PASSWORD

DataCite password.

Invenio RDM Default Value

''

Type

str

Source

invenio-rdm-records


DATACITE_PREFIX

DataCite DOI prefix.

Invenio RDM Default Value

''

Type

str

Source

invenio-rdm-records


*DATACITE_TEST_MODE

DataCite test mode enabled.

Invenio RDM Default Value

True

Type

bool

Source

invenio-rdm-records

Set by

configure_generic_parameters()


DATACITE_URL

OARepo Default Value

'https://api.datacite.org/dois'

Type

str

Source

oarepo-related-resources


DATACITE_USERNAME

DataCite username.

Invenio RDM Default Value

''

Type

str

Source

invenio-rdm-records


DB_VERSIONING

Default Value

True

Type

bool

Source

unknown


DB_VERSIONING_USER_MODEL

Invenio RDM Default Value

None

Type

unknown

Source

invenio-app-rdm


DEBUG

Default Value

False

Type

bool

Source

unknown


DEBUG_TB_INTERCEPT_REDIRECTS

Switches off incept of redirects by Flask-DebugToolbar.

Invenio RDM Default Value

False

Type

unknown

Source

invenio-app-rdm


DEFAULT_COMMUNITIES_CUSTOM_FIELDS

Default Value

<list>

Type

list

Source

unknown

[<oarepo_communities.services.custom_fields.workflow.WorkflowCF object at 0x7f4c7c7ef4d0>,
 <oarepo_communities.services.custom_fields.workflow.WorkflowCF object at 0x7f4c7c2c1bd0>]

DEFAULT_COMMUNITIES_CUSTOM_FIELDS_UI

Default Value

<list>

Type

list

Source

unknown

[{'fields': [{'field': 'workflow',
              'props': {'description': l'Default workflow for the community if workflow is not specified when depositing a record.',
                        'label': l'Default workflow',
                        'options': []},
              'ui_widget': 'Dropdown'},
             {'field': 'allowed_workflows',
              'props': {'description': l'Workflows allowed for the community.',
                        'label': l'Allowed workflows',
                        'multiple': True,
                        'options': []},
              'ui_widget': 'Dropdown'}],
  'section': l'Workflows'}]

DEFAULT_WORKFLOW_EVENTS

Default Value

<dict>

Type

dict

Source

unknown

{'C': WorkflowEvent(submitters=[<invenio_records_permissions.generators.IfConfig object at 0x7f4c833d0550>]),
 'L': WorkflowEvent(submitters=[<invenio_records_permissions.generators.IfConfig object at 0x7f4c833d0550>])}

*DEPLOYMENT_VERSION

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


DISPLAY_NEW_COMMUNITIES

Default Value

True

Type

bool

Source

unknown


DISPLAY_USER_COMMUNITIES

Default Value

True

Type

bool

Source

unknown


DOI_SETTINGS_FACETS

OARepo Default Value

<dict>

Type

dict

Source

oarepo-doi

{'community_slug': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7c92c980>,
                    'ui': {'field': 'community_slug'}},
 'prefix': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7c92cad0>,
            'ui': {'field': 'prefix'}}}

DOI_SETTINGS_SORT_OPTIONS

OARepo Default Value

<dict>

Type

dict

Source

oarepo-doi

{'newest': {'fields': ['-created'], 'title': l'Newest'}}

*EINFRA

Type

configured by function

Source

oarepo-config

Set by

configure_einfra_oidc()


EINFRA_API_URL

URL of the E-INFRA Perun API.

OARepo Default Value

'https://perun-api.e-infra.cz/krb'

Type

str

Source

oarepo-oidc-einfra


EINFRA_CAPABILITIES_ATTRIBUTE_NAME

urn of the attribute in the E-INFRA Perun that represents the capabilities.

OARepo Default Value

'urn:perun:resource:attribute-def:def:capabilities'

Type

str

Source

oarepo-oidc-einfra


EINFRA_COMMUNITY_INVITATION_SYNCHRONIZATION

Synchronize community membership invitation to E-Infra Perun

(create perun invitation) when user is invited in repository UI.

OARepo Default Value

True

Type

bool

Source

oarepo-oidc-einfra


EINFRA_COMMUNITY_MEMBER_SYNCHRONIZATION

Synchronize community membership to E-Infra Perun when user changes role within a community.

OARepo Default Value

True

Type

bool

Source

oarepo-oidc-einfra


EINFRA_COMMUNITY_SYNCHRONIZATION

Synchronize community to E-Infra Perun when community is created.

OARepo Default Value

True

Type

bool

Source

oarepo-oidc-einfra


EINFRA_DEFAULT_INVITATION_LANGUAGE

Language of the invitation emails that are sent to the users.

OARepo Default Value

'en'

Type

str

Source

oarepo-oidc-einfra


EINFRA_ENTITLEMENT_NAMESPACES

URN prefix for capabilities that can represent community roles.

OARepo Default Value

<set>

Type

set

Source

oarepo-oidc-einfra

{'geant'}

EINFRA_ENTITLEMENT_PREFIX

Parts of the entitlement URN name that represent communities.

OARepo Default Value

'cesnet.cz'

Type

str

Source

oarepo-oidc-einfra


EINFRA_LAST_DUMP_PATH

Path to the last dump file in the S3 bucket.

OARepo Default Value

'nrp_invenio_export.json'

Type

str

Source

oarepo-oidc-einfra


*EINFRA_LOGIN_APP

Type

configured by function

Source

oarepo-config

Set by

configure_einfra_oidc()


EINFRA_RSA_KEY

OARepo Default Value

b'-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmho5h/lz6USUUazQaVT3\nPHlo...

Type

bytes

Source

oarepo-oidc-einfra


EINFRA_USER_DISPLAY_NAME_ATTRIBUTE

Attribute on user inside perun that represents the display name of the user.

OARepo Default Value

'urn:perun:user:attribute-def:core:displayName'

Type

str

Source

oarepo-oidc-einfra


EINFRA_USER_ID_DUMP_ATTRIBUTE

Attribute on user inside perun that represents the E-INFRA ID of the user.

OARepo Default Value

'urn:perun:user:attribute-def:virt:login-namespace:einfraid-persistent'

Type

str

Source

oarepo-oidc-einfra


EINFRA_USER_ID_SEARCH_ATTRIBUTE

Attribute on user inside perun that represents the E-INFRA ID of the user.

OARepo Default Value

'urn:perun:user:attribute-def:def:login-namespace:einfraid-persistent-shadow'

Type

str

Source

oarepo-oidc-einfra


EINFRA_USER_ORGANIZATION_ATTRIBUTE

Attribute on user inside perun that represents the organization of the user.

OARepo Default Value

'urn:perun:user:attribute-def:def:organization'

Type

str

Source

oarepo-oidc-einfra


EINFRA_USER_PREFERRED_MAIL_ATTRIBUTE

Attribute on user inside perun that represents the preferred mail of the user.

OARepo Default Value

'urn:perun:user:attribute-def:def:preferredMail'

Type

str

Source

oarepo-oidc-einfra


EXPLAIN_TEMPLATE_LOADING

Default Value

False

Type

bool

Source

unknown


FILES_REST_ALLOW_RANGE_REQUESTS

Enable support for HTTP Range Requests.

Invenio RDM Default Value

False

Type

bool

Source

invenio-files-rest


FILES_REST_CHECKSUM_VERIFICATION_URI_PREFIXES

URI prefixes of files their checksums should be verified

Invenio RDM Default Value

<list>

Type

unknown

Source

invenio-app-rdm

[]

*FILES_REST_DEFAULT_MAX_FILE_SIZE

Default maximum file size for a bucket in bytes. None if unlimited.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-files-rest

Set by

configure_files()


*FILES_REST_DEFAULT_QUOTA_SIZE

Default quota size for a bucket in bytes. None if unlimited.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-files-rest

Set by

configure_generic_parameters(), configure_files()


*FILES_REST_DEFAULT_STORAGE_CLASS

Default storage class. Must be one of FILES_REST_STORAGE_CLASS_LIST.

Invenio RDM Default Value

'S'

Type

str

Sources

invenio-files-rest; invenio-app-rdm

Set by

configure_generic_parameters()


FILES_REST_FILE_TAGS_HEADER

Header for updating file tags.

Invenio RDM Default Value

'X-Invenio-File-Tags'

Type

str

Source

invenio-files-rest


FILES_REST_FILE_URI_MAX_LEN

Maximum length of the FileInstance.uri field.

Warning

Setting this variable to anything higher than 255 is only supported with PostgreSQL database.

Invenio RDM Default Value

255

Type

int

Source

invenio-files-rest


FILES_REST_MIN_FILE_SIZE

Minimum file size when uploading, in bytes (do not allow empty files).

Invenio RDM Default Value

1

Type

int

Source

invenio-files-rest


FILES_REST_MULTIPART_CHUNKSIZE_MAX

Maximum chunk size in bytes of multipart objects.

Invenio RDM Default Value

5368709120

Type

int

Source

invenio-files-rest


FILES_REST_MULTIPART_CHUNKSIZE_MIN

Minimum chunk size in bytes of multipart objects.

Invenio RDM Default Value

5242880

Type

int

Source

invenio-files-rest


FILES_REST_MULTIPART_EXPIRES

Time delta after which a multipart upload is considered expired.

Invenio RDM Default Value

datetime.timedelta(days=4)

Type

timedelta

Source

invenio-files-rest


FILES_REST_MULTIPART_MAX_PARTS

Maximum number of parts when uploading files with multipart uploads.

Invenio RDM Default Value

10000

Type

int

Source

invenio-files-rest


FILES_REST_MULTIPART_PART_FACTORIES

Invenio RDM Default Value

<list>

Type

list

Source

invenio-files-rest

['invenio_files_rest.views:default_partfactory',
 'invenio_files_rest.views:ngfileupload_partfactory']

FILES_REST_OBJECT_KEY_MAX_LEN

Maximum length of the ObjectVersion.key field.

Warning

Setting this variable to anything higher than 255 is only supported with PostgreSQL database.

Invenio RDM Default Value

255

Type

int

Source

invenio-files-rest


FILES_REST_PERMISSION_FACTORY

Permission factory to control the files access from the REST interface.

Invenio RDM Default Value

'invenio_files_rest.permissions.permission_factory'

Type

str

Sources

invenio-files-rest; invenio-app-rdm


FILES_REST_SIZE_LIMITERS

Import path of file size limiters factory to control bucket size limits.

Invenio RDM Default Value

'invenio_files_rest.limiters.file_size_limiters'

Type

str

Source

invenio-files-rest


*FILES_REST_STORAGE_CLASS_LIST

Invenio RDM Default Value

<dict>

Type

dict

Sources

invenio-files-rest; invenio-app-rdm

Set by

configure_generic_parameters()

{'A': 'Archive', 'S': 'Standard'}

*FILES_REST_STORAGE_FACTORY

Import path of factory used to create a storage instance.

Invenio RDM Default Value

'invenio_files_rest.storage.pyfs_storage_factory'

Type

str

Source

invenio-files-rest

Set by

configure_generic_parameters()


FILES_REST_STORAGE_PATH_DIMENSIONS

Number of directory levels created when generating the path of a file.

For example, if split length set to 2 and dimension to 3, the final path will be a2/ad/4k/c9-8j39-34jn/.

Invenio RDM Default Value

2

Type

int

Source

invenio-files-rest


FILES_REST_STORAGE_PATH_SPLIT_LENGTH

Number of chars to use as folder name when generating the path of a file.

For example, if split length set to 4 and dimension to 4, the final path will be a2ad/4kc9/8j39-34jn/.

Invenio RDM Default Value

2

Type

int

Source

invenio-files-rest


FILES_REST_TASK_WAIT_INTERVAL

Interval in seconds between sending a whitespace to not close connection.

Invenio RDM Default Value

2

Type

int

Source

invenio-files-rest


FILES_REST_TASK_WAIT_MAX_SECONDS

Maximum number of seconds to wait for a task to finish.

Invenio RDM Default Value

600

Type

int

Source

invenio-files-rest


FILES_REST_UPLOAD_FACTORIES

Invenio RDM Default Value

<list>

Type

list

Source

invenio-files-rest

['invenio_files_rest.views:stream_uploadfactory',
 'invenio_files_rest.views:ngfileupload_uploadfactory']

FILES_REST_XSENDFILE_ENABLED

Use the X-Accel-Redirect header to stream the file through a reverse proxy(

e.g NGINX).

Invenio RDM Default Value

False

Type

bool

Source

invenio-files-rest


FILES_REST_XSENDFILE_RESPONSE_FUNC

Function for the creation of a file streaming redirect response.

Invenio RDM Default Value

create_file_streaming_redirect_response

Type

unknown

Source

invenio-files-rest


FORMATTER_BADGES_ALLOWED_TITLES

List of allowed titles in badges.

Invenio RDM Default Value

<list>

Type

list

Sources

invenio-formatter; invenio-app-rdm

['DOI']

FORMATTER_BADGES_ENABLE

Default Value

True

Type

bool

Source

unknown


FORMATTER_BADGES_MAX_CACHE_AGE

The maximum amount of time a badge will be considered fresh.

Invenio RDM Default Value

0

Type

int

Source

invenio-formatter


FORMATTER_BADGES_TITLE_MAPPING

Mapping of titles.

Invenio RDM Default Value

<dict>

Type

dict

Sources

invenio-formatter; invenio-app-rdm

{}

HANDLE_URL

OARepo Default Value

'https://hdl.handle.net'

Type

str

Source

oarepo-related-resources


*HEADER_TEMPLATE

Base header template to be extended on custom headers.

Invenio RDM Default Value

'invenio_theme/header.html'

Type

unknown

Source

invenio-theme

Set by

configure_ui()


I18N_DEFAULT_REDIRECT_ENDPOINT

Endpoint to redirect if no next parameter is provided.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-i18n


I18N_JS_DISTR_EXCEPTIONAL_PACKAGE_MAP

Exceptional package name mapper for JS/React localization distribution.

Webpack entrypoints are used to determine the asset path for distributing JS/React localizations. Entrypoint names usually match the corresponding package name, but some differ. This mapping is used to associate exceptional entrypoint names with their package names.

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-i18n

{}

*I18N_LANGUAGES

List of tuples of available languages.

Example configuration with english and danish with english as default language:

from flask_babel import lazy_gettext as _
BABEL_DEFAULT_LOCALE = 'en'
I18N_LANGUAGES = (('da', _('Danish')),)

Note

You should not include BABEL_DEFAULT_LOCALE in this list.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-i18n

Set by

configure_generic_parameters()

[]

I18N_SESSION_KEY

Key to retrieve language identifier from the current session object.

Invenio RDM Default Value

'language'

Type

str

Source

invenio-i18n


I18N_SET_LANGUAGE_URL

URL prefix for set language view.

Set to None to prevent view from being installed.

Invenio RDM Default Value

'/lang'

Type

str

Source

invenio-i18n


I18N_TRANSIFEX_JS_RESOURCES_MAP

Mapping of transifex resource names to invenioRDM package names.

All resources/packages that should be translated with Transifex should be added here.

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-i18n

{}

I18N_TRANSLATIONS_PATHS

List of paths to load message catalogs from.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-i18n

[]

I18N_USER_LANG_ATTR

Attribute name which contains language identifier on the User object.

It is used only when the login manager is installed and a user is authenticated. Set to None to prevent selector from being used.

Invenio RDM Default Value

'prefered_language'

Type

str

Source

invenio-i18n


IIIF_API_DECORATOR_HANDLER

Invenio RDM Default Value

None

Type

unknown

Source

invenio-app-rdm


IIIF_API_INFO_RESPONSE_SKELETON

Default Value

<dict>

Type

dict

Source

unknown

{'v1': {'@context': 'http://library.stanford.edu/iiif/image-api/1.1/context.json',
        '@id': '',
        'height': '',
        'profile': 'http://library.stanford.edu/iiif/image-api/compliance.html#level1',
        'scale_factors': [1, 2, 4, 8, 16, 32, 64],
        'tile_height': 256,
        'tile_width': 256,
        'width': ''},
 'v2': {'@context': 'http://iiif.io/api/image/2/context.json',
        '@id': '',
        'height': '',
        'profile': ['http://iiif.io/api/image/2/level2.json'],
        'protocol': 'http://iiif.io/api/image',
        'tiles': [{'scaleFactors': [1, 2, 4, 8, 16, 32, 64], 'width': 256}],
        'width': ''}}

IIIF_CACHE_HANDLER

Default Value

'flask_iiif.cache.simple:ImageSimpleCache'

Type

str

Source

unknown


IIIF_CACHE_IGNORE_ERRORS

Default Value

False

Type

bool

Source

unknown


IIIF_CACHE_REDIS_URL

Default Value

'redis://localhost:6379/0'

Type

str

Source

unknown


IIIF_CACHE_TIME

Default Value

172800

Type

int

Source

unknown


IIIF_CONVERTERS

Default Value

<tuple>

Type

tuple

Source

unknown

('', 'L', 'L', '1', '', '')

IIIF_FORMATS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app-rdm

{'gif': 'image/gif',
 'jp2': 'image/jp2',
 'jpeg': 'image/jpeg',
 'jpg': 'image/jpeg',
 'pdf': 'application/pdf',
 'png': 'image/png',
 'tif': 'image/tiff',
 'tiff': 'image/tiff',
 'webp': 'image/webp'}

IIIF_FORMATS_PIL_MAP

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app-rdm

{'gif': 'gif',
 'jp2': 'jpeg2000',
 'jpeg': 'jpeg',
 'jpg': 'jpeg',
 'pdf': 'pdf',
 'png': 'png',
 'tif': 'tiff',
 'tiff': 'tiff',
 'webp': 'webp'}

IIIF_GIF_TEMP_FOLDER_PATH

Default Value

'/tmp'

Type

str

Source

unknown


IIIF_MODE

Default Value

<dict>

Type

dict

Source

unknown

{'1': ['default', 'bitonal'],
 'CMYK': ['default', 'color', 'gray', 'grey', 'bitonal'],
 'F': ['default', 'color', 'gray', 'grey', 'bitonal'],
 'I': ['default', 'color', 'gray', 'grey', 'bitonal'],
 'L': ['default', 'gray', 'grey', 'bitonal'],
 'P': ['default', 'gray', 'grey', 'bitonal'],
 'RGB': ['default', 'color', 'gray', 'grey', 'bitonal'],
 'RGBA': ['default', 'color', 'gray', 'grey', 'bitonal'],
 'YCbCr': ['default', 'color', 'gray', 'grey', 'bitonal']}

IIIF_PREVIEW_TEMPLATE

Template for IIIF image preview.

Invenio RDM Default Value

'invenio_app_rdm/records/iiif_preview.html'

Type

str

Source

invenio-app-rdm


IIIF_QUALITIES

Default Value

<tuple>

Type

tuple

Source

unknown

('default', 'gray', 'grey', 'bitonal', 'color', 'native')

IIIF_SIMPLE_PREVIEWER_NATIVE_EXTENSIONS

Images are converted to JPEG for preview, unless listed here.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-app-rdm

['gif', 'png']

IIIF_SIMPLE_PREVIEWER_SIZE

Size of image in IIIF preview window. Must be a valid IIIF Image API size parameter.

Invenio RDM Default Value

'!800,800'

Type

str

Source

invenio-app-rdm


IIIF_TILES_CONVERTER_PARAMS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-rdm-records

{'Q': 90, 'compression': 'jpeg', 'tile_height': 256, 'tile_width': 256}

IIIF_TILES_GENERATION_ENABLED

Enable generating pyramidal TIFF tiles for uploaded images.

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


IIIF_TILES_STORAGE_BASE_PATH

Base path for storing IIIF tiles.

Relative paths are resolved against the application instance path.

Invenio RDM Default Value

'images/'

Type

str

Source

invenio-rdm-records


IIIF_TILES_VALID_EXTENSIONS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

['jp2', 'jpeg', 'jpg', 'pdf', 'png', 'png', 'tif', 'tiff']

IIIF_VALIDATIONS

Default Value

<dict>

Type

dict

Source

unknown

{'v1': {'image_format': {'ignore': '',
                         'validate': '(gif|jp2|jpe?g|pdf|png|tiff?|webp)'},
        'quality': {'ignore': 'default', 'validate': '(native|color|gr[ae]y|bitonal)'},
        'region': {'ignore': 'full',
                   'validate': '(^full|(pct:)?([\\d.]+,){3}([\\d.]+))'},
        'rotation': {'ignore': '0', 'validate': '^[\\d.]+$'},
        'size': {'ignore': 'full',
                 'validate': '(^full|[\\d.]+,|,[\\d.]+|pct:[\\d.]+|[\\d.]+,[\\d.]+|![\\d.]+,[\\d.]+)'}},
 'v2': {'image_format': {'ignore': '',
                         'validate': '(gif|jp2|jpe?g|pdf|png|tiff?|webp)'},
        'quality': {'ignore': 'default', 'validate': '(default|color|gr[ae]y|bitonal)'},
        'region': {'ignore': 'full',
                   'validate': '(^full|(pct:)?([\\d.]+,){3}([\\d.]+))'},
        'rotation': {'ignore': '0', 'validate': '^!?[\\d.]+$'},
        'size': {'ignore': 'full',
                 'validate': '(^full|[\\d.]+,|,[\\d.]+|pct:[\\d.]+|[\\d.]+,[\\d.]+|![\\d.]+,[\\d.]+)'}}}

INDEXER_BEFORE_INDEX_HOOKS

List of automatically connected hooks (function or importable string).

Invenio RDM Default Value

<list>

Type

list

Source

invenio-indexer

[]

INDEXER_BULK_REQUEST_TIMEOUT

Request timeout to use in Bulk indexing.

Invenio RDM Default Value

10

Type

int

Source

invenio-indexer


INDEXER_DEFAULT_INDEX

Default index to use if no schema is defined.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-indexer


INDEXER_MAX_BULK_CONSUMERS

Maximum number of concurrent consumers for bulk indexing.

This threshold is applied per queue, so each indexing queue would have a maximum of 5 consumers at the same time.

Invenio RDM Default Value

5

Type

int

Source

invenio-indexer


INDEXER_MQ_EXCHANGE

Default exchange for message queue.

Invenio RDM Default Value

Exchange('indexer', type='direct')

Type

unknown

Source

invenio-indexer


INDEXER_MQ_PUBLISH_KWARGS

Default message queue producer publishing kwargs.

Passed to kombu.Producer:publish.

INDEXER_MQ_PUBLISH_KWARGS = {
    "retry": True,
    "retry_policy": {         # Setting for maximum waiting time of ~10min:
        "interval_start": 0,  # First retry immediately,
        "interval_step": 2,   # then increase by 2s for every retry.
        "interval_max": 30,   # but don't exceed 30s between retries.
        "max_retries": 30,    # give up after 30 tries.
    },
}

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-indexer

{}

INDEXER_MQ_QUEUE

Default queue for message queue.

Invenio RDM Default Value

Queue('indexer', exchange=INDEXER_MQ_EXCHANGE, routing_key='indexer')

Type

unknown

Source

invenio-indexer


INDEXER_MQ_ROUTING_KEY

Default routing key for message queue.

Invenio RDM Default Value

'indexer'

Type

str

Source

invenio-indexer


INDEXER_RECORD_TO_INDEX

Provide an implementation of record_to_index function

Invenio RDM Default Value

'invenio_indexer.utils.default_record_to_index'

Type

str

Source

invenio-indexer


INDEXER_REPLACE_REFS

Whether to replace JSONRefs prior to indexing record.

Invenio RDM Default Value

True

Type

bool

Source

invenio-indexer


INFO_ENDPOINT_COMPONENTS

Default Value

<list>

Type

list

Source

unknown

['oarepo_rdm.info:RDMInfoComponent']

*INSTANCE_THEME_FILE

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


*INVENIO_CACHE_TYPE

Type

configured by function

Source

oarepo-config

Set by

configure_generic_parameters()


INVENIO_RDM_ENABLED

Default Value

True

Type

bool

Source

unknown


*INVENIO_VOCABULARY_TYPE_METADATA

Default Value

<dict>

Type

dict

Source

unknown

Set by

configure_vocabulary()

{}

*JAVASCRIPT_PACKAGES_MANAGER

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


JOBS_DEFAULT_QUEUE

Default Celery queue.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-jobs


JOBS_FACETS

Facets/aggregations for Jobs results.

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-jobs

{}

JOBS_LOGGING

Enable logging for jobs.

Invenio RDM Default Value

True

Type

bool

Source

invenio-jobs


JOBS_LOGGING_INDEX

“Index name for job logs.

Invenio RDM Default Value

'job-logs'

Type

str

Source

invenio-jobs


*JOBS_LOGGING_LEVEL

Logging level for jobs.

Invenio RDM Default Value

'DEBUG'

Type

str

Source

invenio-jobs

Set by

configure_jobs()


JOBS_LOGGING_RETENTION_DAYS

Retention period for job logs in days.

Invenio RDM Default Value

90

Type

int

Source

invenio-jobs


JOBS_LOGS_BATCH_SIZE

Number of log results to fetch per batch from the search backend.

Invenio RDM Default Value

500

Type

int

Source

invenio-jobs


JOBS_LOGS_MAX_RESULTS

Maximum total number of log results to return in a single search request.

Invenio RDM Default Value

2000

Type

int

Source

invenio-jobs


JOBS_PERMISSION_POLICY

Permission policy for jobs.

Invenio RDM Default Value

JobPermissionPolicy

Type

unknown

Source

invenio-jobs


JOBS_QUEUES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-jobs

{'celery': {'description': l'Default queue', 'name': 'celery', 'title': l'Default'},
 'low': {'description': l'Low priority queue', 'name': 'low', 'title': l'Low'}}

JOBS_RUNS_PERMISSION_POLICY

Permission policy for job runs.

Invenio RDM Default Value

RunPermissionPolicy

Type

unknown

Source

invenio-jobs


JOBS_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-jobs

{'jobs': {'fields': ['jobs'], 'title': l'Jobs'},
 'last_run_start_time': {'fields': ['last_run_start_time'], 'title': l'Last run'},
 'next_run': {'fields': ['next_run'], 'title': l'Next run'},
 'user': {'fields': ['user'], 'title': l'Started by'}}

JOBS_TASKS_PERMISSION_POLICY

Permission policy for tasks.

Invenio RDM Default Value

TasksPermissionPolicy

Type

unknown

Source

invenio-jobs


JSONSCHEMAS_ENDPOINT

Default schema endpoint.

Invenio RDM Default Value

'/schemas'

Type

str

Source

invenio-jsonschemas


*JSONSCHEMAS_HOST

Default json schema host.

Invenio RDM Default Value

'localhost'

Type

str

Sources

invenio-jsonschemas; invenio-app-rdm

Set by

configure_generic_parameters()


JSONSCHEMAS_LOADER_CLS

Loader class used in JSONRef when replacing $ref.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-jsonschemas


JSONSCHEMAS_LOCAL_REFRESOLVER_URI_SCHEME

Non-standard URI scheme to reference local schemas.

Invenio RDM Default Value

'local://'

Type

str

Source

invenio-jsonschemas


JSONSCHEMAS_REGISTER_ENDPOINTS_API

Register the endpoints on the API app.

Invenio RDM Default Value

True

Type

bool

Sources

invenio-jsonschemas; invenio-app-rdm


JSONSCHEMAS_REGISTER_ENDPOINTS_UI

Register the endpoints on the UI app.

Invenio RDM Default Value

True

Type

bool

Sources

invenio-jsonschemas; invenio-app-rdm


JSONSCHEMAS_REPLACE_REFS

Whether to resolve $ref before serving a schema.

Invenio RDM Default Value

False

Type

bool

Source

invenio-jsonschemas


JSONSCHEMAS_RESOLVER_CLS

Resolver used to resolve the schema.

if invenio_jsonschemas.config.JSONSCHEMAS_RESOLVE_SCHEMA is True or there is ?resolved=1 parameter on the request the resolver will run over the schema. This can be used for custom schemas resolver.

Invenio RDM Default Value

'invenio_jsonschemas.utils.resolve_schema'

Type

str

Source

invenio-jsonschemas


JSONSCHEMAS_RESOLVE_SCHEMA

Whether to resolve schema using the Resolver Class.

If is True, will replace $ref and run the invenio_jsonschemas.config.JSONSCHEMAS_RESOLVER_CLS class before serving a schema.

Invenio RDM Default Value

False

Type

bool

Source

invenio-jsonschemas


JSONSCHEMAS_SCHEMAS

List of entrypoint names to register JSON Schemas for.

If None, all JSON Schemas defined through the invenio_jsonschemas.schemas entry point in setup.py will be registered. If [], no JSON Schemas will be registered.

For example, if you only want to register foo and skip bar schemas:

# in your `setup.py` you would specify:
entry_points={
    'invenio_jsonschemas.schemas': [
        'foo = invenio_foo.schemas',
        'bar = invenio_bar.schemas',
    ],
}
# and in your config.py
JSONSCHEMAS_SCHEMAS = ['foo']

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-jsonschemas


JSONSCHEMAS_URL_SCHEME

Default url scheme for schemas.

Invenio RDM Default Value

'https'

Type

str

Source

invenio-jsonschemas


LOGGING_CONSOLE

Enable logging to the console.

Invenio RDM Default Value

True

Type

bool

Source

invenio-logging


LOGGING_CONSOLE_LEVEL

Console logging level.

Set to a valid Python logging level: CRITICAL, ERROR, WARNING, INFO, DEBUG, or NOTSET.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-logging


LOGGING_CONSOLE_PYWARNINGS

Enable logging of Python warnings to the console.

By default, warnings are logged to the console if the application is in debug mode, otherwise warnings are not logged.

Invenio RDM Default Value

False

Type

bool

Source

invenio-logging


LOGGING_FS_BACKUPCOUNT

Number of rotated log files to keep.

Invenio RDM Default Value

5

Type

int

Source

invenio-logging


LOGGING_FS_LEVEL

Filesystem logging level.

Set to a valid Python logging level: CRITICAL, ERROR, WARNING, INFO, DEBUG, or NOTSET.

Invenio RDM Default Value

'WARNING'

Type

str

Source

invenio-logging


LOGGING_FS_LOGFILE

Enable logging to the filesystem.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-logging


LOGGING_FS_MAXBYTES

Maximum size of logging file. Default: 100MB.

Invenio RDM Default Value

104857600

Type

int

Source

invenio-logging


LOGGING_FS_PYWARNINGS

Enable logging of Python warnings to filesystem logging.

Invenio RDM Default Value

False

Type

bool

Source

invenio-logging


LOGGING_SENTRY_CELERY

Configure Celery to send logging to Sentry.

Invenio RDM Default Value

False

Type

bool

Source

invenio-logging


LOGGING_SENTRY_CLASS

Import path of sentry Flask extension class.

This allows you to customize the Sentry extension class.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-logging


LOGGING_SENTRY_INIT_KWARGS

Pass extra options when initializing Sentry instance.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-logging


LOGGING_SENTRY_LEVEL

Sentry logging level.

Defaults to only reporting errors and warnings.

Invenio RDM Default Value

'WARNING'

Type

str

Source

invenio-logging


LOGGING_SENTRY_PYWARNINGS

Enable logging of Python warnings to Sentry.

Invenio RDM Default Value

False

Type

bool

Source

invenio-logging


LOGGING_SENTRY_REDIS

Configure REDIS to send logging to Sentry.

Invenio RDM Default Value

False

Type

bool

Source

invenio-logging


LOGGING_SENTRY_SQLALCHEMY

Configure SQL Alchemy to send logging to Sentry.

Invenio RDM Default Value

False

Type

bool

Source

invenio-logging


MAIL_DEBUG

Default Value

False

Type

bool

Source

unknown


MAIL_DEFAULT_REPLY_TO

Reply to mail address for e-mails.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-mail


*MAIL_DEFAULT_SENDER

Email address used as sender of account registration emails.

SECURITY_EMAIL_SENDER will default to this value.

Invenio RDM Default Value

'info@inveniosoftware.org'

Type

unknown

Source

invenio-app-rdm

Set by

configure_generic_parameters()


MAIL_MAX_ATTACHMENT_SIZE

Max size of inline attachments, in bytes.

Invenio RDM Default Value

1000000

Type

int

Source

invenio-mail


MAIL_MAX_RETRIES

How often will we repeat if a problem occurred.

Invenio RDM Default Value

2

Type

int

Source

invenio-mail


MAIL_MIN_LOGGING_LEVEL

Minimum logging level for the mail logger.

Invenio RDM Default Value

40

Type

int

Source

invenio-mail


*MAIL_SUPPRESS_SEND

Disable email sending by default.

Invenio RDM Default Value

False

Type

bool

Source

invenio-app-rdm

Set by

configure_generic_parameters()


*MATOMO_ANALYTICS_SITE_ID

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


*MATOMO_ANALYTICS_TEMPLATE

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


*MATOMO_ANALYTICS_URL

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


MAX_CONTENT_LENGTH

Maximum allowed content length for form data.

This value limits the maximum file upload size via multipart-formdata and is a Flask configuration variable that by default is unlimited. The value must be larger than the maximum part size you want to accept via application/multipart-formdata (used by e.g. ng-file upload). This value only limits file upload size via application/multipart-formdata and in particular does not restrict the maximum file size possible when streaming a file in the body of a PUT request.

Flask, by default, saves any file bigger than 500kb to a temporary file on disk, thus do not set this value to large or you may run out of disk space on your nodes.

Invenio RDM Default Value

None

Type

NoneType

Sources

invenio-files-rest; invenio-app-rdm


MAX_FORM_MEMORY_SIZE

Default Value

500000

Type

int

Source

unknown


MAX_FORM_PARTS

Default Value

1000

Type

int

Source

unknown


MULTIPROFILER_BASE_TEMPLATE

Base template for the profiler page.

Invenio RDM Default Value

'flask_multiprofiler/index.html'

Type

unknown

Source

invenio-app-rdm


MULTIPROFILER_IGNORED_ENDPOINTS

Invenio RDM Default Value

<list>

Type

unknown

Source

invenio-app-rdm

[
    'static',
    '_debug_toolbar.static',
    'profiler\\..+',
    'invenio_formatter_badges.badge',
]

MULTIPROFILER_PERMISSION

Function to check for permissions to access the profiler.

Invenio RDM Default Value

administration_permission.can

Type

unknown

Source

invenio-app-rdm


NOTIFICATIONS_BACKENDS

Notification backends.

OARepo Default Value

<dict>

Type

dict

Sources

invenio-notifications; oarepo-requests; invenio-app-rdm

{'email': <invenio_notifications.backends.email.EmailNotificationBackend object at 0x7f4c7f5582d0>}

NOTIFICATIONS_BUILDERS

Notification builders.

OARepo Default Value

<dict>

Type

dict

Sources

invenio-notifications; oarepo-requests; invenio-app-rdm

{'comment-request-event.create': <class 'oarepo_requests.notifications.builders.comment.CommentRequestEventCreateNotificationBuilder'>,
 'comment-request-event.reply': <class 'invenio_requests.notifications.builders.CommentRequestEventReplyNotificationBuilder'>,
 'comment-subcommunity-invitation-request.create': <class 'invenio_communities.notifications.builders.SubComInvCommentNotificationBuilder'>,
 'comment-subcommunity-request.create': <class 'invenio_communities.notifications.builders.SubComReqCommentNotificationBuilder'>,
 'community-invitation.accept': <class 'invenio_communities.notifications.builders.CommunityInvitationAcceptNotificationBuilder'>,
 'community-invitation.cancel': <class 'invenio_communities.notifications.builders.CommunityInvitationCancelNotificationBuilder'>,
 'community-invitation.decline': <class 'invenio_communities.notifications.builders.CommunityInvitationDeclineNotificationBuilder'>,
 'community-invitation.expire': <class 'invenio_communities.notifications.builders.CommunityInvitationExpireNotificationBuilder'>,
 'community-invitation.submit': <class 'invenio_communities.notifications.builders.CommunityInvitationSubmittedNotificationBuilder'>,
 'community-membership-request.accept': <class 'invenio_communities.notifications.builders.CommunityMembershipRequestAcceptedNotificationBuilder'>,
 'community-membership-request.cancel': <class 'invenio_communities.notifications.builders.CommunityMembershipRequestCancelledNotificationBuilder'>,
 'community-membership-request.decline': <class 'invenio_communities.notifications.builders.CommunityMembershipRequestDeclinedNotificationBuilder'>,
 'community-membership-request.expire': <class 'invenio_communities.notifications.builders.CommunityMembershipRequestExpiredNotificationBuilder'>,
 'community-membership-request.submit': <class 'invenio_communities.notifications.builders.CommunityMembershipRequestSubmittedNotificationBuilder'>,
 'community-submission.accept': <class 'invenio_rdm_records.notifications.builders.CommunityInclusionAcceptNotificationBuilder'>,
 'community-submission.cancel': <class 'invenio_rdm_records.notifications.builders.CommunityInclusionCancelNotificationBuilder'>,
 'community-submission.decline': <class 'invenio_rdm_records.notifications.builders.CommunityInclusionDeclineNotificationBuilder'>,
 'community-submission.expire': <class 'invenio_rdm_records.notifications.builders.CommunityInclusionExpireNotificationBuilder'>,
 'community-submission.submit': <class 'invenio_rdm_records.notifications.builders.CommunityInclusionSubmittedNotificationBuilder'>,
 'delete-published-record-request-event.accept': <class 'oarepo_requests.notifications.builders.delete_published_record.DeletePublishedRecordRequestAcceptNotificationBuilder'>,
 'delete-published-record-request-event.decline': <class 'oarepo_requests.notifications.builders.delete_published_record.DeletePublishedRecordRequestDeclineNotificationBuilder'>,
 'delete-published-record-request-event.submit': <class 'oarepo_requests.notifications.builders.delete_published_record.DeletePublishedRecordRequestSubmitNotificationBuilder'>,
 'grant-user-access.create': <class 'invenio_rdm_records.notifications.builders.GrantUserAccessNotificationBuilder'>,
 'guest-access-request-token.create': <class 'invenio_rdm_records.notifications.builders.GuestAccessRequestTokenCreateNotificationBuilder'>,
 'guest-access-request.accept': <class 'invenio_rdm_records.notifications.builders.GuestAccessRequestAcceptNotificationBuilder'>,
 'guest-access-request.cancel': <class 'invenio_rdm_records.notifications.builders.GuestAccessRequestCancelNotificationBuilder'>,
 'guest-access-request.decline': <class 'invenio_rdm_records.notifications.builders.GuestAccessRequestDeclineNotificationBuilder'>,
 'guest-access-request.submit': <class 'invenio_rdm_records.notifications.builders.GuestAccessRequestSubmitNotificationBuilder'>,
 'guest-access-request.submitted': <class 'invenio_rdm_records.notifications.builders.GuestAccessRequestSubmittedNotificationBuilder'>,
 'publish-draft-request-event.accept': <class 'oarepo_requests.notifications.builders.publish.PublishDraftRequestAcceptNotificationBuilder'>,
 'publish-draft-request-event.decline': <class 'oarepo_requests.notifications.builders.publish.PublishDraftRequestDeclineNotificationBuilder'>,
 'publish-draft-request-event.submit': <class 'oarepo_requests.notifications.builders.publish.PublishDraftRequestSubmitNotificationBuilder'>,
 'record-deletion.accept': <class 'invenio_rdm_records.notifications.builders.RecordDeletionAcceptNotificationBuilder'>,
 'record-deletion.decline': <class 'invenio_rdm_records.notifications.builders.RecordDeletionDeclineNotificationBuilder'>,
 'subcommunity-invitation-request.accept': <class 'invenio_communities.notifications.builders.SubComInvitationAccept'>,
 'subcommunity-invitation-request.create': <class 'invenio_communities.notifications.builders.SubComInvitationCreate'>,
 'subcommunity-invitation-request.decline': <class 'invenio_communities.notifications.builders.SubComInvitationDecline'>,
 'subcommunity-invitation-request.expire': <class 'invenio_communities.notifications.builders.SubComInvitationExpire'>,
 'subcommunity-request.accept': <class 'invenio_communities.notifications.builders.SubCommunityAccept'>,
 'subcommunity-request.create': <class 'invenio_communities.notifications.builders.SubCommunityCreate'>,
 'subcommunity-request.decline': <class 'invenio_communities.notifications.builders.SubCommunityDecline'>,
 'user-access-request.accept': <class 'invenio_rdm_records.notifications.builders.UserAccessRequestAcceptNotificationBuilder'>,
 'user-access-request.cancel': <class 'invenio_rdm_records.notifications.builders.UserAccessRequestCancelNotificationBuilder'>,
 'user-access-request.decline': <class 'invenio_rdm_records.notifications.builders.UserAccessRequestDeclineNotificationBuilder'>,
 'user-access-request.submit': <class 'invenio_rdm_records.notifications.builders.UserAccessRequestSubmitNotificationBuilder'>}

NOTIFICATIONS_ENTITY_RESOLVERS

List of entity resolvers used by notification builders.

OARepo Default Value

<set>

Type

set

Sources

invenio-notifications; oarepo-requests; invenio-app-rdm

{<invenio_rdm_records.requests.entity_resolvers.RDMRecordServiceResultResolver object at 0x7f4c7ef54b90>,
 <invenio_records_resources.references.entity_resolvers.results.ServiceResultResolver object at 0x7f4c7ef80e50>,
 <invenio_records_resources.references.entity_resolvers.results.ServiceResultResolver object at 0x7f4c7efa8490>,
 <invenio_records_resources.references.entity_resolvers.results.ServiceResultResolver object at 0x7f4c7efa86b0>,
 <invenio_records_resources.references.entity_resolvers.results.ServiceResultResolver object at 0x7f4c9010d6d0>,
 <oarepo_requests.notifications.resolvers.MultipleEntitiesNotificationResolver object at 0x7f4c7ef496a0>}

NOTIFICATIONS_GROUP_EMAIL_DOMAIN

Domain suffix to append to group names when email is not provided.

When a recipient is a group and has no email or email_hidden field, the group’s name will be used as the email address with this domain appended.

Example:

NOTIFICATIONS_GROUP_EMAIL_DOMAIN = “cern.ch” # Group “physics-team” becomes “physics-team@cern.ch

Set to None to disable domain formatting (groups must have email field set).

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-notifications


NOTIFICATIONS_SETTINGS_VIEW_FUNCTION

View function for notification settings.

This should be set higher up in the module hierarchy (e.g. invenio-app-rdm), as this module does not have knowledge of the settings view.

Invenio RDM Default Value

None

Type

NoneType

Sources

invenio-notifications; invenio-app-rdm


NOTIFICATION_RECIPIENTS_RESOLVERS

Default Value

<dict>

Type

dict

Source

unknown

{'action_need': <function <lambda> at 0x7f4c7ca21640>,
 'group': <function <lambda> at 0x7f4c7c0ae820>,
 'multiple': <function <lambda> at 0x7f4c7c0ae980>,
 'user': <function <lambda> at 0x7f4c7c0ae6c0>}

OAISERVER_ADMIN_EMAILS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-oaiserver

['info@inveniosoftware.org']

OAISERVER_BASE_TEMPLATE

Default Value

'invenio_oaiserver/base.html'

Type

str

Source

unknown


OAISERVER_CACHE_KEY

Key prefix added before all keys in cache server.

Invenio RDM Default Value

'DynamicOAISets::'

Type

str

Source

invenio-oaiserver


OAISERVER_CELERY_TASK_CHUNK_SIZE

Specify the maximum number of records each task will update.

Invenio RDM Default Value

100

Type

int

Source

invenio-oaiserver


OAISERVER_COMPRESSIONS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-oaiserver

['identity']

OAISERVER_CONTROL_NUMBER_FETCHER

PIDStore fetcher for the OAI ID control number.

Invenio RDM Default Value

'recid'

Type

str

Source

invenio-oaiserver


OAISERVER_CREATED_KEY

Record created key.

Invenio RDM Default Value

'created'

Type

str

Sources

invenio-oaiserver; invenio-app-rdm


OAISERVER_DELETE_PERCOLATOR_FUNCTION

Invenio RDM Default Value

'invenio_oaiserver.percolator:_delete_percolator'

Type

str

Source

invenio-oaiserver


OAISERVER_DESCRIPTIONS

Specify the optional description containers that can be used to express properties of the repository that are not covered by the standard response to the Identify verb. For further information see: http://www.openarchives.org/OAI/2.0/guidelines.htm

The eprints, oai_identifier and friends description can be added using the helper functions in utils.py as follows:

from invenio_oaiserver.utils import eprints_description
from invenio_oaiserver.utils import friends_description
from invenio_oaiserver.utils import oai_identifier_description

OAISERVER_DESCRIPTIONS = [
    eprints_description(metadataPolicy, dataPolicy,
                        submissionPolicy, content),
    oai_identifier_description(scheme, repositoryIdentifier,
                               delimiter, sampleIdentifier),
    friends_description(baseUrls)
]

The parameters of each description element are strings if their type is unique or dictionaries, with the type being the key, if it can differ. E.g. the dataPolicy of the eprints element can consist of a text and or URL so it will have the form:

metadataPolicy = {'text': 'Metadata can be used by commercial'
                  'and non-commercial service providers',
                  'URL': 'http://arXiv.org/arXiv_metadata_use.htm'}

Whereas for the scheme of the oai_identifier it will just be:

scheme = 'oai'

If the parameter can take an arbitrary amount of elements it can be a list:

baseUrls = [http://oai.east.org/foo/,
            http://oai.hq.org/bar/,
            http://oai.south.org/repo.cgi]

Invenio RDM Default Value

<list>

Type

list

Source

invenio-oaiserver

[]

OAISERVER_GETRECORD_FETCHER

Record data fetcher for serialization.

Invenio RDM Default Value

'invenio_rdm_records.oai:getrecord_fetcher'

Type

str

Sources

invenio-oaiserver; invenio-app-rdm


OAISERVER_GRANULARITY

The finest harvesting granularity supported by the repository.

The legitimate values are YYYY-MM-DD and YYYY-MM-DDThh:mm:ssZ with meanings as defined in ISO8601.

Invenio RDM Default Value

'YYYY-MM-DDThh:mm:ssZ'

Type

str

Source

invenio-oaiserver


OAISERVER_ID_FETCHER

OAI ID fetcher function.

Invenio RDM Default Value

'invenio_rdm_records.oai:oaiid_fetcher'

Type

str

Sources

invenio-oaiserver; invenio-app-rdm


*OAISERVER_ID_PREFIX

The prefix that will be applied to the generated OAI-PMH ids.

If not set, one is autogenerated using the hostname of the machine with the format oai:<hostname>:recid/.

Invenio RDM Default Value

'oai:runnervmvrwv9:'

Type

str

Sources

invenio-oaiserver; invenio-app-rdm

Set by

configure_generic_parameters()


OAISERVER_LAST_UPDATE_KEY

Record update key.

Invenio RDM Default Value

'updated'

Type

str

Sources

invenio-oaiserver; invenio-app-rdm


OAISERVER_METADATA_FORMATS

OARepo Default Value

<oarepo_rdm.oai.config.OAIServerMetadataFormats object at 0x7f4c7ef48c20>

Type

OAIServerMetadataFormats

Sources

invenio-oaiserver; oarepo-rdm; invenio-app-rdm


OAISERVER_NEW_PERCOLATOR_FUNCTION

Invenio RDM Default Value

'invenio_oaiserver.percolator:_new_percolator'

Type

str

Source

invenio-oaiserver


OAISERVER_PAGE_SIZE

Define maximum length of list responses.

Request with verbs ListRecords, ListIdentifiers, and ListSets are affected by this option.

Invenio RDM Default Value

10

Type

int

Source

invenio-oaiserver


OAISERVER_PERCOLATOR_DEDICATED_INDEX

Create a dedicated index for the percolators, instead of storing them in the same index as the records.

Invenio RDM Default Value

True

Type

bool

Source

invenio-oaiserver


OAISERVER_PROTOCOL_VERSION

Invenio RDM Default Value

'2.0'

Type

str

Source

invenio-oaiserver


OAISERVER_QUERY_PARSER

Define query parser for OIASet definition.

Invenio RDM Default Value

invenio_search.engine.dsl.Q

Type

unknown

Source

invenio-oaiserver


OAISERVER_QUERY_PARSER_FIELDS

Define query parser search fields list for OIASet definition.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-oaiserver

[]

OAISERVER_RECORD_CLS

Record retrieval class.

Invenio RDM Default Value

'invenio_rdm_records.records.api:RDMRecord'

Type

str

Sources

invenio-oaiserver; invenio-app-rdm


OAISERVER_RECORD_INDEX

Specify a search index with records that should be exposed via OAI-PMH.

Invenio RDM Default Value

'oaisource'

Type

str

Sources

invenio-oaiserver; invenio-app-rdm


OAISERVER_RECORD_LIST_SETS_FETCHER

Record’s list OAI sets function.

Invenio RDM Default Value

'invenio_oaiserver.percolator:sets_search_all'

Type

str

Source

invenio-oaiserver


OAISERVER_RECORD_SETS_FETCHER

Record’s OAI sets function.

Invenio RDM Default Value

'invenio_oaiserver.percolator:find_sets_for_record'

Type

str

Sources

invenio-oaiserver; invenio-app-rdm


OAISERVER_REGISTER_RECORD_SIGNALS

Catch record/set insert/update/delete signals and update the _oai field.

Invenio RDM Default Value

True

Type

bool

Source

invenio-oaiserver


OAISERVER_REGISTER_SET_SIGNALS

Catch set insert/update/delete signals and update the _oai record field.

Invenio RDM Default Value

True

Type

bool

Source

invenio-oaiserver


*OAISERVER_REPOSITORY_NAME

Default Value

'Invenio-OAIServer'

Type

str

Source

unknown

Set by

configure_oai()


OAISERVER_RESUMPTION_TOKEN_EXPIRE_TIME

The expiration time of a resumption token in seconds.

Default: 60 seconds = 1 minute.

Note

Setting longer expiration time may have a negative impact on your search cluster as it might need to keep open cursors.

https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html

Invenio RDM Default Value

60

Type

int

Source

invenio-oaiserver


OAISERVER_SEARCH_CLS

Class for record search.

Invenio RDM Default Value

'invenio_rdm_records.oai:OAIRecordSearch'

Type

str

Sources

invenio-oaiserver; invenio-app-rdm


OAISERVER_SET_RECORDS_QUERY_FETCHER

Invenio RDM Default Value

'invenio_oaiserver.fetchers:set_records_query_fetcher'

Type

str

Source

invenio-oaiserver


OAISERVER_XSL_URL

Specify the url (relative or absolute) to the XML Stylesheet file to transform XML OAI 2.0 responses into XHTML.

The url can be a relative path to a local static file:

OAISERVER_XSL_URL = '/static/xsl/oai2.xsl'

or an absolute url to a remote file (be aware of CORS restrictions):

OAISERVER_XSL_URL = 'https//www.otherdomain.org/oai2.xsl'

You can obtain an already defined XSL Stylesheet for OAIS 2.0 on EPrints repository (GPLv3 licensed).

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-oaiserver


*OAREPO_CHECKS_DEFAULT_CHAT_EINFRA_CLIENT

Type

configured by function

Source

oarepo-config

Set by

configure_llm()


*OAREPO_CHECKS_DEFAULT_LLM_CLIENT

Type

configured by function

Source

oarepo-config

Set by

configure_llm()


*OAREPO_CHECKS_LLM_CLIENTS

Type

configured by function

Source

oarepo-config

Set by

configure_llm()


OAREPO_COMMUNITIES_DEFAULT_WORKFLOW

Default Value

'default'

Type

str

Source

unknown


OAREPO_MODELS

Default Value

<dict>

Type

dict

Source

unknown

{'affiliations': <oarepo_runtime.api.Model object at 0x7f4c7f9e2d50>,
 'awards': <oarepo_runtime.api.Model object at 0x7f4c7f7896e0>,
 'funders': <oarepo_runtime.api.Model object at 0x7f4c7f90a210>,
 'names': <oarepo_runtime.api.Model object at 0x7f4c7f789810>,
 'subjects': <oarepo_runtime.api.Model object at 0x7f4c7f7c04d0>,
 'vocabularies': <oarepo_runtime.api.Model object at 0x7f4c7f791e80>}

OAREPO_PERMISSIONS_PRESETS

Default Value

<dict>

Type

dict

Source

unknown

{'vocabularies': <class 'invenio_vocabularies.services.permissions.PermissionPolicy'>}

OAREPO_REQUESTS_DEFAULT_RECEIVER

Default Value

'oarepo_requests.receiver.default_workflow_receiver_function'

Type

str

Source

unknown


OAREPO_UI_JINJAX_FILTERS

OARepo Default Value

<dict>

Type

dict

Source

oarepo-ui

{'append_query_params': 'oarepo_ui.utils:append_query_params',
 'as_dict': 'oarepo_ui.templating.filters:as_dict',
 'compact_number': 'invenio_app_rdm.records_ui.views.filters:compact_number',
 'localize_number': 'invenio_app_rdm.records_ui.views.filters:localize_number',
 'localized': 'oarepo_ui.templating.filters:localized',
 'truncate_number': 'invenio_app_rdm.records_ui.views.filters:truncate_number',
 'ui_value': 'oarepo_ui.templating.filters:ui_value'}

OAREPO_UI_JINJAX_GLOBALS

OARepo Default Value

<dict>

Type

dict

Source

oarepo-ui

{'append_query_params': 'oarepo_ui.utils:append_query_params',
 'as_array': 'oarepo_ui.templating.filters:as_array',
 'as_dict': 'oarepo_ui.templating.filters:as_dict',
 'can_view_deposit_page': 'oarepo_ui.utils:can_view_deposit_page',
 'localized': 'oarepo_ui.templating.filters:localized',
 'ui_value': 'oarepo_ui.templating.filters:ui_value',
 'value': 'oarepo_ui.templating.filters:value'}

OAREPO_UI_LESS_COMPONENTS

Default Value

<list>

Type

list

Source

unknown

['dl_table', 'dl_table', 'dl_table', 'dl_table']

OAREPO_UI_MULTILINGUAL_FIELD_LANGUAGES

OARepo Default Value

<list>

Type

list

Source

oarepo-ui

[{'text': 'English', 'value': 'en'}, {'text': 'Czech', 'value': 'cs'}]

OAREPO_UI_OVERRIDES

Default Value

<set>

Type

set

Source

unknown

{UIComponentOverride(endpoint='invenio_communities.communities_requests',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.delete_published_record',
                     component=UIComponent(IconTypeDeletePublishedRecord <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.communities_requests',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.edit_published_record',
                     component=UIComponent(IconTypeEditPublishedRecord <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.user_dashboard_request_view',
                     overridable_id='RequestTypeLabel.layout.publish_draft',
                     component=UIComponent(LabelTypePublishDraft <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.user_dashboard_request_view',
                     overridable_id='RequestTypeLabel.layout.new_version',
                     component=UIComponent(LabelTypeNewVersion <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.user_dashboard_request_view',
                     overridable_id='RequestTypeLabel.layout.publish_new_version',
                     component=UIComponent(LabelTypePublishNewVersion <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.user_dashboard_request_view',
                     overridable_id='RequestTypeLabel.layout.publish_changed_metadata',
                     component=UIComponent(LabelTypePublishChangedMetadata <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.user_dashboard_request_view',
                     overridable_id='RequestTypeLabel.layout.delete_published_record',
                     component=UIComponent(LabelTypeDeletePublishedRecord <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.user_dashboard_request_view',
                     overridable_id='RequestTypeLabel.layout.edit_published_record',
                     component=UIComponent(LabelTypeEditPublishedRecord <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.user_dashboard_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_draft',
                     component=UIComponent(IconTypePublishDraft <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.user_dashboard_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.new_version',
                     component=UIComponent(IconTypeNewVersion <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.user_dashboard_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_new_version',
                     component=UIComponent(IconTypePublishNewVersion <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.user_dashboard_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_changed_metadata',
                     component=UIComponent(IconTypePublishChangedMetadata <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.user_dashboard_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.delete_published_record',
                     component=UIComponent(IconTypeDeletePublishedRecord <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.user_dashboard_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.edit_published_record',
                     component=UIComponent(IconTypeEditPublishedRecord <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_request_view',
                     overridable_id='RequestTypeLabel.layout.publish_draft',
                     component=UIComponent(LabelTypePublishDraft <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_request_view',
                     overridable_id='RequestTypeLabel.layout.new_version',
                     component=UIComponent(LabelTypeNewVersion <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_request_view',
                     overridable_id='RequestTypeLabel.layout.publish_new_version',
                     component=UIComponent(LabelTypePublishNewVersion <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_request_view',
                     overridable_id='RequestTypeLabel.layout.publish_changed_metadata',
                     component=UIComponent(LabelTypePublishChangedMetadata <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_request_view',
                     overridable_id='RequestTypeLabel.layout.delete_published_record',
                     component=UIComponent(LabelTypeDeletePublishedRecord <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_request_view',
                     overridable_id='RequestTypeLabel.layout.edit_published_record',
                     component=UIComponent(LabelTypeEditPublishedRecord <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_draft',
                     component=UIComponent(IconTypePublishDraft <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.new_version',
                     component=UIComponent(IconTypeNewVersion <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_new_version',
                     component=UIComponent(IconTypePublishNewVersion <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_changed_metadata',
                     component=UIComponent(IconTypePublishChangedMetadata <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.delete_published_record',
                     component=UIComponent(IconTypeDeletePublishedRecord <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.edit_published_record',
                     component=UIComponent(IconTypeEditPublishedRecord <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_invitation_view',
                     overridable_id='RequestTypeLabel.layout.publish_draft',
                     component=UIComponent(LabelTypePublishDraft <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_invitation_view',
                     overridable_id='RequestTypeLabel.layout.new_version',
                     component=UIComponent(LabelTypeNewVersion <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_invitation_view',
                     overridable_id='RequestTypeLabel.layout.publish_new_version',
                     component=UIComponent(LabelTypePublishNewVersion <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_invitation_view',
                     overridable_id='RequestTypeLabel.layout.publish_changed_metadata',
                     component=UIComponent(LabelTypePublishChangedMetadata <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_invitation_view',
                     overridable_id='RequestTypeLabel.layout.delete_published_record',
                     component=UIComponent(LabelTypeDeletePublishedRecord <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_invitation_view',
                     overridable_id='RequestTypeLabel.layout.edit_published_record',
                     component=UIComponent(LabelTypeEditPublishedRecord <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_invitation_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_draft',
                     component=UIComponent(IconTypePublishDraft <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_invitation_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.new_version',
                     component=UIComponent(IconTypeNewVersion <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_invitation_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_new_version',
                     component=UIComponent(IconTypePublishNewVersion <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_invitation_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_changed_metadata',
                     component=UIComponent(IconTypePublishChangedMetadata <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_invitation_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.delete_published_record',
                     component=UIComponent(IconTypeDeletePublishedRecord <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_invitation_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.edit_published_record',
                     component=UIComponent(IconTypeEditPublishedRecord <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_membership_request_view',
                     overridable_id='RequestTypeLabel.layout.publish_draft',
                     component=UIComponent(LabelTypePublishDraft <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_membership_request_view',
                     overridable_id='RequestTypeLabel.layout.new_version',
                     component=UIComponent(LabelTypeNewVersion <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_membership_request_view',
                     overridable_id='RequestTypeLabel.layout.publish_new_version',
                     component=UIComponent(LabelTypePublishNewVersion <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_membership_request_view',
                     overridable_id='RequestTypeLabel.layout.publish_changed_metadata',
                     component=UIComponent(LabelTypePublishChangedMetadata <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_membership_request_view',
                     overridable_id='RequestTypeLabel.layout.delete_published_record',
                     component=UIComponent(LabelTypeDeletePublishedRecord <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_membership_request_view',
                     overridable_id='RequestTypeLabel.layout.edit_published_record',
                     component=UIComponent(LabelTypeEditPublishedRecord <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_membership_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_draft',
                     component=UIComponent(IconTypePublishDraft <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_membership_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.new_version',
                     component=UIComponent(IconTypeNewVersion <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_membership_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_new_version',
                     component=UIComponent(IconTypePublishNewVersion <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_membership_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_changed_metadata',
                     component=UIComponent(IconTypePublishChangedMetadata <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_membership_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.delete_published_record',
                     component=UIComponent(IconTypeDeletePublishedRecord <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_requests.community_dashboard_membership_request_view',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.edit_published_record',
                     component=UIComponent(IconTypeEditPublishedRecord <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.uploads',
                     overridable_id='InvenioAppRdm.DashboardUploads.ResultsList.item',
                     component=UIComponent(DynamicResultsListItem <@js/oarepo_ui/search/DynamicResultsListItem>, UIComponentImportMode.DEFAULT import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.requests',
                     overridable_id='RequestTypeLabel.layout.edit_published_record',
                     component=UIComponent(LabelTypeEditPublishedRecord <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.requests',
                     overridable_id='RequestTypeLabel.layout.delete_published_record',
                     component=UIComponent(LabelTypeDeletePublishedRecord <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.requests',
                     overridable_id='RequestTypeLabel.layout.publish_changed_metadata',
                     component=UIComponent(LabelTypePublishChangedMetadata <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.requests',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_draft',
                     component=UIComponent(IconTypePublishDraft <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.requests',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.new_version',
                     component=UIComponent(IconTypeNewVersion <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.communities_requests',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_new_version',
                     component=UIComponent(IconTypePublishNewVersion <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.communities_requests',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_changed_metadata',
                     component=UIComponent(IconTypePublishChangedMetadata <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.communities_requests',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_draft',
                     component=UIComponent(IconTypePublishDraft <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.communities_requests',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.new_version',
                     component=UIComponent(IconTypeNewVersion <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.requests',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.delete_published_record',
                     component=UIComponent(IconTypeDeletePublishedRecord <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.requests',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_new_version',
                     component=UIComponent(IconTypePublishNewVersion <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.requests',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.publish_changed_metadata',
                     component=UIComponent(IconTypePublishChangedMetadata <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.requests',
                     overridable_id='InvenioRequests.RequestTypeIcon.layout.edit_published_record',
                     component=UIComponent(IconTypeEditPublishedRecord <@js/oarepo_requests/components/icons>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.communities_requests',
                     overridable_id='RequestTypeLabel.layout.publish_draft',
                     component=UIComponent(LabelTypePublishDraft <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.communities_requests',
                     overridable_id='RequestTypeLabel.layout.new_version',
                     component=UIComponent(LabelTypeNewVersion <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.communities_requests',
                     overridable_id='RequestTypeLabel.layout.publish_new_version',
                     component=UIComponent(LabelTypePublishNewVersion <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.communities_requests',
                     overridable_id='RequestTypeLabel.layout.publish_changed_metadata',
                     component=UIComponent(LabelTypePublishChangedMetadata <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.communities_requests',
                     overridable_id='RequestTypeLabel.layout.delete_published_record',
                     component=UIComponent(LabelTypeDeletePublishedRecord <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.communities_requests',
                     overridable_id='RequestTypeLabel.layout.edit_published_record',
                     component=UIComponent(LabelTypeEditPublishedRecord <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_search_ui.search',
                     overridable_id='InvenioAppRdm.Search.ResultsList.item',
                     component=UIComponent(DynamicResultsListItem <@js/oarepo_ui/search/DynamicResultsListItem>, UIComponentImportMode.DEFAULT import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm.index',
                     overridable_id='InvenioAppRDM.RecordsList.layout',
                     component=UIComponent(RecordsList <@js/oarepo_ui/search/RecordsList>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.requests',
                     overridable_id='RequestTypeLabel.layout.publish_new_version',
                     component=UIComponent(LabelTypePublishNewVersion <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.requests',
                     overridable_id='RequestTypeLabel.layout.new_version',
                     component=UIComponent(LabelTypeNewVersion <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_users.requests',
                     overridable_id='RequestTypeLabel.layout.publish_draft',
                     component=UIComponent(LabelTypePublishDraft <@js/oarepo_requests/components/labels>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_search_ui.search',
                     overridable_id='InvenioAppRdm.Search.SearchBar.element',
                     component=UIComponent(ClearableSearchbarElement <@js/oarepo_ui/search/ClearableSearchbarElement>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.members',
                     overridable_id='InvenioCommunities.CommunityMembersSearch.InvitationsResultsContainer.InvitationsModal.container',
                     component=UIComponent(CommunityInvitationsModal <@js/oarepo_communities/components/CommunityInvitationsModal>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.members',
                     overridable_id='InvenioCommunities.CommunityMembersSearch.InvitationsEmptyResults.InvitationsModal.container',
                     component=UIComponent(CommunityInvitationsModal <@js/oarepo_communities/components/CommunityInvitationsModal>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.invitations',
                     overridable_id='InvenioCommunities.CommunityMembersSearch.InvitationsEmptyResults.InvitationsModal.container',
                     component=UIComponent(CommunityInvitationsModal <@js/oarepo_communities/components/CommunityInvitationsModal>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.invitations',
                     overridable_id='InvenioCommunities.CommunityMembersSearch.ManagerMembersResultsContainer.InvitationsModal.container',
                     component=UIComponent(CommunityInvitationsModal <@js/oarepo_communities/components/CommunityInvitationsModal>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_communities.communities_detail',
                     overridable_id='InvenioCommunities.DetailsSearch.SearchBar.element',
                     component=UIComponent(ClearableSearchbarElement <@js/oarepo_ui/search/ClearableSearchbarElement>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.communities_settings',
                     overridable_id='InvenioCommunities.CommunityProfileForm.GridRow.DangerZone',
                     component=UIComponent(Disabled <@js/oarepo_ui/components/Disabled>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.invitations',
                     overridable_id='InvenioCommunities.CommunityMembersSearch.ManagerSearchLayout.InvitationsModal.container',
                     component=UIComponent(CommunityInvitationsModal <@js/oarepo_communities/components/CommunityInvitationsModal>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.invitations',
                     overridable_id='InvenioCommunities.CommunityMembersSearch.InvitationsResultsContainer.InvitationsModal.container',
                     component=UIComponent(CommunityInvitationsModal <@js/oarepo_communities/components/CommunityInvitationsModal>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.members',
                     overridable_id='InvenioCommunities.CommunityMembersSearch.InvitationsSearchLayout.InvitationsModal.container',
                     component=UIComponent(CommunityInvitationsModal <@js/oarepo_communities/components/CommunityInvitationsModal>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.members',
                     overridable_id='InvenioCommunities.CommunityMembersSearch.ManagerSearchLayout.InvitationsModal.container',
                     component=UIComponent(CommunityInvitationsModal <@js/oarepo_communities/components/CommunityInvitationsModal>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.invitations',
                     overridable_id='InvenioCommunities.CommunityMembersSearch.InvitationsSearchLayout.InvitationsModal.container',
                     component=UIComponent(CommunityInvitationsModal <@js/oarepo_communities/components/CommunityInvitationsModal>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.members',
                     overridable_id='InvenioCommunities.CommunityMembersSearch.ManagerEmptyResults.InvitationsModal.container',
                     component=UIComponent(CommunityInvitationsModal <@js/oarepo_communities/components/CommunityInvitationsModal>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_app_rdm_communities.communities_detail',
                     overridable_id='InvenioCommunities.DetailsSearch.ResultsList.item',
                     component=UIComponent(DynamicResultsListItem <@js/oarepo_ui/search/DynamicResultsListItem>, UIComponentImportMode.DEFAULT import)>)),
 UIComponentOverride(endpoint='invenio_communities.invitations',
                     overridable_id='InvenioCommunities.CommunityMembersSearch.ManagerEmptyResults.InvitationsModal.container',
                     component=UIComponent(CommunityInvitationsModal <@js/oarepo_communities/components/CommunityInvitationsModal>, UIComponentImportMode.NAMED import)>)),
 UIComponentOverride(endpoint='invenio_communities.members',
                     overridable_id='InvenioCommunities.CommunityMembersSearch.ManagerMembersResultsContainer.InvitationsModal.container',
                     component=UIComponent(CommunityInvitationsModal <@js/oarepo_communities/components/CommunityInvitationsModal>, UIComponentImportMode.NAMED import)>))}

OAREPO_UI_RECORD_ACTIONS

OARepo Default Value

<set>

Type

set

Source

oarepo-ui

{'create',
 'delete',
 'delete_draft',
 'draft_read_deleted_files',
 'draft_read_files',
 'draft_update_files',
 'edit',
 'manage',
 'manage_files',
 'manage_record_access',
 'media_read_files',
 'moderate',
 'new_version',
 'publish',
 'read',
 'read_deleted_files',
 'read_draft',
 'read_files',
 'review',
 'search',
 'update',
 'update_draft',
 'update_files',
 'view'}

OAREPO_UI_RESULT_LIST_ITEM_REGISTRATION_CALLBACKS

Default Value

<list>

Type

list

Source

unknown

[<function _register_main_search_result_item at 0x7f4c878ffb60>,
 <function _register_home_page_search_result_item at 0x7f4c7c994720>,
 <function _register_community_uploads_result_item at 0x7f4c77ea8930>,
 <function _register_dashboard_uploads_result_item at 0x7f4c77eece00>]

OAREPO_VOCABULARIES_PERMISSIONS_PRESETS

OARepo Default Value

<dict>

Type

dict

Source

oarepo-vocabularies

{'vocabularies': <class 'invenio_vocabularies.services.permissions.PermissionPolicy'>}

OAREPO_VOCABULARIES_SORT_CF

Default Value

<list>

Type

list

Source

unknown

[]

OAREPO_VOCABULARIES_SUGGEST_CF

Default Value

<list>

Type

list

Source

unknown

[]

OAREPO_VOCABULARIES_UI_RESOURCE

Default Value

'oarepo_vocabularies.ui.resources.resource:InvenioVocabulariesUIResource'

Type

str

Source

unknown


OAREPO_VOCABULARIES_UI_RESOURCE_CONFIG

Default Value

'oarepo_vocabularies.ui.resources.config:InvenioVocabulariesUIResourceConfig'

Type

str

Source

unknown


OAREPO_VOCABULARY_TYPE_RESOURCE

OARepo Default Value

VocabularyTypeResource

Type

unknown

Source

oarepo-vocabularies


OAREPO_VOCABULARY_TYPE_RESOURCE_CONFIG

OARepo Default Value

VocabularyTypeResourceConfig

Type

unknown

Source

oarepo-vocabularies


OAREPO_VOCABULARY_TYPE_SERVICE

OARepo Default Value

VocabularyTypeService

Type

unknown

Source

oarepo-vocabularies


OAREPO_VOCABULARY_TYPE_SERVICE_CONFIG

OARepo Default Value

VocabularyTypeServiceConfig

Type

unknown

Source

oarepo-vocabularies


OAUTH2SERVER_ALLOWED_GRANT_TYPES

Invenio RDM Default Value

<set>

Type

set

Source

invenio-oauth2server

{'refresh_token', 'authorization_code', 'client_credentials'}

OAUTH2SERVER_ALLOWED_RESPONSE_TYPES

Invenio RDM Default Value

<set>

Type

set

Source

invenio-oauth2server

{'code', 'token'}

OAUTH2SERVER_ALLOWED_URLENCODE_CHARACTERS

A string of special characters that should be valid inside a query string.

See also

See monkeypatch_oauthlib_urlencode_chars for a full explanation.

Invenio RDM Default Value

'=&;:%+~,*@!()/?'

Type

str

Source

invenio-oauth2server


OAUTH2SERVER_BASE_TEMPLATE

Default Value

'invenio_oauth2server/base.html'

Type

str

Source

unknown


OAUTH2SERVER_CLIENT_ID_SALT_LEN

Length of client id.

Invenio RDM Default Value

40

Type

int

Source

invenio-oauth2server


OAUTH2SERVER_CLIENT_SECRET_SALT_LEN

Length of the client secret.

Invenio RDM Default Value

60

Type

int

Source

invenio-oauth2server


OAUTH2SERVER_COVER_TEMPLATE

Default Value

'invenio_oauth2server/base.html'

Type

str

Source

unknown


OAUTH2SERVER_JWT_AUTH_HEADER

Header for the JWT.

Note

Authorization: Bearer xxx

Invenio RDM Default Value

'Authorization'

Type

str

Source

invenio-oauth2server


OAUTH2SERVER_JWT_AUTH_HEADER_TYPE

Header Authorization type.

Note

By default the authorization type is Bearer as recommented by JWT

Invenio RDM Default Value

'Bearer'

Type

str

Source

invenio-oauth2server


OAUTH2SERVER_JWT_VERIFICATION_FACTORY

Import path of factory used to verify JWT.

The request.headers should be passed as parameter.

Invenio RDM Default Value

'invenio_oauth2server.utils:jwt_verify_token'

Type

str

Source

invenio-oauth2server


OAUTH2SERVER_SETTINGS_TEMPLATE

Default Value

'invenio_oauth2server/settings/base.html'

Type

str

Source

unknown


OAUTH2SERVER_TOKEN_PERSONAL_SALT_LEN

Length of the personal access token.

Invenio RDM Default Value

60

Type

int

Source

invenio-oauth2server


OAUTH2_CACHE_TYPE

Type of cache to use for storing the temporary grant token.

Invenio RDM Default Value

'redis'

Type

str

Source

invenio-oauth2server


OAUTH2_PROVIDER_ERROR_ENDPOINT

Error view endpoint.

Invenio RDM Default Value

'invenio_oauth2server.errors'

Type

str

Source

invenio-oauth2server


*OAUTHCLIENT_AUTO_REDIRECT_TO_EXTERNAL_LOGIN

Redirect to the only external login service under specific conditions.

If this option is enabled and there is exactly one external authentication service enabled (i.e. one OAuthClient remote app is configured, and local login is disabled), the login view function will automatically redirect to that external authentication service.

Invenio RDM Default Value

False

Type

bool

Source

invenio-oauthclient

Set by

configure_generic_parameters()


OAUTHCLIENT_BASE_TEMPLATE

Default Value

'invenio_theme/page.html'

Type

str

Source

unknown


OAUTHCLIENT_COVER_TEMPLATE

Default Value

'invenio_theme/page_cover.html'

Type

str

Source

unknown


OAUTHCLIENT_LOGIN_USER_TEMPLATE_PARENT

Default Value

'invenio_accounts/login_user.html'

Type

str

Source

unknown


*OAUTHCLIENT_REMOTE_APPS

Configuration of remote applications.

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-oauthclient

Set by

configure_generic_parameters(), configure_einfra_oidc()

{}

OAUTHCLIENT_REST_DEFAULT_ERROR_REDIRECT_URL

Configuration of default error redirect URL.

Invenio RDM Default Value

'/'

Type

str

Source

invenio-oauthclient


OAUTHCLIENT_REST_DEFAULT_RESPONSE_HANDLER

Default REST response handler.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-oauthclient


OAUTHCLIENT_REST_REMOTE_APPS

Configuration of remote rest applications.

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-oauthclient

{}

OAUTHCLIENT_SESSION_KEY_PREFIX

Session key prefix used when storing the access token for a remote app.

Invenio RDM Default Value

'oauth_token'

Type

str

Source

invenio-oauthclient


OAUTHCLIENT_SETTINGS_TEMPLATE

Default Value

'invenio_theme/page_settings.html'

Type

str

Source

unknown


OAUTHCLIENT_SIGNUP_FORM

Function called to render the sign up form after authorization succeeded.

Invenio RDM Default Value

_create_registrationform

Type

unknown

Source

invenio-oauthclient


OAUTHCLIENT_SIGNUP_TEMPLATE

Template for the signup page.

Invenio RDM Default Value

'invenio_oauthclient/signup.html'

Type

str

Source

invenio-oauthclient


OAUTHCLIENT_SITENAME

Default Value

l'Invenio'

Type

LazyString

Source

unknown


OAUTHCLIENT_STATE_ENABLED

Internal variable used to disable state validation during tests.

Invenio RDM Default Value

True

Type

bool

Source

invenio-oauthclient


OAUTHCLIENT_STATE_EXPIRES

Number of seconds after which the state token expires.

Invenio RDM Default Value

300

Type

int

Source

invenio-oauthclient


OAUTHCLIENT_TOKEN_EXPIRES_LEEWAY

The number of seconds before the actual expiration of an access token from which it is considered expired.

This ensures that it won’t cause issues if some time passes between the check for whether the token is expired and any requests that the token is then used in.

Invenio RDM Default Value

10

Type

int

Source

invenio-oauthclient


ORCID_PUBLIC_DUMP_S3_BUCKET_NAME

OARepo Default Value

'v3.0-summaries'

Type

str

Source

oarepo-related-resources


PAGES_ALLOWED_EXTRA_HTML_ATTRS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-pages

{'button': ['type', 'name', 'value', 'disabled', 'onclick'],
 'img': ['src', 'alt', 'title', 'width', 'height', 'loading']}

PAGES_ALLOWED_EXTRA_HTML_TAGS

Extend allowed HTML tags list for static pages content.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-pages

['img', 'button']

PAGES_BASE_TEMPLATE

Default Value

'invenio_pages/base.html'

Type

str

Source

unknown


PAGES_DEFAULT_TEMPLATE

Default template to render.

Invenio RDM Default Value

'invenio_pages/default.html'

Type

str

Sources

invenio-pages; invenio-app-rdm


PAGES_FACETS

Available facets defined for this module.

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-pages

{}

PAGES_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-pages

{'created': {'fields': ['created'], 'title': l'Created'},
 'title': {'fields': ['title'], 'title': l'Title'},
 'updated': {'fields': ['updated'], 'title': l'Updated'},
 'url': {'fields': ['url'], 'title': l'URL'}}

PAGES_TEMPLATES

Invenio RDM Default Value

<list>

Type

list

Sources

invenio-pages; invenio-app-rdm

[('invenio_pages/default.html', 'Default'),
 ('invenio_pages/dynamic.html', 'Default dynamic')]

PAGES_WHITELIST_CONFIG_KEYS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-pages

['THEME_SITENAME']

PERMANENT_SESSION_LIFETIME

Default Value

datetime.timedelta(days=31)

Type

timedelta

Source

unknown


PIDSTORE_APP_LOGGER_HANDLERS

Default Value

False

Type

bool

Source

unknown


PIDSTORE_DATACITE_DOI_PREFIX

Provide a DOI prefix here.

Invenio RDM Default Value

''

Type

str

Source

invenio-pidstore


PIDSTORE_OBJECT_ENDPOINTS

Default Value

<dict>

Type

dict

Source

unknown

{'rec': 'recordmetadata.details_view'}

PIDSTORE_RECID_FIELD

Default record id field inside the json data.

This name will be used by the fetcher, to retrieve the record ID value from the JSON, and by the minter, to store it inside the JSON.

Invenio RDM Default Value

'control_number'

Type

str

Source

invenio-pidstore


PIDSTORE_RECORDID_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-pidstore

{'checksum': True, 'length': 10, 'split_every': 5}

PREFERRED_URL_SCHEME

Default Value

'http'

Type

str

Source

unknown


PREVIEWABLE_ZIP_PREVIEWER_NATIVE_EXTENSIONS

Extensions for previewable zip.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-app-rdm

['zip']

PREVIEWER_ABSTRACT_TEMPLATE

Parent template used by the available previewers.

Invenio RDM Default Value

'invenio_previewer/abstract_previewer.html'

Type

str

Sources

invenio-previewer; invenio-app-rdm


PREVIEWER_BASE_CSS_BUNDLES

Basic bundle which includes Font-Awesome/Bootstrap.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-previewer

['previewer_theme.css']

PREVIEWER_BASE_JS_BUNDLES

Basic bundle which includes Bootstrap/jQuery.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-previewer

['previewer_theme.js']

PREVIEWER_BASE_TEMPLATE

Default Value

'invenio_previewer/base.html'

Type

str

Source

unknown


PREVIEWER_CHARDET_BYTES

Number of bytes to read for character encoding detection by cchardet.

Invenio RDM Default Value

1024

Type

int

Source

invenio-previewer


PREVIEWER_CHARDET_CONFIDENCE

Confidence threshold for character encoding detection by cchardet.

Invenio RDM Default Value

0.9

Type

float

Source

invenio-previewer


PREVIEWER_CONTAINER_ITEM_PREFERENCE

Invenio RDM Default Value

<list>

Type

list

Source

invenio-app-rdm

['csv_papaparsejs',
 'pdfjs',
 'simple_image',
 'json_prismjs',
 'xml_prismjs',
 'mistune',
 'video_videojs',
 'audio_videojs',
 'ipynb',
 'zip',
 'txt']

PREVIEWER_CSV_MAX_BYTES

Maximum file size in bytes for CSV files.

Invenio RDM Default Value

104857600

Type

int

Source

invenio-previewer


PREVIEWER_CSV_SNIFFER_ALLOWED_DELIMITERS

Allowed delimiter characters passed to the csv.Sniffer.sniff method.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-previewer


PREVIEWER_CSV_VALIDATION_BYTES

Number of bytes read by CSV previewer to validate the file.

Invenio RDM Default Value

1024

Type

int

Source

invenio-previewer


PREVIEWER_MAX_FILE_SIZE_BYTES

Maximum file size in bytes for JSON/XML files.

Invenio RDM Default Value

1048576

Type

int

Source

invenio-previewer


PREVIEWER_MAX_IMAGE_SIZE_BYTES

Maximum file size in bytes for image files.

Invenio RDM Default Value

524288.0

Type

float

Source

invenio-previewer


PREVIEWER_PDF_JS_DOCUMENT_INIT_PARAMS

Additional DocumentInitParameters passed to pdfjsLib.getDocument().

See https://mozilla.github.io/pdf.js/api/draft/module-pdfjsLib.html for the full list of available options.

Example (disable range requests, streaming, and auto-fetching):

PREVIEWER_PDF_JS_DOCUMENT_INIT_PARAMS = {
    "disableStream": True,
    "disableRange": True,
    "disableAutoFetch": True,
}

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-previewer


PREVIEWER_PDF_JS_ENABLE_SCRIPTING

Enable JavaScript execution in PDF files (disabled by default for security).

Invenio RDM Default Value

False

Type

bool

Source

invenio-previewer


PREVIEWER_PREFERENCE

Invenio RDM Default Value

<list>

Type

list

Sources

invenio-previewer; invenio-app-rdm

['csv_papaparsejs',
 'pdfjs',
 'iiif_simple',
 'simple_image',
 'json_prismjs',
 'xml_prismjs',
 'mistune',
 'video_videojs',
 'audio_videojs',
 'ipynb',
 'previewable_zip',
 'txt']

PREVIEWER_RECORD_FILE_FACOTRY

Factory for extracting files from records.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-previewer


PREVIEWER_TXT_MAX_BYTES

Maximum number of .txt file bytes to preview before truncated.

Invenio RDM Default Value

1048576

Type

int

Source

invenio-previewer


PREVIEWER_WEB_ARCHIVE_RANGE_REQUESTS

Whether the file server supports range requests or not.

Invenio RDM Default Value

False

Type

bool

Source

invenio-previewer


PREVIEWER_ZIP_MAX_FILES

Max number of files showed in the ZIP previewer.

Invenio RDM Default Value

1000

Type

int

Source

invenio-previewer


PROPAGATE_EXCEPTIONS

Default Value

None

Type

NoneType

Source

unknown


PROVIDE_AUTOMATIC_OPTIONS

Default Value

True

Type

bool

Source

unknown


PUBLISH_REQUEST_TYPES

Default Value

<list>

Type

list

Source

unknown

['publish_draft', 'publish_new_version']

QUEUES_BROKER_URL

Broker URL for queues.

If the variable is not configured it falls back to the default BROKER_URL of our application. For more information about how to define your broker here: https://kombu.readthedocs.io/en/latest/reference/kombu.connection.html#connection

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-queues


QUEUES_CONNECTION_POOL

Default queues connection pool.

Invenio RDM Default Value

get_connection_pool

Type

unknown

Source

invenio-queues


QUEUES_DEFINITIONS

Static queue definitions.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-queues

[]

RATELIMIT_APPLICATION

Global rate limit.

Invenio RDM Default Value

set_rate_limit

Type

unknown

Source

invenio-app


*RATELIMIT_AUTHENTICATED_USER

Rate limit for logged in users.

Invenio RDM Default Value

'5000 per hour;100 per minute'

Type

str

Sources

invenio-app; invenio-app-rdm

Set by

configure_generic_parameters()


RATELIMIT_ENABLED

Default Value

True

Type

bool

Source

unknown


*RATELIMIT_GUEST_USER

Rate limit for non logged in users.

Invenio RDM Default Value

'1000 per hour;60 per minute'

Type

str

Sources

invenio-app; invenio-app-rdm

Set by

configure_generic_parameters()


RATELIMIT_HEADERS_ENABLED

Enable rate limit headers. (Default: True)

Invenio RDM Default Value

True

Type

bool

Source

invenio-app


RATELIMIT_KEY_FUNC

Define custom key function.

This config is not part of Flask-Limiter.

This function is used to generate a unique key for each visitor to track the number of performed requests. If not defined, the default key_func will be used, which will create the key by concatenating the user agent and the IP address of the user.

For more information you can also see here

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-app


RATELIMIT_PER_ENDPOINT

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app

{'security.forgot_password': '10 per minute',
 'security.login': '10 per minute',
 'security.register': '10 per minute',
 'security.reset_password': '10 per minute'}

RATELIMIT_STORAGE_URI

Storage backend to store rate-limiting information.

Memory is used by default if no value is provided. For more information regarding the mentioned above configuration values and their available options you can see the Flask-Limiter configuration.

Note

Provide your Redis URL if you are rate limiting a multithreaded application.

Invenio RDM Default Value

'memory://'

Type

str

Sources

invenio-app; invenio-app-rdm


RATELIMIT_STRATEGY

The rate limiting strategy to use.

The strategy used here is the most consistant but also expensive one. If you are experiencing performance issues due to the increased Redis traffic, you can replace it with another one from the following Flask-Limiter strategies.

Invenio RDM Default Value

'moving-window'

Type

str

Source

invenio-app


RDM_ALLOW_EXTERNAL_DOI_VERSIONING

Allow records with external DOIs to be versioned.

Invenio RDM Default Value

True

Type

bool

Source

invenio-rdm-records


*RDM_ALLOW_METADATA_ONLY_RECORDS

Allow users to publish metadata-only records.

Invenio RDM Default Value

True

Type

bool

Source

invenio-rdm-records

Set by

configure_files()


RDM_ALLOW_OWNERS_REMOVE_COMMUNITY_FROM_RECORD

Allow record owners to remove communities from records.

When set to False, only community curators, managers, and owners can remove communities from records. This applies to published records. Record owners will still be able to add communities, but removal is restricted to community curators, managers, and owners.

Default: True (backwards compatible - owners can remove communities)

Invenio RDM Default Value

True

Type

bool

Source

invenio-rdm-records


RDM_ALLOW_RESTRICTED_RECORDS

Allow users to set restricted/private records.

Invenio RDM Default Value

True

Type

bool

Source

invenio-rdm-records


RDM_ARCHIVE_DOWNLOAD_ENABLED

Flag to enable/disable the all-in-one download endpoint.

Invenio RDM Default Value

True

Type

bool

Source

invenio-rdm-records


RDM_CITATION_STYLES

Invenio RDM Default Value

<list>

Type

list

Source

invenio-app-rdm

[('apa', 'APA'),
 ('harvard-cite-them-right', 'Harvard'),
 ('modern-language-association', 'MLA'),
 ('vancouver', 'Vancouver'),
 ('chicago-fullnote-bibliography', 'Chicago'),
 ('ieee', 'IEEE'),
 ('iso690-author-date-cs', l'ČSN ISO 690')]

RDM_CITATION_STYLES_DEFAULT

Default citation style

Invenio RDM Default Value

'iso690-author-date-cs'

Type

str

Source

invenio-app-rdm


RDM_COMMUNITIES_ROUTES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app-rdm

{'community-browse': '/communities/<pid_value>/browse',
 'community-collection': '/communities/<pid_value>/collections/<tree_slug>/<collection_slug>',
 'community-detail': '/communities/<pid_value>/records',
 'community-home': '/communities/<pid_value>/',
 'community-static-page': '/communities/<pid_value>/pages/<path:page_slug>'}

RDM_COMMUNITY_CONTENT_MODERATION_HANDLERS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[<invenio_rdm_records.services.communities.moderation.UserModerationHandler object at 0x7f4c7fec2270>]

RDM_COMMUNITY_INCLUSION_REQUEST_CLS

Request type for record inclusion requests.

Invenio RDM Default Value

CommunityInclusion

Type

unknown

Source

invenio-rdm-records


RDM_COMMUNITY_REQUIRED_TO_PUBLISH

Enforces at least one community per record.

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


RDM_COMMUNITY_SUBMISSION_REQUEST_CLS

Request type for community submission requests.

OARepo Default Value

CommunitySubmission

Type

unknown

Sources

oarepo-communities; invenio-rdm-records


RDM_CONTENT_MODERATION_HANDLERS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[<invenio_rdm_records.services.components.verified.UserModerationHandler object at 0x7f4c7fec2120>]

RDM_CUSTOM_FIELDS

Records custom fields definition.

[<custom-field-class-type>, <custom-field-class-type>, ...]

For example:

[TextCF(name="experiment"), ...]

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[]

RDM_CUSTOM_FIELDS_UI

Upload form custom fields UI configuration.

Of the shape:

[{
    section: <section_name>,
    fields: [
        {
            field: "path-to-field",  # this should be validated against the defined fields in `RDM_CUSTOM_FIELDS`
            ui_widget: "<ui-widget-name>",  # predefined or user defined ui widget
            props: {
                label:"<ui-label-to-display>",
                placeholder:"<placeholder-passed-to-widget>",
                icon:"<icon-passed-to-widget>",
                description:"<description-passed-to-widget>",
            }
        },
    ],

    # ...
}]

For example:

[{
    "section": "CERN Experiment"
    "fields" : [{
        field: "experiment",  # this should be validated against the defined fields in `RDM_CUSTOM_FIELDS`
        ui_widget: "CustomTextField",  # user defined widget in my-site
        props: {
            label: "Experiment",
            placeholder: "Type an experiment...",
            icon: "pencil",
            description: "You should fill this field with one of the experiments e.g LHC, ATLAS etc.",
        }
    },
    ...
}]

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[]

RDM_DATACITE_DUMP_OPENAIRE_ACCESS_RIGHTS

Flag to control dumping DataCite OpenAIRE access rights.

See https://guidelines.openaire.eu/en/latest/data/field_rights.html for further information on how the OpenAIRE Guidelines expect access rights to be exposed via the DataCite schema.

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


RDM_DATACITE_FUNDER_IDENTIFIERS_PRIORITY

Priority of funder identifiers types to be used for DataCite serialization.

Invenio RDM Default Value

<tuple>

Type

tuple

Source

invenio-rdm-records

('ror', 'doi', 'grid', 'isni', 'gnd')

RDM_DEFAULT_FILES_ENABLED

Deposit page files enabled value on new records.

Invenio RDM Default Value

True

Type

bool

Source

invenio-rdm-records


RDM_DETAIL_SIDE_BAR_MANAGE_ATTRIBUTES_EXTENSION_TEMPLATE

Side bar manage attributes extension template.

Invenio RDM Default Value

None

Type

unknown

Source

invenio-app-rdm


RDM_FACETS

OARepo Default Value

<dict>

Type

unknown

Sources

invenio-rdm-records; oarepo-rdm

{
    'access_status': {
        'facet': facets.access_status,
        'ui': {
            'field': 'access.status',
        },
    },
    'is_published': {
        'facet': facets.is_published,
        'ui': {
            'field': 'is_published',
        },
    },
    'file_type': {
        'facet': facets.filetype,
        'ui': {
            'field': 'files.types',
        },
    },
    'language': {
        'facet': facets.language,
        'ui': {
            'field': 'languages',
        },
    },
    'resource_type': {
        'facet': facets.resource_type,
        'ui': {
            'field': 'resource_type.type',
            'childAgg': {
                'field': 'resource_type.subtype',
            },
        },
    },
    'subject': {
        'facet': facets.subject,
        'ui': {
            'field': 'subjects.subject',
        },
    },
    'subject_nested': {
        'facet': facets.subject_nested,
        'ui': {
            'field': 'subjects.scheme',
            'childAgg': {
                'field': 'subjects.subject',
            },
        },
    },
    'subject_combined': {
        'facet': facets.subject_combined,
        'ui': {
            'field': 'subjects.scheme',
            'childAgg': {
                'field': 'subjects.subject',
            },
        },
    },
    'publication_date': {
        'facet': facets.publication_date,
        'ui': {
            'field': 'publication_date',
            'type': 'date',
            'separator': '..',
        },
    },
}

RDM_FILES_DEFAULT_MAX_ADDITIONAL_QUOTA_SIZE

Default additional quota size for a bucket in bytes for files.

Invenio RDM Default Value

0

Type

int

Source

invenio-rdm-records


*RDM_FILES_DEFAULT_MAX_FILE_SIZE

Default maximum file size for a bucket in bytes for files.

Invenio RDM Default Value

10000000000

Type

int

Source

invenio-rdm-records

Set by

configure_files()


*RDM_FILES_DEFAULT_QUOTA_SIZE

Default size for a bucket in bytes for files.

Invenio RDM Default Value

10000000000

Type

int

Source

invenio-rdm-records

Set by

configure_files()


RDM_FILE_MODIFICATION_PERIOD

Time period after creation during which modified files can be published. 30 + 30 denotes grace period + extra days for file modification. This is checked during publish to block people from publishing after this period given the bucket stays open.

Invenio RDM Default Value

datetime.timedelta(days=45)

Type

timedelta

Source

invenio-rdm-records


RDM_FILE_MODIFICATION_POLICY

Policy class which evaluates whether published files can be modified by a user.

Invenio RDM Default Value

FileModificationPolicyEvaluator

Type

unknown

Source

invenio-rdm-records


RDM_IIIF_MANIFEST_FORMATS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

['gif', 'jp2', 'jpeg', 'jpg', 'png', 'tif', 'tiff']

RDM_IMMEDIATE_FILE_MODIFICATION_ENABLED

Allow editing of published files (by default by admins only).

Invenio RDM Default Value

True

Type

bool

Source

invenio-rdm-records


RDM_IMMEDIATE_FILE_MODIFICATION_POLICIES

List of policies for editing published files immediately.

To enable users to modify the files of their records, configure as:

from invenio_rdm_records.services.request_policies import (
    FileModificationGracePeriodPolicy,
    FileModificationAdminPolicy,
)
RDM_IMMEDIATE_FILE_MODIFICATION_POLICIES = [
    FileModificationGracePeriodPolicy(),
    FileModificationAdminPolicy(),
]

Also check whether you also want to pass a custom grace period or change RDM_FILE_MODIFICATION_PERIOD.

Policies are executed in order and the first one to return True is used as the policy for the record. As such, policies should be specified from most to least specific.

To update a policy, create a duplicate of it and add a check on creation date to both. When your policy comes into effect on a date in the future it will be used, and this is the date which you will use to check whether the new or old policy will apply.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[<invenio_rdm_records.services.request_policies.FileModificationAdminPolicy object at 0x7f4c7fec1160>]

RDM_IMMEDIATE_QUOTA_INCREASE_ENABLED

Allow increasing of draft’s quota from a user’s additional quota.

RDM_FILES_DEFAULT_MAX_ADDITIONAL_QUOTA_SIZE controls how much each user has available across their records

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


RDM_IMMEDIATE_QUOTA_INCREASE_POLICIES

List of policies for user’s increasing their quota for a draft.

To enable users and admins to increase the quota for drafts, configure as:

from invenio_rdm_records.services.request_policies import (
    QuotaIncreaseAdminPolicy,
    QuotaIncreasePolicy,
)
RDM_IMMEDIATE_QUOTA_INCREASE_POLICIES = [
    QuotaIncreasePolicy(),
    QuotaIncreaseAdminPolicy(),
]

Policies are executed in order and the first one to return True is used as the policy for the record. As such, policies should be specified from most to least specific.

To update a policy, create a duplicate of it and add a check on creation date to both. When your policy comes into effect on a date in the future it will be used, and this is the date which you will use to check whether the new or old policy will apply.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[]

RDM_IMMEDIATE_RECORD_DELETION_CHECKLIST

Checklist which appears on the modal to redirect user from immediate record deletion if possible.

The config accepts a list of dictionaries with “label” and “message” key-value pairs. The “label” is used as the checklist question item, and the “message” is displayed in case the user selects “Yes” on the checklist item.

Example config value:

RDM_IMMEDIATE_RECORD_DELETION_CHECKLIST = [
    {
        "label": _("I want to change the metadata (title, description, etc.)"),
        "message": _(
            "You can edit the metadata of a published record at any time."
        ),
    },
    {
        "label": _("I forgot to submit to a community"),
        "message": _(
            "You can submit a published record to a community by going to the "
            "record landing page and selecting the cog in the communities sidebar."
        ),
    },
]

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[]

RDM_IMMEDIATE_RECORD_DELETION_ENABLED

Allow users to immediately delete records.

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


RDM_IMMEDIATE_RECORD_DELETION_POLICIES

List of policies for immediate record deletion.

Policies are executed in order and the first one to return True is used as the policy for the record. As such, policies should be specified from most to least specific.

To update a policy, create a duplicate of it and add a check on creation date to both. When your policy comes into effect on a date in the future it will be used, and this is the date which you will use to check whether the new or old policy will apply.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[<invenio_rdm_records.services.request_policies.GracePeriodPolicy object at 0x7f4c7fec0ec0>]

RDM_LOCK_EDIT_PUBLISHED_FILES

Lock editing already published files (enforce record versioning).

signature to implement: def lock_edit_published_files(service, identity, record=None, draft=None):

Invenio RDM Default Value

lock_edit_published_files

Type

unknown

Source

invenio-rdm-records


RDM_MEDIA_FILES_DEFAULT_MAX_FILE_SIZE

Default maximum file size for a bucket in bytes for media files.

Invenio RDM Default Value

10000000000

Type

int

Source

invenio-rdm-records


RDM_MEDIA_FILES_DEFAULT_QUOTA_SIZE

Default size for a bucket in bytes for media files.

Invenio RDM Default Value

10000000000

Type

int

Source

invenio-rdm-records


RDM_NAMESPACES

Custom fields namespaces.

{<namespace>: <uri>, ...}

For example:

{
    "cern": "https://cern.ch/terms",
    "dwc": "http://rs.tdwg.org/dwc/terms/"
}

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-rdm-records

{}

RDM_NEW_RECORD_VERSION_REVIEW_POLICY

Policy for when to require a community review for new record versions.

Invenio RDM Default Value

NewRecordVersionReviewPolicy

Type

unknown

Source

invenio-rdm-records


RDM_NOTIFICATIONS_BUILDERS

Default Value

<dict>

Type

dict

Source

unknown

{'comment-request-event.create': <class 'invenio_requests.notifications.builders.CommentRequestEventCreateNotificationBuilder'>,
 'comment-request-event.reply': <class 'invenio_requests.notifications.builders.CommentRequestEventReplyNotificationBuilder'>,
 'comment-subcommunity-invitation-request.create': <class 'invenio_communities.notifications.builders.SubComInvCommentNotificationBuilder'>,
 'comment-subcommunity-request.create': <class 'invenio_communities.notifications.builders.SubComReqCommentNotificationBuilder'>,
 'community-invitation.accept': <class 'invenio_communities.notifications.builders.CommunityInvitationAcceptNotificationBuilder'>,
 'community-invitation.cancel': <class 'invenio_communities.notifications.builders.CommunityInvitationCancelNotificationBuilder'>,
 'community-invitation.decline': <class 'invenio_communities.notifications.builders.CommunityInvitationDeclineNotificationBuilder'>,
 'community-invitation.expire': <class 'invenio_communities.notifications.builders.CommunityInvitationExpireNotificationBuilder'>,
 'community-invitation.submit': <class 'invenio_communities.notifications.builders.CommunityInvitationSubmittedNotificationBuilder'>,
 'community-membership-request.accept': <class 'invenio_communities.notifications.builders.CommunityMembershipRequestAcceptedNotificationBuilder'>,
 'community-membership-request.cancel': <class 'invenio_communities.notifications.builders.CommunityMembershipRequestCancelledNotificationBuilder'>,
 'community-membership-request.decline': <class 'invenio_communities.notifications.builders.CommunityMembershipRequestDeclinedNotificationBuilder'>,
 'community-membership-request.expire': <class 'invenio_communities.notifications.builders.CommunityMembershipRequestExpiredNotificationBuilder'>,
 'community-membership-request.submit': <class 'invenio_communities.notifications.builders.CommunityMembershipRequestSubmittedNotificationBuilder'>,
 'community-submission.accept': <class 'invenio_rdm_records.notifications.builders.CommunityInclusionAcceptNotificationBuilder'>,
 'community-submission.cancel': <class 'invenio_rdm_records.notifications.builders.CommunityInclusionCancelNotificationBuilder'>,
 'community-submission.decline': <class 'invenio_rdm_records.notifications.builders.CommunityInclusionDeclineNotificationBuilder'>,
 'community-submission.expire': <class 'invenio_rdm_records.notifications.builders.CommunityInclusionExpireNotificationBuilder'>,
 'community-submission.submit': <class 'invenio_rdm_records.notifications.builders.CommunityInclusionSubmittedNotificationBuilder'>,
 'grant-user-access.create': <class 'invenio_rdm_records.notifications.builders.GrantUserAccessNotificationBuilder'>,
 'guest-access-request-token.create': <class 'invenio_rdm_records.notifications.builders.GuestAccessRequestTokenCreateNotificationBuilder'>,
 'guest-access-request.accept': <class 'invenio_rdm_records.notifications.builders.GuestAccessRequestAcceptNotificationBuilder'>,
 'guest-access-request.cancel': <class 'invenio_rdm_records.notifications.builders.GuestAccessRequestCancelNotificationBuilder'>,
 'guest-access-request.decline': <class 'invenio_rdm_records.notifications.builders.GuestAccessRequestDeclineNotificationBuilder'>,
 'guest-access-request.submit': <class 'invenio_rdm_records.notifications.builders.GuestAccessRequestSubmitNotificationBuilder'>,
 'guest-access-request.submitted': <class 'invenio_rdm_records.notifications.builders.GuestAccessRequestSubmittedNotificationBuilder'>,
 'record-deletion.accept': <class 'invenio_rdm_records.notifications.builders.RecordDeletionAcceptNotificationBuilder'>,
 'record-deletion.decline': <class 'invenio_rdm_records.notifications.builders.RecordDeletionDeclineNotificationBuilder'>,
 'subcommunity-invitation-request.accept': <class 'invenio_communities.notifications.builders.SubComInvitationAccept'>,
 'subcommunity-invitation-request.create': <class 'invenio_communities.notifications.builders.SubComInvitationCreate'>,
 'subcommunity-invitation-request.decline': <class 'invenio_communities.notifications.builders.SubComInvitationDecline'>,
 'subcommunity-invitation-request.expire': <class 'invenio_communities.notifications.builders.SubComInvitationExpire'>,
 'subcommunity-request.accept': <class 'invenio_communities.notifications.builders.SubCommunityAccept'>,
 'subcommunity-request.create': <class 'invenio_communities.notifications.builders.SubCommunityCreate'>,
 'subcommunity-request.decline': <class 'invenio_communities.notifications.builders.SubCommunityDecline'>,
 'user-access-request.accept': <class 'invenio_rdm_records.notifications.builders.UserAccessRequestAcceptNotificationBuilder'>,
 'user-access-request.cancel': <class 'invenio_rdm_records.notifications.builders.UserAccessRequestCancelNotificationBuilder'>,
 'user-access-request.decline': <class 'invenio_rdm_records.notifications.builders.UserAccessRequestDeclineNotificationBuilder'>,
 'user-access-request.submit': <class 'invenio_rdm_records.notifications.builders.UserAccessRequestSubmitNotificationBuilder'>}

RDM_OAI_PMH_FACETS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-rdm-records

{}

RDM_OAI_PMH_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-rdm-records

{'created': {'fields': ['created'], 'title': l'Created'},
 'name': {'fields': ['name'], 'title': l'Set name'},
 'spec': {'fields': ['spec'], 'title': l'Set spec'},
 'updated': {'fields': ['updated'], 'title': l'Updated'}}

RDM_OPTIONAL_DOI_VALIDATOR

Optional DOI transitions validate method.

Check the signature of validate_optional_doi for more information.

Invenio RDM Default Value

validate_optional_doi

Type

unknown

Source

invenio-rdm-records


RDM_PARENT_PERSISTENT_IDENTIFIERS

OARepo Default Value

<dict>

Type

dict

Sources

invenio-rdm-records; oarepo-doi

{}

RDM_PARENT_PERSISTENT_IDENTIFIER_PROVIDERS

OARepo Default Value

<list>

Type

list

Sources

invenio-rdm-records; oarepo-doi

[<invenio_rdm_records.services.pids.providers.datacite.DataCitePIDProvider object at 0x7f4c7feb3110>]

RDM_PERMISSION_POLICY

Override the default record permission policy.

Invenio RDM Default Value

RDMRecordPermissionPolicy

Type

unknown

Source

invenio-rdm-records


RDM_PERSISTENT_IDENTIFIERS

OARepo Default Value

<dict>

Type

dict

Sources

invenio-rdm-records; oarepo-doi

{'oai': {'is_enabled': <bound method OAIPIDProvider.is_enabled of <class 'invenio_rdm_records.services.pids.providers.oai.OAIPIDProvider'>>,
         'label': l'OAI',
         'providers': ['oai'],
         'required': True}}

RDM_PERSISTENT_IDENTIFIER_PROVIDERS

OARepo Default Value

<list>

Type

list

Sources

invenio-rdm-records; oarepo-doi

[<invenio_rdm_records.services.pids.providers.datacite.DataCitePIDProvider object at 0x7f4c7fec16a0>,
 <invenio_rdm_records.services.pids.providers.crossref.CrossrefPIDProvider object at 0x7f4c7fec1940>,
 <invenio_rdm_records.services.pids.providers.external.ExternalPIDProvider object at 0x7f4c7fec1e80>,
 <invenio_rdm_records.services.pids.providers.oai.OAIPIDProvider object at 0x7f4c7fec1fd0>,
 <invenio_rdm_records.services.pids.providers.oai.OAIPIDProvider object at 0x7f4c879fc550>,
 <invenio_rdm_records.services.pids.providers.oai.OAIPIDProvider object at 0x7f4c879fc550>]

RDM_QUOTA_INCREASE_POLICY

Policy class which evaluates whether the quota for drafts can be increased.

Invenio RDM Default Value

QuotaIncreasePolicyEvaluator

Type

unknown

Source

invenio-rdm-records


RDM_RECORDS_ACCESS_SERVICE_CLASS

OARepo Default Value

'oarepo_rdm.services.delegating.DelegatingRecordAccessService'

Type

str

Source

oarepo-rdm


RDM_RECORDS_ALLOW_RESTRICTION_AFTER_GRACE_PERIOD

Whether record access restriction is allowed after the grace period or not.

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


RDM_RECORDS_COMMUNITY_RECORDS_CONFIG_CLASS

Community records service config that uses the multiplexed search options.

OARepo Default Value

'oarepo_rdm.services.config:OARepoCommunityRecordsConfig'

Type

str

Source

oarepo-rdm


RDM_RECORDS_COMMUNITY_RECORDS_SERVICE_CLASS

Community records service that multiplexes search across per-model services.

OARepo Default Value

'oarepo_rdm.services.service:OARepoCommunityRecordsService'

Type

str

Sources

oarepo-communities; oarepo-rdm


RDM_RECORDS_CONTAINER_EXTENSIONS

List of file extensions for container files. Experimental, this config can later be removed.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

['.zip']

*RDM_RECORDS_ERROR_HANDLERS

OARepo Default Value

<dict>

Type

dict

Source

oarepo-rdm

Set by

add_model()

{<class 'json.decoder.JSONDecodeError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dd850>,
 <class 'sqlalchemy.exc.NoResultFound'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dd380>,
 <class 'marshmallow.exceptions.ValidationError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dc9e0>,
 <class 'opensearchpy.exceptions.RequestError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835ddb10>,
 <class 'invenio_records.systemfields.relations.errors.InvalidRelationValue'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffe97a0>,
 <class 'invenio_records.systemfields.relations.errors.InvalidCheckValue'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dd9b0>,
 <class 'invenio_records_resources.services.errors.PermissionDeniedError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dceb0>,
 <class 'invenio_records_resources.services.errors.RevisionIdMismatchError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dcca0>,
 <class 'invenio_records_resources.services.errors.QuerystringValidationError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dce00>,
 <class 'invenio_records_resources.services.errors.ValidationErrorGroup'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dcb40>,
 <class 'invenio_records_resources.services.errors.RecordPermissionDeniedError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dcf60>,
 <class 'invenio_records_resources.services.errors.ArchiveDownloadTooLargeException'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dd7a0>,
 <class 'invenio_records_resources.services.errors.FacetNotFoundError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dd4e0>,
 <class 'invenio_records_resources.services.errors.FileKeyNotFoundError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dd640>,
 <class 'invenio_records_resources.services.errors.FailedFileUploadException'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835ddbc0>,
 <class 'invenio_records_resources.services.errors.FilesCountExceededException'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835ddc70>,
 <class 'invenio_pidstore.errors.PIDDoesNotExistError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dd170>,
 <class 'invenio_pidstore.errors.PIDAlreadyExists'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dd0c0>,
 <class 'invenio_pidstore.errors.PIDDeletedError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dd010>,
 <class 'invenio_pidstore.errors.PIDUnregistered'>: <function create_error_handler.<locals>.error_handler at 0x7f4c835dd220>,
 <class 'invenio_pidstore.errors.PIDRedirectedError'>: <function create_pid_redirected_error_handler.<locals>.pid_redirected_error_handler at 0x7f4c835dd2d0>,
 <class 'invenio_rdm_records.services.errors.RecordDeletedException'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffe9d20>,
 <class 'invenio_rdm_records.services.errors.DeletionStatusException'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffe9e80>,
 <class 'invenio_rdm_records.services.errors.ReviewNotFoundError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffe9380>,
 <class 'invenio_rdm_records.services.errors.ReviewStateError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffe94e0>,
 <class 'invenio_rdm_records.services.errors.ReviewExistsError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffe9640>,
 <class 'invenio_rdm_records.services.errors.InvalidAccessRestrictions'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffe9900>,
 <class 'invenio_rdm_records.services.errors.ValidationErrorWithMessageAsList'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffe9a60>,
 <class 'invenio_rdm_records.services.errors.AccessRequestExistsError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffe9bc0>,
 <class 'invenio_rdm_records.services.errors.RecordSubmissionClosedCommunityError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffe9fe0>,
 <class 'invenio_rdm_records.services.errors.CommunityRequiredError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffea090>,
 <class 'citeproc_styles.errors.StyleNotFoundError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffe92d0>,
 <class 'invenio_rdm_records.resources.deserializers.errors.DeserializerError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c7ffe8250>,
 <class 'oarepo_rdm.errors.UndefinedModelError'>: <function create_error_handler.<locals>.error_handler at 0x7f4c879eaa30>}

RDM_RECORDS_IDENTIFIERS_SCHEMES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-rdm-records

{'ads': {'datacite': 'bibcode',
         'label': l'Bibcode',
         'validator': <function is_ads at 0x7f4c893f9f30>},
 'ark': {'datacite': 'ARK',
         'label': l'ARK',
         'validator': <function is_ark at 0x7f4c893f9bc0>},
 'arxiv': {'datacite': 'arXiv',
           'label': l'arXiv',
           'validator': <function is_arxiv at 0x7f4c893fa140>},
 'crossreffunderid': {'datacite': 'Crossref Funder ID',
                      'label': l'Crossref Funder ID',
                      'validator': <function always_valid at 0x7f4c824649e0>},
 'cstr': {'datacite': 'CSTR',
          'label': l'CSTR',
          'validator': <function is_cstr at 0x7f4c893fb270>},
 'doi': {'datacite': 'DOI',
         'label': l'DOI',
         'validator': <function is_doi at 0x7f4c897bd850>},
 'ean13': {'datacite': 'EAN13',
           'label': l'EAN13',
           'validator': <function is_ean13 at 0x7f4c893f9900>},
 'eissn': {'datacite': 'EISSN',
           'label': l'EISSN',
           'validator': <function is_issn at 0x7f4c897bd380>},
 'grid': {'datacite': 'GRID',
          'label': l'GRID',
          'validator': <function always_valid at 0x7f4c824649e0>},
 'handle': {'datacite': 'Handle',
            'label': l'Handle',
            'validator': <function is_handle at 0x7f4c893f97a0>},
 'igsn': {'datacite': 'IGSN',
          'label': l'IGSN',
          'validator': <function always_valid at 0x7f4c824649e0>},
 'isbn': {'datacite': 'ISBN',
          'label': l'ISBN',
          'validator': <function is_isbn at 0x7f4c897bd2d0>},
 'isni': {'datacite': 'ISNI',
          'label': l'ISNI',
          'validator': <function is_isni at 0x7f4c893f9a60>},
 'issn': {'datacite': 'ISSN',
          'label': l'ISSN',
          'validator': <function is_issn at 0x7f4c897bd380>},
 'istc': {'datacite': 'ISTC',
          'label': l'ISTC',
          'validator': <function is_istc at 0x7f4c897bd590>},
 'lissn': {'datacite': 'LISSN',
           'label': l'LISSN',
           'validator': <function is_issn at 0x7f4c897bd380>},
 'lsid': {'datacite': 'LSID',
          'label': l'LSID',
          'validator': <function is_lsid at 0x7f4c893f9dd0>},
 'other': {'datacite': 'Other',
           'label': l'Other',
           'validator': <function always_valid at 0x7f4c824649e0>},
 'pmid': {'datacite': 'PMID',
          'label': l'PMID',
          'validator': <function is_pmid at 0x7f4c893fa2a0>},
 'purl': {'datacite': 'PURL',
          'label': l'PURL',
          'validator': <function is_purl at 0x7f4c893f9c70>},
 'rrid': {'datacite': 'RRID',
          'label': l'RRID',
          'validator': <function is_rrid at 0x7f4c893fb320>},
 'upc': {'datacite': 'UPC',
         'label': l'UPC',
         'validator': <function always_valid at 0x7f4c824649e0>},
 'url': {'datacite': 'URL',
         'label': l'URL',
         'validator': <function is_url at 0x7f4c893f9d20>},
 'urn': {'datacite': 'URN',
         'label': l'URN',
         'validator': <function is_urn at 0x7f4c893f9e80>},
 'w3id': {'datacite': 'w3id',
          'label': l'W3ID',
          'validator': <function always_valid at 0x7f4c824649e0>},
 'wikidata': {'datacite': 'Other',
              'label': l'Wikidata',
              'validator': <function is_wikidata at 0x7f4c893fb110>}}

RDM_RECORDS_LOCATION_SCHEMES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-rdm-records

{'geonames': {'label': l'GeoNames',
              'validator': <function always_valid at 0x7f4c824649e0>},
 'wikidata': {'label': l'Wikidata',
              'validator': <function is_wikidata at 0x7f4c893fb110>}}

*RDM_RECORDS_MAX_FILES_COUNT

Max amount of files allowed to upload in the deposit form.

Invenio RDM Default Value

100

Type

int

Source

invenio-rdm-records

Set by

configure_files()


RDM_RECORDS_MAX_MEDIA_FILES_COUNT

Max amount of media files allowed to upload in the deposit form.

Invenio RDM Default Value

100

Type

int

Source

invenio-rdm-records


RDM_RECORDS_PERSONORG_SCHEMES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-rdm-records

{'czenasautid': {'label': l'CzenasAutID',
                 'validator': <function <lambda> at 0x7f4c7f86e980>},
 'doi': {'datacite': 'DOI',
         'label': l'DOI',
         'validator': <function is_doi at 0x7f4c897bd850>},
 'gnd': {'datacite': 'GND',
         'label': l'GND',
         'validator': <function is_gnd at 0x7f4c893fa400>},
 'grid': {'label': l'GRID', 'validator': <function <lambda> at 0x7f4c7f86ec40>},
 'ico': {'label': l'ICO', 'validator': <function <lambda> at 0x7f4c7f86eae0>},
 'institutionalid': {'label': l'InstitutionalID',
                     'validator': <function <lambda> at 0x7f4c7f86ea30>},
 'isni': {'datacite': 'ISNI',
          'label': l'ISNI',
          'validator': <function is_isni at 0x7f4c893f9a60>},
 'orcid': {'datacite': 'ORCID',
           'label': l'ORCID',
           'validator': <function is_orcid at 0x7f4c893f9b10>},
 'researcherid': {'datacite': 'ResearcherID',
                  'label': l'Researcher ID',
                  'validator': <function is_researcher_id at 0x7f4c7f86e610>},
 'ror': {'datacite': 'ROR',
         'label': l'ROR',
         'validator': <function is_ror at 0x7f4c893fae50>},
 'scopusid': {'datacite': 'Scopus Author ID',
              'label': l'Scopus Author ID',
              'validator': <function is_scopus_id at 0x7f4c7f86e8d0>},
 'url': {'label': l'URL', 'validator': <function <lambda> at 0x7f4c7f86eb90>},
 'vedidk': {'label': l'vedIDK', 'validator': <function is_vedidk at 0x7f4c7f86e770>}}

RDM_RECORDS_PIDS_SERVICE_CLASS

OARepo Default Value

'oarepo_rdm.services.delegating.DelegatingPIDsService'

Type

str

Source

oarepo-rdm


RDM_RECORDS_RESOURCE_CLASS

Replacement for the plain RDM resource class.

OARepo Default Value

'oarepo_rdm.resources.records.resource:OARepoRDMRecordResource'

Type

str

Source

oarepo-rdm


RDM_RECORDS_RESOURCE_CONFIG_CLASS

Resource config class.

OARepo Default Value

'oarepo_rdm.resources.records.config:OARepoRDMRecordResourceConfig'

Type

str

Source

oarepo-rdm


RDM_RECORDS_RESTRICTION_GRACE_PERIOD

Grace period for changing record access to restricted.

Invenio RDM Default Value

datetime.timedelta(days=30)

Type

timedelta

Source

invenio-rdm-records


RDM_RECORDS_REVIEWS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

['community-submission']

RDM_RECORDS_REVIEW_SERVICE_CLASS

OARepo Default Value

'oarepo_rdm.services.delegating.DelegatingReviewService'

Type

str

Source

oarepo-rdm


RDM_RECORDS_SERVICE_CLASS

Replacement for the plain RDM service class.

OARepo Default Value

'oarepo_rdm.services.service:OARepoRDMService'

Type

str

Source

oarepo-rdm


RDM_RECORDS_SERVICE_COMPONENTS

Default Value

<list>

Type

list

Source

unknown

[<class 'invenio_rdm_records.services.components.metadata.MetadataComponent'>,
 <class 'invenio_rdm_records.services.components.custom_fields.CustomFieldsComponent'>,
 <class 'invenio_rdm_records.services.components.access.AccessComponent'>,
 <class 'invenio_rdm_records.services.components.files.RDMDraftFilesComponent'>,
 <class 'invenio_records_resources.services.base.config.Custom_DraftMediaFilesComponent'>,
 <class 'invenio_rdm_records.services.components.record_files.RecordFilesProcessorComponent'>,
 <class 'invenio_rdm_records.services.components.record_deletion.RecordDeletionComponent'>,
 <class 'invenio_drafts_resources.services.records.components.pid.PIDComponent'>,
 <class 'invenio_rdm_records.services.components.pids.PIDsComponent'>,
 <class 'invenio_rdm_records.services.components.pids.ParentPIDsComponent'>,
 <class 'invenio_drafts_resources.services.records.components.relations.RelationsComponent'>,
 <class 'invenio_rdm_records.services.components.review.ReviewComponent'>,
 <class 'invenio_rdm_records.services.components.verified.ContentModerationComponent'>,
 <class 'invenio_rdm_records.services.components.internal_notes.InternalNotesComponent'>,
 <class 'oarepo_checks.services.components.checks.OARepoCheckComponent'>]

RDM_RECORDS_SERVICE_CONFIG_CLASS

Service config class.

OARepo Default Value

'oarepo_rdm.services.config:OARepoRDMServiceConfig'

Type

str

Source

oarepo-rdm


RDM_RECORDS_UI_EDIT_URL

Default UI URL for the edit page of a Bibliographic Record.

Invenio RDM Default Value

'/uploads/<pid_value>'

Type

str

Source

invenio-rdm-records


RDM_RECORDS_USER_FIXTURE_PASSWORDS

Overrides for the user fixtures’ passwords.

The password set for a user fixture in this dictionary overrides the password set in the users.yaml file. This can be used to set custom passwords for the fixture users (of course, this has to be configured before the fixtures are installed, e.g. by setting up the services). If None or an empty string is configured in this dictionary, then the password from users.yaml will be used. If that is also absent, a password will be generated randomly.

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-rdm-records

{'admin@inveniosoftware.org': None}

RDM_RECORD_DELETION_POLICY

Policy class which evaluates whether a record can be deleted by a user.

Invenio RDM Default Value

RDMRecordDeletionPolicy

Type

unknown

Source

invenio-rdm-records


RDM_RECORD_FILE_EXTRACTORS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[<invenio_records_resources.services.files.extractors.zip.ZipExtractor object at 0x7f4c7feb3250>]

RDM_REQUESTS_ROUTES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app-rdm

{'community-dashboard-invitation-details': '/communities/<pid_value>/invitations/<uuid:request_pid_value>',
 'community-dashboard-membership-request-details': '/communities/<pid_value>/membership-requests/<uuid:request_pid_value>',
 'community-dashboard-request-details': '/communities/<pid_value>/requests/<uuid:request_pid_value>',
 'user-dashboard-request-details': '/me/requests/<uuid:request_pid_value>'}

RDM_REQUEST_RECORD_DELETION_CHECKLIST

Checklist which appears on the modal to redirect user from record deletion request if possible.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[]

RDM_REQUEST_RECORD_DELETION_ENABLED

Allow users to request record deletion.

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


RDM_REQUEST_RECORD_DELETION_POLICIES

List of policies for record deletion requests.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

[<invenio_rdm_records.services.request_policies.RequestDeletionPolicy object at 0x7f4c7fec1010>]

RDM_RESOURCE_ACCESS_TOKENS_ENABLED

Flag to show whether RATs feature should be enabled.

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


RDM_RESOURCE_ACCESS_TOKENS_JWT_LIFETIME

Maximum tokens lifetime.

Invenio RDM Default Value

datetime.timedelta(seconds=1800)

Type

timedelta

Source

invenio-rdm-records


RDM_RESOURCE_ACCESS_TOKENS_SUBJECT_SCHEMA

Resource access token Marshmallow schema for parsing JWT subject.

Invenio RDM Default Value

tokens.resource_access.SubjectSchema

Type

unknown

Source

invenio-rdm-records


RDM_RESOURCE_ACCESS_TOKENS_WHITELISTED_JWT_ALGORITHMS

Accepted JWT algorithms for decoding the RAT.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-rdm-records

['HS256', 'HS384', 'HS512']

RDM_RESOURCE_ACCESS_TOKEN_REQUEST_ARG

URL argument to provide resource access token.

Invenio RDM Default Value

'resource_access_token'

Type

str

Source

invenio-rdm-records


RDM_SEARCH_DRAFTS

OARepo Default Value

<dict>

Type

unknown

Sources

invenio-rdm-records; oarepo-rdm

{
    'facets': [
        'publication_date',
        'access_status',
        'is_published',
        'resource_type',
        'file_type',
    ],
    'sort': [
        'bestmatch',
        'updated-desc',
        'updated-asc',
        'newest',
        'oldest',
        'version',
    ],
}

RDM_SEARCH_SORT_BY_VERIFIED

Sort records by ‘verified’ first.

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


RDM_SEARCH_USER_COMMUNITIES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app-rdm

{'facets': ['visibility', 'type'], 'sort': ['bestmatch', 'newest', 'oldest']}

RDM_SEARCH_USER_REQUESTS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app-rdm

{'facets': ['type', 'status'], 'sort': ['bestmatch', 'newest', 'oldest']}

RDM_SEARCH_VERSIONING

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-rdm-records

{'facets': [],
 'sort': ['version'],
 'sort_default': 'version',
 'sort_default_no_query': 'version'}

RDM_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-rdm-records

{'bestmatch': {'fields': ['_score'], 'title': l'Best match'},
 'mostdownloaded': {'fields': ['-stats.all_versions.unique_downloads'],
                    'title': l'Most downloaded'},
 'mostviewed': {'fields': ['-stats.all_versions.unique_views'],
                'title': l'Most viewed'},
 'newest': {'fields': ['-created'], 'title': l'Newest'},
 'newestactivity': {'fields': ['-last_activity_at'], 'title': l'Newest activity'},
 'oldest': {'fields': ['created'], 'title': l'Oldest'},
 'oldestactivity': {'fields': ['last_activity_at'], 'title': l'Oldest activity'},
 'updated-asc': {'fields': ['updated'], 'title': l'Least recently updated'},
 'updated-desc': {'fields': ['-updated'], 'title': l'Recently updated'},
 'version': {'fields': ['-versions.index'], 'title': l'Version'}}

RDM_STATS_EXCLUDE_PREVIEW_FILE_DOWNLOAD_EVENTS

Exclude file-download stats events whose Referer is the file’s own preview page.

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


RDM_USER_MODERATION_ENABLED

Flag to enable creation of user moderation requests on specific user actions.

Invenio RDM Default Value

False

Type

bool

Source

invenio-rdm-records


RECAPTCHA_PRIVATE_KEY

reCAPTCHA private key.

Invenio RDM Default Value

None

Type

unknown

Source

invenio-accounts


RECAPTCHA_PUBLIC_KEY

reCAPTCHA public key.

Invenio RDM Default Value

None

Type

unknown

Source

invenio-accounts


RECORDS_FILES_REST_ENDPOINTS

REST endpoints configuration.

You can configure the REST API endpoint to access the record’s files as follows:

RECORDS_FILES_REST_ENDPOINTS = {
    '<*_REST_ENDPOINTS>': {
        '<endpoint-prefix>': '<endpoint-suffix>',
    }
}
  • <*_REST_ENDPOINTS> corresponds to Invenio-Records-REST endpoint configurations names that you have defined in your application.

  • <endpoint-prefix> is the unique name of the endpoint configuration as it is defined in Invenio-Records-REST like configuration. This needs to match an already existing endpoint name in the <*_REST_ENDPOINTS> configuration.

  • <endpoint-suffix> is the endpoint path name to access the record’s files.

{'recid': '/myawesomefiles'} -> /records/1/myawesomefiles

An example of this configuration is provided in the Integration with Invenio REST API section of the documentation.

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-records-files

{}

RECORDS_PERMISSIONS_RECORD_POLICY

Invenio RDM Default Value

'invenio_records_permissions.policies.RecordPermissionPolicy'

Type

str

Source

invenio-records-permissions


*RECORDS_REFRESOLVER_CLS

Custom JSONSchemas ref resolver class.

Note that when using a custom ref resolver class you should also set RECORDS_REFRESOLVER_STORE to point to a JSONSchema ref resolver store.

Invenio RDM Default Value

None

Type

NoneType

Sources

invenio-records; invenio-app-rdm

Set by

configure_generic_parameters()


*RECORDS_REFRESOLVER_STORE

JSONSchemas ref resolver store.

Used together with RECORDS_REFRESOLVER_CLS to provide a specific ref resolver store.

Invenio RDM Default Value

None

Type

NoneType

Sources

invenio-records; invenio-app-rdm

Set by

configure_generic_parameters()


RECORDS_RESOURCES_ALLOW_EMPTY_FILES

Allow empty files to be uploaded.

Invenio RDM Default Value

True

Type

bool

Source

invenio-records-resources


RECORDS_RESOURCES_ARCHIVE_DOWNLOAD_MAX_SIZE

Max total file size (bytes) for archive download. None disables the cap.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-records-resources


RECORDS_RESOURCES_DEFAULT_TRANSFER_TYPE

Default transfer class to use. One of ‘L’ (local), ‘F’ (fetch), ‘R’ (point to remote), ‘M’ (multipart).

Invenio RDM Default Value

'L'

Type

str

Source

invenio-records-resources


RECORDS_RESOURCES_EXTRACTED_STREAM_CHUNK_SIZE

Chunk size of extracted stream used in ContainerItemResult.send_file().

Invenio RDM Default Value

65536

Type

int

Source

invenio-records-resources


RECORDS_RESOURCES_FILES_ALLOWED_DOMAINS

Explicitly allowed domains for external file fetching.

Only file URLs from these domains will be allowed to be fetched.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-records-resources

[]

RECORDS_RESOURCES_IMAGE_FORMATS

Which image formats to extract metadata for.

Invenio RDM Default Value

<list>

Type

list

Sources

invenio-records-resources; invenio-app-rdm

['.jpg', '.jpeg', '.jp2', '.png', '.tif', '.tiff']

RECORDS_RESOURCES_TRANSFERS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-records-resources

['invenio_records_resources.services.files.transfer.LocalTransfer',
 'invenio_records_resources.services.files.transfer.FetchTransfer',
 'invenio_records_resources.services.files.transfer.RemoteTransfer',
 'invenio_records_resources.services.files.transfer.MultipartTransfer']

RECORDS_RESOURCES_ZIP_FORMATS

File extensions interpreted as ZIP files.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-records-resources

['.zip']

RECORDS_RESOURCES_ZIP_MAX_ENTRIES

Max allowed entries inside ZIP file.

Invenio RDM Default Value

10000

Type

int

Source

invenio-records-resources


RECORDS_RESOURCES_ZIP_MAX_HEADER_SIZE

Max header size of ZIP file that can be preloaded.

Invenio RDM Default Value

65536

Type

int

Source

invenio-records-resources


RECORDS_RESOURCES_ZIP_MAX_LISTING_ENTRIES

Max entries returned by the container listing API.

Invenio RDM Default Value

1000

Type

int

Source

invenio-records-resources


RECORDS_RESOURCES_ZIP_MAX_RATIO

Max allowed compression ratio of an entry inside ZIP file.

Invenio RDM Default Value

200.0

Type

float

Source

invenio-records-resources


RECORDS_RESOURCES_ZIP_MAX_TOTAL_UNCOMPRESSED

Max allowed uncompressed size of ZIP.

Invenio RDM Default Value

524288000

Type

int

Source

invenio-records-resources


RECORDS_REST_DEFAULT_CREATE_PERMISSION_FACTORY

Default create permission factory: reject any request.

Invenio RDM Default Value

deny_all

Type

unknown

Source

invenio-records-rest


RECORDS_REST_DEFAULT_DELETE_PERMISSION_FACTORY

Default delete permission factory: reject any request.

Invenio RDM Default Value

deny_all

Type

unknown

Source

invenio-records-rest


RECORDS_REST_DEFAULT_LIST_PERMISSION_FACTORY

Default list permission factory: allow all requests

Invenio RDM Default Value

allow_all

Type

unknown

Source

invenio-records-rest


RECORDS_REST_DEFAULT_LOADERS

Invenio RDM Default Value

<dict>

Type

unknown

Source

invenio-records-rest

{
    'application/json': lambda: request.get_json(),
    'application/json-patch+json': lambda: request.get_json(force=True),
}

RECORDS_REST_DEFAULT_READ_PERMISSION_FACTORY

Default read permission factory: check if the record exists.

Invenio RDM Default Value

check_search

Type

unknown

Source

invenio-records-rest


RECORDS_REST_DEFAULT_RESULTS_SIZE

Default search results size.

Invenio RDM Default Value

10

Type

unknown

Source

invenio-records-rest


RECORDS_REST_DEFAULT_SORT

Invenio RDM Default Value

dict(records=dict(query='bestmatch', noquery='mostrecent'))

Type

unknown

Source

invenio-records-rest


RECORDS_REST_DEFAULT_UPDATE_PERMISSION_FACTORY

Default update permission factory: reject any request.

Invenio RDM Default Value

deny_all

Type

unknown

Source

invenio-records-rest


*RECORDS_REST_ENDPOINTS

Invenio RDM Default Value

<list>

Type

list

Sources

invenio-records-rest; invenio-app-rdm

Set by

configure_generic_parameters()

[]

RECORDS_REST_FACETS

Invenio RDM Default Value

dict(records=dict(aggs=dict(type=dict(terms=dict(field='type'))), post_filters=dict(type=terms_filte...

Type

unknown

Source

invenio-records-rest


RECORDS_REST_FACETS_POST_FILTERS_PROPAGATE

Define if the post_filters facets in one category should be applied as filters to all the other categories

Invenio RDM Default Value

False

Type

unknown

Source

invenio-records-rest


RECORDS_REST_SEARCH_ERROR_HANDLERS

Invenio RDM Default Value

<dict>

Type

unknown

Source

invenio-records-rest

{
    'query_parsing_exception': 'invenio_records_rest.views:search_query_parsing_exception_handler',
    'query_shard_exception': 'invenio_records_rest.views:search_query_parsing_exception_handler',
}

RECORDS_REST_SORT_OPTIONS

Invenio RDM Default Value

dict(records=dict(bestmatch=dict(title=_('Best match'), fields=['_score'], default_order='desc', ord...

Type

unknown

Source

invenio-records-rest


RECORDS_UI_BASE_TEMPLATE

Default Value

'invenio_records_ui/base.html'

Type

str

Source

unknown


RECORDS_UI_DEFAULT_PERMISSION_FACTORY

Configure the default permission factory.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-records-ui


*RECORDS_UI_ENDPOINTS

Invenio RDM Default Value

<dict>

Type

dict

Sources

invenio-records-ui; invenio-app-rdm

Set by

configure_ui()

{'recid': {'pid_type': 'recid',
           'route': '/records/<pid_value>',
           'template': 'invenio_records_ui/detail.html'},
 'recid_export': {'pid_type': 'recid',
                  'route': '/records/<pid_value>/export/<format>',
                  'template': 'invenio_records_ui/export.html',
                  'view_imp': 'invenio_records_ui.views.export'}}

RECORDS_UI_EXPORT_FORMATS

Defaut record serialization views.

The structure of the dictionary is as follows:

RECORDS_UI_EXPORT_FORMATS = {
    {"<pid-type>": {
        "<format-slug>": {
            "title": "<export format title>",
            "serializer": "<object or import path to record serializer>",
            "order": 1,
        },
        ...
    },
    ...
}

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-records-ui

{}

RECORDS_UI_LOGIN_ENDPOINT

Endpoint where redirect the user if login is required.

Invenio RDM Default Value

'security.login'

Type

str

Source

invenio-records-ui


RECORDS_UI_TOMBSTONE_TEMPLATE

Configure the tombstone template.

Invenio RDM Default Value

'invenio_records_ui/tombstone.html'

Type

str

Source

invenio-records-ui


RECORDS_VALIDATION_TYPES

Pass additional types when validating a record against a schema. For more details, see: https://python-jsonschema.readthedocs.io/en/latest/validate/#validating-types.

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-records

{}

*RECORD_ROUTES

Type

configured by function

Source

oarepo-config

Set by

configure_generic_parameters()


*REPOSITORY_DESCRIPTION

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


*REPOSITORY_KEYWORDS

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


*REPOSITORY_NAME

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


*REPOSITORY_SUBTITLE

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


*REPOSITORY_SUPPORT_CONTACT

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


REQUESTS_ACTION_COMPONENTS

Default Value

<list>

Type

list

Source

unknown

[<class 'oarepo_requests.actions.components.WorkflowTransitionComponent'>,
 <class 'oarepo_requests.actions.components.AutoAcceptComponent'>]

REQUESTS_ALLOWED_RECEIVERS

Default Value

<list>

Type

list

Source

unknown

['multiple', 'action_need', 'community_role', 'user', 'group', 'auto_approve']

REQUESTS_COMMENTS_ALLOWED_EXTRA_HTML_ATTRS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-requests

{'img': ['src', 'alt', 'width', 'height']}

REQUESTS_COMMENTS_ALLOWED_EXTRA_HTML_TAGS

Extend allowed HTML tags list for requests comments content.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-requests

['img']

REQUESTS_COMMENT_PREVIEW_LIMIT

Number of most recent child comments to inline in parent’s search index.

This limits the size of indexed documents when comments have many replies. Additional replies can be loaded via pagination.

Invenio RDM Default Value

5

Type

int

Source

invenio-requests


REQUESTS_ENTITY_RESOLVERS

Registered resolvers for resolving/creating references in request metadata.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-requests

[<invenio_users_resources.entity_resolvers.UserResolver object at 0x7f4c833cd940>,
 <invenio_users_resources.entity_resolvers.GroupResolver object at 0x7f4c833cda90>]

REQUESTS_ERROR_HANDLERS

Invenio RDM Default Value

<dict>

Type

unknown

Source

invenio-app-rdm

{
    **request_error_handlers,
    InvalidAccessRestrictions: create_error_handler(lambda e: HTTPJSONException(code=400, description=e.description)),
}

REQUESTS_EVENTS_SERVICE_COMPONENTS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-requests

[<class 'invenio_requests.services.requests.components.RequestCommentFileValidationComponent'>,
 <class 'invenio_requests.services.requests.components.RequestCommentFileCleanupComponent'>]

REQUESTS_FACETS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-requests

{'status': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c833d16d0>,
            'ui': {'field': 'status'}},
 'type': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c833d1590>,
          'ui': {'field': 'type'}}}

REQUESTS_FILES_DEFAULT_MAX_FILE_SIZE

10MB

Invenio RDM Default Value

10000000

Type

int

Source

invenio-requests


REQUESTS_FILES_DEFAULT_QUOTA_SIZE

100MB

Invenio RDM Default Value

100000000

Type

int

Source

invenio-requests


REQUESTS_LOCKING_ENABLED

Enable locking/unlocking for request conversations.

Invenio RDM Default Value

False

Type

bool

Source

invenio-requests


REQUESTS_MODERATION_ROLE

ID of the Role used for moderation.

Invenio RDM Default Value

'administration-moderation'

Type

str

Source

invenio-requests


REQUESTS_PERMISSION_POLICY

Override the default requests/comments permission policy.

OARepo Default Value

CreatorsFromWorkflowRequestsPermissionPolicy

Type

unknown

Sources

oarepo-workflows; invenio-requests; invenio-app-rdm


REQUESTS_REGISTERED_EVENT_TYPES

Invenio RDM Default Value

<list>

Type

list

Source

invenio-requests

[<RequestEventType 'L'>, <RequestEventType 'C'>, <RequestEventType 'R'>]

REQUESTS_REGISTERED_TYPES

Configuration for registered Request Types.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-requests

[]

REQUESTS_RESOURCE_CLASS

OARepo Default Value

OARepoRequestsResource

Type

unknown

Source

oarepo-requests


REQUESTS_RESOURCE_CONFIG_CLASS

OARepo Default Value

OARepoRequestsResourceConfig

Type

unknown

Source

oarepo-requests


REQUESTS_REVIEWERS_ENABLED

Enable reviewers for requests.

OARepo Default Value

True

Type

bool

Sources

invenio-requests; oarepo-requests


REQUESTS_REVIEWERS_MAX_NUMBER

Maximum number of reviewers allowed for a request.

Invenio RDM Default Value

15

Type

int

Source

invenio-requests


REQUESTS_ROUTES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-requests

{'download_file_html': '/requests/<uuid:pid_value>/files/<path:file_key>'}

REQUESTS_SERVICE_CLASS

OARepo Default Value

OARepoRequestsService

Type

unknown

Source

oarepo-requests


REQUESTS_SERVICE_CONFIG_CLASS

OARepo Default Value

OARepoRequestsServiceConfig

Type

unknown

Source

oarepo-requests


REQUESTS_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-requests

{'bestmatch': {'fields': ['_score'], 'title': l'Best match'},
 'newest': {'fields': ['-created'], 'title': l'Newest'},
 'newestactivity': {'fields': ['-last_activity_at'], 'title': l'Newest activity'},
 'oldest': {'fields': ['created'], 'title': l'Oldest'},
 'oldestactivity': {'fields': ['last_activity_at'], 'title': l'Oldest activity'}}

REQUESTS_TIMELINE_PAGE_SIZE

Amount of items per page on the request details timeline

Invenio RDM Default Value

10

Type

int

Source

invenio-requests


REQUESTS_USER_MODERATION_FACETS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-requests

{'is_open': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c833968b0>,
             'ui': {'field': 'is_open'}},
 'status': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c833d16d0>,
            'ui': {'field': 'status'}}}

REQUESTS_USER_MODERATION_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-requests

{'bestmatch': {'fields': ['_score'], 'title': l'Best match'},
 'newest': {'fields': ['-created'], 'title': l'Newest'},
 'oldest': {'fields': ['created'], 'title': l'Oldest'}}

REST_CSRF_ENABLED

Enable CSRF middleware. (Default: False).

Note

The CSRF middleware accepts some configuration parameters that are used to adjust the workflow of the CSRF validation. The available options are:

\`CSRF_SAFE_METHODS\`: HTTP methods against which the csrf check should NOT run. Defaults to \`[‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’]\`.

\`CSRF_HEADER\`: The name of the request header used for CSRF authentication. Defaults to \`X-CSRF-Token\`.

\`CSRF_COOKIE_NAME\`: The name of the request cookie used for CSRF authentication. Defaults to \`_csrftoken\`.

\`CSRF_COOKIE_MAX_AGE\`: The maximum time until the cookie expires. After the expiration the cookie will be removed. Defaults to \`60*60*24*7*52\` (1 year).

\`CSRF_COOKIE_DOMAIN\`: The domain for which the CSRF cookie should be valid. Defaults to \`flask.sessions.SessionInterface.get_cookie_domain\`.

\`CSRF_COOKIE_PATH\`: The url path for which the cookie is set. This is useful if you have multiple Flask instances running under the same hostname. They can use different cookie paths, and each instance will only see its own CSRF cookie. Defaults to \`flask.sessions.SessionInterface.get_cookie_path\`.

\`CSRF_COOKIE_SAMESITE\`: Restrict if CSRF cookie should be sent along requests coming from external sites. Defaults to \`SESSION_COOKIE_SAMESITE\` configuation variable, if this is set to a not \`None\` value, or \`Lax\`. Lax prevents sending cookies with CSRF-prone requests from external sites, such as submitting a form.

\`CSRF_SECRET\`: Secret key to encode/decode csrf token. Defaults to application \`SECRET_KEY\`.

\`CSRF_SECRET_SALT\`: The salt value used to encode/decode csrf token. Defaults to \`invenio-csrf-token\`.

\`CSRF_TOKEN_LENGTH\`: The length of the generated csrf token. Defaults to \`12\`.

\`CSRF_ALLOWED_CHARS\`: The allowed characters that can be included in the generation of the csrf token. Defaults to \`string.ascii_letters\` + \`string.digits\`.

\`CSRF_FORCE_SECURE_REFERER\`: Flag to disable secure referrer check. This should used only in development if you run your UI application over HTTP. Defaults to \`True\`.

Invenio RDM Default Value

False

Type

unknown

Sources

invenio-rest; invenio-app-rdm


REST_ENABLE_CORS

Enable CORS configuration. (Default: False).

Invenio RDM Default Value

False

Type

unknown

Source

invenio-rest


REST_MIMETYPE_QUERY_ARG_NAME

Name of the query argument to specify the mimetype wanted for the output.

Set it to None to disable.

Note

You can customize the query argument name by specifying it as a string:

REST_MIMETYPE_QUERY_ARG_NAME = 'format'

With this value, the url will be:

/api/record/<id>?format=<value>

You can set the accepted values passing a dictionary to the key record_serializers_aliases:

record_serializers_aliases={
   'json': 'application/json',
   'marc21': 'application/marcxml+xml'
}

Invenio RDM Default Value

None

Type

unknown

Source

invenio-rest


*ROR_CLIENT_ID

Type

configured by function

Source

oarepo-config

Set by

configure_generic_parameters()


*S3_ACCESS_KEY_ID

The access key to use when creating the client.

This is entirely optional, and if not provided, the credentials configured for the session will automatically be used. See Configuring Credentials. for more information.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-s3

Set by

configure_generic_parameters()


S3_CONFIG_EXTRA

Additional configuration to be passed to S3f3. In some cases, specially those not using AWS S3, some extra configuration might be needed.

{
    "request_checksum_calculation": "WHEN_REQUIRED",
    "response_checksum_validation": "WHEN_REQUIRED",
}

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-s3

{}

S3_DEFAULT_BLOCK_SIZE

Default block size value used to send multi-part uploads to S3. Typically 5Mb is minimum allowed by the API.

Invenio RDM Default Value

5242880

Type

int

Source

invenio-s3


*S3_ENDPOINT_URL

S3 server URL endpoint.

If using Amazon AWS S3 service this config variable can be set to None as the underlining library, boto3, will automatically construct the appropriate URL to use when communicating with a service.

If set to a value (including the “http/https” scheme) it will be passed as endpoint_url to boto3 client.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-s3

Set by

configure_generic_parameters()


S3_MAXIMUM_NUMBER_OF_PARTS

Maximum number of parts to be used. See AWS Multipart Upload Overview for more information.

Invenio RDM Default Value

10000

Type

int

Source

invenio-s3


S3_REGION_NAME

S3 region name

This is entirely optional, and if not provided, the region name will be automatically set to ‘us-east-1’.

If set to a value it will be passed as region_name to boto3 client.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-s3


*S3_SECRET_ACCESS_KEY

The secret key to use when creating the client.

This is entirely optional, and if not provided, the credentials configured for the session will automatically be used. See Configuring Credentials. for more information.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-s3

Set by

configure_generic_parameters()


S3_SIGNATURE_VERSION

Version of the S3 signature algorithm. Can be ‘s3’ (v2) or ‘s3v4’ (v4). See Amazon Boto3 documentation on configuration variables for more information.

Invenio RDM Default Value

's3v4'

Type

str

Source

invenio-s3


S3_UPLOAD_URL_EXPIRATION

Number of seconds the file upload URL will be valid. The default here is 7 days to allow large file uploads with large number of chunks to be completed. This is currently the maximum allowed by the AWS. See Amazon Boto3 documentation on presigned URLs for more information.

Invenio RDM Default Value

604800

Type

int

Source

invenio-s3


S3_URL_EXPIRATION

Number of seconds the file serving URL will be valid.

See Amazon Boto3 documentation on presigned URLs for more information.

Invenio RDM Default Value

60

Type

int

Source

invenio-s3


*SEARCH_CLIENT_CONFIG

Dictionary of options for the Elasticsearch/OpenSearch client.

The value of this variable is passed to elasticsearch.Elasticsearch (or opensearchpy.OpenSearch) as keyword arguments and is used to configure the client. See the available keyword arguments in the two following classes:

  • elasticsearch.Elasticsearch

  • elasticsearch.Transport

Or:

  • opensearchpy.OpenSearch

  • opensearchpy.Transport

If you specify the key hosts in this dictionary, the configuration variable SEARCH_HOSTS will have no effect.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-search

Set by

configure_generic_parameters()


SEARCH_ELASTIC_HOSTS

Deprecated alias for SEARCH_HOSTS.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-search


*SEARCH_HOSTS

Search cluster hosts.

By default, Invenio connects to localhost:9200.

The value of this variable is a list of dictionaries, where each dictionary represents a host. The available keys in each dictionary is determined by the connection class:

  • elasticsearch.connection.Urllib3HttpConnection (default)

  • elasticsearch.connection.RequestsHttpConnection

You can change the connection class via the SEARCH_CLIENT_CONFIG. If you specified the hosts key in SEARCH_CLIENT_CONFIG then this configuration variable will have no effect.

Invenio RDM Default Value

None

Type

NoneType

Sources

invenio-search; invenio-app-rdm

Set by

configure_generic_parameters()


*SEARCH_INDEX_PREFIX

Any index, alias and templates will be prefixed with this string.

Useful to host multiple instances of the app on the same Elasticsearch cluster, for example on one app you can set it to dev- and on the other to prod-, and each will create non-colliding indices prefixed with the corresponding string.

Usage example:

# in your config.py
SEARCH_INDEX_PREFIX = 'prod-'

For templates, ensure that the prefix __SEARCH_INDEX_PREFIX__ is added to your index names. This pattern will be replaced by the prefix config value.

Usage example in your template.json:

{
    "index_patterns": ["__SEARCH_INDEX_PREFIX__myindex-name-*"]
}

Invenio RDM Default Value

''

Type

str

Source

invenio-search

Set by

configure_generic_parameters()


SEARCH_MAPPINGS

List of aliases for which, their search mappings should be created.

  • If None all aliases (and their search mappings) defined through the invenio_search.mappings entry point in setup.py will be created.

  • Provide an empty list [] if no aliases (or their search mappings) should be created.

For example if you don’t want to create aliases and their mappings for authors:

# in your `setup.py` you would specify:
entry_points={
    'invenio_search.mappings': [
        'records = invenio_foo_bar.mappings',
        'authors = invenio_foo_bar.mappings',
    ],
}

# and in your config.py
SEARCH_MAPPINGS = ['records']

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-search


SEARCH_RESULTS_MIN_SCORE

If set, the min_score parameter is added to each search request body.

The min_score parameter excludes results which have a _score less than the minimum specified in min_score.

Note that the max_score varies depending on the number of results for a given search query and it is not absolute value. Therefore, setting min_score too high can lead to 0 results because it can be higher than any result’s _score.

Please refer to Elasticsearch min_score documentation for more information.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-search


SEARCH_UI_BASE_TEMPLATE

Default Value

None

Type

NoneType

Source

unknown


SEARCH_UI_HEADER_TEMPLATE

Default Value

None

Type

NoneType

Source

unknown


SEARCH_UI_JSTEMPLATE_COUNT

Configure the count template.

Invenio RDM Default Value

'templates/invenio_search_ui/count.html'

Type

str

Source

invenio-search-ui


SEARCH_UI_JSTEMPLATE_ERROR

Configure the error page template.

Invenio RDM Default Value

'templates/invenio_search_ui/error.html'

Type

str

Source

invenio-search-ui


SEARCH_UI_JSTEMPLATE_FACETS

Configure the facets template.

Invenio RDM Default Value

'templates/invenio_search_ui/facets.html'

Type

str

Source

invenio-search-ui


SEARCH_UI_JSTEMPLATE_LOADING

Configure the loading template.

Invenio RDM Default Value

'templates/invenio_search_ui/loading.html'

Type

str

Source

invenio-search-ui


SEARCH_UI_JSTEMPLATE_PAGINATION

Configure the pagination template.

Invenio RDM Default Value

'templates/invenio_search_ui/pagination.html'

Type

str

Source

invenio-search-ui


SEARCH_UI_JSTEMPLATE_RANGE

Configure the range template.

Invenio RDM Default Value

'templates/invenio_search_ui/range.html'

Type

str

Source

invenio-search-ui


SEARCH_UI_JSTEMPLATE_RANGE_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-search-ui

{'histogramId': '#year_hist',
 'name': 'years',
 'selectionId': '#year_select',
 'width': 180}

SEARCH_UI_JSTEMPLATE_RESULTS

Configure the results template.

Invenio RDM Default Value

'templates/invenio_search_ui/results.html'

Type

str

Source

invenio-search-ui


SEARCH_UI_JSTEMPLATE_SELECT_BOX

Configure the select box template.

Invenio RDM Default Value

'templates/invenio_search_ui/selectbox.html'

Type

str

Source

invenio-search-ui


SEARCH_UI_JSTEMPLATE_SORT_ORDER

Configure the toggle button template.

Invenio RDM Default Value

'templates/invenio_search_ui/togglebutton.html'

Type

str

Source

invenio-search-ui


SEARCH_UI_SEARCH_API

Configure the search engine endpoint.

Invenio RDM Default Value

'/api/records/'

Type

str

Source

invenio-search-ui


SEARCH_UI_SEARCH_CONFIG_GEN

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-search-ui

{'invenio_records_rest': <class 'invenio_search_ui.views.SearchAppInvenioRestConfigHelper'>}

SEARCH_UI_SEARCH_INDEX

Name of the search index used.

Invenio RDM Default Value

'records'

Type

str

Source

invenio-search-ui


*SEARCH_UI_SEARCH_TEMPLATE

Configure the search page template.

Invenio RDM Default Value

'invenio_search_ui/search.html'

Type

str

Sources

invenio-search-ui; invenio-app-rdm

Set by

configure_ui()


*SEARCH_UI_SEARCH_VIEW

Default funtion to do the search route.

Invenio RDM Default Value

search

Type

unknown

Source

invenio-search-ui

Set by

configure_ui()


*SECRET_KEY

Flask secret key.

Each installation (dev, production, …) needs a separate key.

SECURITY WARNING: keep the secret key used in production secret!

Invenio RDM Default Value

'CHANGE_ME'

Type

str

Source

invenio-app-rdm

Set by

configure_generic_parameters()


SECRET_KEY_FALLBACKS

Default Value

None

Type

NoneType

Source

unknown


SECURITY_AUTO_LOGIN_AFTER_CONFIRM

Default Value

True

Type

bool

Source

unknown


SECURITY_BLUEPRINT_NAME

Default Value

'security'

Type

str

Source

unknown


*SECURITY_CHANGEABLE

Allow password change by users.

Invenio RDM Default Value

True

Type

bool

Source

invenio-accounts

Set by

configure_generic_parameters()


SECURITY_CHANGE_PASSWORD_TEMPLATE

Default template for change password.

Invenio RDM Default Value

'invenio_accounts/change_password.html'

Type

str

Source

invenio-accounts


SECURITY_CHANGE_SALT

Default Value

'change-salt'

Type

str

Source

unknown


SECURITY_CHANGE_URL

URL endpoint for password change.

Invenio RDM Default Value

'/account/settings/password/'

Type

str

Source

invenio-accounts


SECURITY_CLI_ROLES_NAME

Default Value

'roles'

Type

str

Source

unknown


SECURITY_CLI_USERS_NAME

Default Value

'users'

Type

str

Source

unknown


*SECURITY_CONFIRMABLE

Allow user to confirm their email address.

Invenio RDM Default Value

True

Type

bool

Source

invenio-accounts

Set by

configure_generic_parameters()


SECURITY_CONFIRM_EMAIL_WITHIN

Amount of time the email confirmation link is active.

Note, since the confirmation link will also login the associated user we expire the link fast.

Invenio RDM Default Value

'30 minutes'

Type

str

Source

invenio-accounts


SECURITY_CONFIRM_ERROR_VIEW

Default Value

None

Type

NoneType

Source

unknown


SECURITY_CONFIRM_SALT

Default Value

'confirm-salt'

Type

str

Source

unknown


SECURITY_CONFIRM_URL

Default Value

'/confirm'

Type

str

Source

unknown


SECURITY_DEFAULT_HTTP_AUTH_REALM

Default Value

'Login Required'

Type

str

Source

unknown


SECURITY_DEFAULT_REMEMBER_ME

“Remember me” default value in login form.

This is only the default value in the login form. A user can always choose to change it when they login.

Invenio RDM Default Value

False

Type

bool

Source

invenio-accounts


SECURITY_DEPRECATED_HASHING_SCHEMES

Default Value

<list>

Type

list

Source

unknown

['hex_md5']

SECURITY_DEPRECATED_PASSWORD_SCHEMES

Deprecated password hashing algorithms.

Password hashes in a deprecated scheme are automatically migrated to the new default algorithm the next time the user login.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-accounts

['invenio_aes_encrypted_email']

SECURITY_EMAIL_HTML

Default Value

True

Type

bool

Source

unknown


SECURITY_EMAIL_PLAINTEXT

Default Value

True

Type

bool

Source

unknown


SECURITY_EMAIL_SUBJECT_CONFIRM

Default Value

'Please confirm your email'

Type

str

Source

unknown


SECURITY_EMAIL_SUBJECT_PASSWORD_CHANGE_NOTICE

Default Value

'Your password has been changed'

Type

str

Source

unknown


SECURITY_EMAIL_SUBJECT_PASSWORD_NOTICE

Default Value

'Your password has been reset'

Type

str

Source

unknown


SECURITY_EMAIL_SUBJECT_PASSWORD_RESET

Default Value

'Password reset instructions'

Type

str

Source

unknown


SECURITY_EMAIL_SUBJECT_REGISTER

Email subject for account registration emails.

Invenio RDM Default Value

'Welcome'

Type

str

Source

invenio-app-rdm


SECURITY_FLASH_MESSAGES

Default Value

True

Type

bool

Source

unknown


SECURITY_FORGOT_PASSWORD_TEMPLATE

Default template for password recovery (asking for email).

Invenio RDM Default Value

'invenio_accounts/forgot_password.html'

Type

str

Source

invenio-accounts


SECURITY_HASHING_SCHEMES

Default Value

<list>

Type

list

Source

unknown

['sha256_crypt', 'hex_md5']

SECURITY_I18N_DIRNAME

Default Value

'/opt/hostedtoolcache/Python/3.14.6/x64/lib/python3.14/site-packages/flask_security/translations'

Type

str

Source

unknown


SECURITY_I18N_DOMAIN

Default Value

'messages'

Type

str

Source

unknown


SECURITY_LOGIN_SALT

Default Value

'login-salt'

Type

str

Source

unknown


SECURITY_LOGIN_URL

URL endpoint for login.

Invenio RDM Default Value

'/login/'

Type

str

Source

invenio-accounts


SECURITY_LOGIN_USER_TEMPLATE

Default template for login.

Invenio RDM Default Value

'invenio_oauthclient/login_user.html'

Type

str

Source

invenio-accounts


SECURITY_LOGIN_WITHIN

Default Value

'1 days'

Type

str

Source

unknown


*SECURITY_LOGIN_WITHOUT_CONFIRMATION

Allow users to login without first confirming their email address.

Invenio RDM Default Value

True

Type

bool

Source

invenio-accounts

Set by

configure_generic_parameters()


SECURITY_LOGOUT_URL

URL endpoint for logout.

Invenio RDM Default Value

'/logout/'

Type

str

Source

invenio-accounts


SECURITY_MSG_ALREADY_CONFIRMED

Default Value

<tuple>

Type

tuple

Source

unknown

('Your email has already been confirmed.', 'info')

SECURITY_MSG_CONFIRMATION_EXPIRED

Default Value

<tuple>

Type

tuple

Source

unknown

('You did not confirm your email within %(within)s. New instructions to confirm your '
 'email have been sent to %(email)s.',
 'error')

SECURITY_MSG_CONFIRMATION_REQUEST

Default Value

<tuple>

Type

tuple

Source

unknown

('Confirmation instructions have been sent to %(email)s.', 'info')

SECURITY_MSG_CONFIRMATION_REQUIRED

Default Value

<tuple>

Type

tuple

Source

unknown

('Email requires confirmation.', 'error')

SECURITY_MSG_CONFIRM_REGISTRATION

Default Value

<tuple>

Type

tuple

Source

unknown

('Thank you. Confirmation instructions have been sent to %(email)s.', 'success')

SECURITY_MSG_DISABLED_ACCOUNT

Default Value

<tuple>

Type

tuple

Source

unknown

('Account is disabled.', 'error')

SECURITY_MSG_EMAIL_ALREADY_ASSOCIATED

Default Value

<tuple>

Type

tuple

Source

unknown

('%(email)s is already associated with an account.', 'error')

SECURITY_MSG_EMAIL_CONFIRMED

Default Value

<tuple>

Type

tuple

Source

unknown

('Thank you. Your email has been confirmed.', 'success')

SECURITY_MSG_EMAIL_NOT_PROVIDED

Default Value

<tuple>

Type

tuple

Source

unknown

('Email not provided', 'error')

SECURITY_MSG_FORGOT_PASSWORD

Default Value

<tuple>

Type

tuple

Source

unknown

('Forgot password?', 'info')

SECURITY_MSG_INVALID_CONFIRMATION_TOKEN

Default Value

<tuple>

Type

tuple

Source

unknown

('Invalid confirmation token.', 'error')

SECURITY_MSG_INVALID_EMAIL_ADDRESS

Default Value

<tuple>

Type

tuple

Source

unknown

('Invalid email address', 'error')

SECURITY_MSG_INVALID_LOGIN_TOKEN

Default Value

<tuple>

Type

tuple

Source

unknown

('Invalid login token.', 'error')

SECURITY_MSG_INVALID_PASSWORD

Default Value

<tuple>

Type

tuple

Source

unknown

('Invalid password', 'error')

SECURITY_MSG_INVALID_REDIRECT

Default Value

<tuple>

Type

tuple

Source

unknown

('Redirections outside the domain are forbidden', 'error')

SECURITY_MSG_INVALID_RESET_PASSWORD_TOKEN

Default Value

<tuple>

Type

tuple

Source

unknown

('Invalid reset password token.', 'error')

SECURITY_MSG_LOCAL_LOGIN_DISABLED

The error to be displayed in REST login when local login is disabled.

Invenio RDM Default Value

<tuple>

Type

tuple

Source

invenio-accounts

('Local login is disabled.', 'error')

SECURITY_MSG_LOGIN

Default Value

<tuple>

Type

tuple

Source

unknown

('Please log in to access this page.', 'info')

SECURITY_MSG_LOGIN_EMAIL_SENT

Default Value

<tuple>

Type

tuple

Source

unknown

('Instructions to login have been sent to %(email)s.', 'success')

SECURITY_MSG_LOGIN_EXPIRED

Default Value

<tuple>

Type

tuple

Source

unknown

('You did not login within %(within)s. New instructions to login have been sent to '
 '%(email)s.',
 'error')

SECURITY_MSG_PASSWORD_BREACHED

Default Value

<tuple>

Type

tuple

Source

unknown

('Password on breached list', 'error')

SECURITY_MSG_PASSWORD_BREACHED_SITE_ERROR

Default Value

<tuple>

Type

tuple

Source

unknown

('Failed to contact breached passwords site', 'error')

SECURITY_MSG_PASSWORD_CHANGE

Default Value

<tuple>

Type

tuple

Source

unknown

('You successfully changed your password.', 'success')

SECURITY_MSG_PASSWORD_CHANGE_DISABLED

The error to be displayed in REST password change when it is disabled.

Invenio RDM Default Value

<tuple>

Type

tuple

Source

invenio-accounts

('Password change is disabled.', 'error')

SECURITY_MSG_PASSWORD_INVALID_LENGTH

Default Value

<tuple>

Type

tuple

Source

unknown

('Password must be at least %(length)s characters', 'error')

SECURITY_MSG_PASSWORD_IS_THE_SAME

Default Value

<tuple>

Type

tuple

Source

unknown

('Your new password must be different than your previous password.', 'error')

SECURITY_MSG_PASSWORD_MISMATCH

Default Value

<tuple>

Type

tuple

Source

unknown

('Password does not match', 'error')

SECURITY_MSG_PASSWORD_NOT_PROVIDED

Default Value

<tuple>

Type

tuple

Source

unknown

('Password not provided', 'error')

SECURITY_MSG_PASSWORD_NOT_SET

Default Value

<tuple>

Type

tuple

Source

unknown

('No password is set for this user', 'error')

SECURITY_MSG_PASSWORD_RECOVERY_DISABLED

Invenio RDM Default Value

<tuple>

Type

tuple

Source

invenio-accounts

('Password recovery is disabled.', 'error')

SECURITY_MSG_PASSWORD_RESET

Default Value

<tuple>

Type

tuple

Source

unknown

('You successfully reset your password and you have been logged in automatically.',
 'success')

SECURITY_MSG_PASSWORD_RESET_DISABLED

The error to be displayed in REST password reset when it is disabled.

Invenio RDM Default Value

<tuple>

Type

tuple

Source

invenio-accounts

('Password reset is disabled.', 'error')

SECURITY_MSG_PASSWORD_RESET_EXPIRED

Default Value

<tuple>

Type

tuple

Source

unknown

('You did not reset your password within %(within)s. New instructions have been sent '
 'to %(email)s.',
 'error')

SECURITY_MSG_PASSWORD_RESET_REQUEST

Default Value

<tuple>

Type

tuple

Source

unknown

('Instructions to reset your password have been sent to %(email)s.', 'info')

SECURITY_MSG_PASSWORD_TOO_SIMPLE

Default Value

<tuple>

Type

tuple

Source

unknown

('Password not complex enough', 'error')

SECURITY_MSG_REFRESH

Default Value

<tuple>

Type

tuple

Source

unknown

('Please reauthenticate to access this page.', 'info')

SECURITY_MSG_REGISTRATION_DISABLED

The error to be displayed in REST registration when it is disabled.

Invenio RDM Default Value

<tuple>

Type

tuple

Source

invenio-accounts

('Registration is disabled.', 'error')

SECURITY_MSG_RETYPE_PASSWORD_MISMATCH

Default Value

<tuple>

Type

tuple

Source

unknown

('Passwords do not match', 'error')

SECURITY_MSG_UNAUTHORIZED

Default Value

<tuple>

Type

tuple

Source

unknown

('You do not have permission to view this resource.', 'error')

SECURITY_MSG_USER_DOES_NOT_EXIST

Default Value

<tuple>

Type

tuple

Source

unknown

('Specified user does not exist', 'error')

SECURITY_PASSWORD_BREACHED_COUNT

Default Value

1

Type

int

Source

unknown


SECURITY_PASSWORD_CHECK_BREACHED

Default Value

False

Type

bool

Source

unknown


SECURITY_PASSWORD_COMPLEXITY_CHECKER

Default Value

None

Type

NoneType

Source

unknown


SECURITY_PASSWORD_HASH

Default password hashing algorithm for new passwords.

Invenio RDM Default Value

'pbkdf2_sha512'

Type

str

Source

invenio-accounts


SECURITY_PASSWORD_LENGTH_MIN

Default Value

6

Type

int

Source

unknown


SECURITY_PASSWORD_SALT

Salt for storing passwords.

Invenio RDM Default Value

'CHANGE_ME'

Type

str

Source

invenio-accounts


SECURITY_PASSWORD_SCHEMES

Supported password hashing algorithms (for passwords already stored).

You should include both the default, supported and any deprecated schemes.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-accounts

['pbkdf2_sha512', 'invenio_aes_encrypted_email']

SECURITY_PASSWORD_SINGLE_HASH

Password hashing algorithms requiring single hasing only.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-accounts

['invenio_aes_encrypted_email']

SECURITY_POST_CHANGE_VIEW

Default Value

None

Type

NoneType

Source

unknown


SECURITY_POST_CONFIRM_VIEW

Default Value

None

Type

NoneType

Source

unknown


SECURITY_POST_LOGIN_VIEW

Default Value

'/'

Type

str

Source

unknown


SECURITY_POST_LOGOUT_VIEW

Default Value

'/'

Type

str

Source

unknown


SECURITY_POST_REGISTER_VIEW

Default Value

None

Type

NoneType

Source

unknown


SECURITY_POST_RESET_VIEW

Default Value

None

Type

NoneType

Source

unknown


*SECURITY_RECOVERABLE

Allow password recovery by users.

Invenio RDM Default Value

True

Type

bool

Source

invenio-accounts

Set by

configure_generic_parameters()


*SECURITY_REGISTERABLE

Allow users to register.

Invenio RDM Default Value

True

Type

bool

Source

invenio-accounts

Set by

configure_generic_parameters()


SECURITY_REGISTER_URL

URL endpoint for user registation.

Invenio RDM Default Value

'/signup/'

Type

str

Source

invenio-accounts


SECURITY_REGISTER_USER_TEMPLATE

Default template for user registration.

Invenio RDM Default Value

'invenio_accounts/register_user.html'

Type

str

Source

invenio-accounts


SECURITY_RESET_PASSWORD_TEMPLATE

Default template for password recovery (reset of the password).

Invenio RDM Default Value

'invenio_accounts/reset_password.html'

Type

str

Source

invenio-accounts


SECURITY_RESET_PASSWORD_WITHIN

Amount of time the password reset link is active.

Note, since the confirmation link will also login the associated user we expire the link fast.

Invenio RDM Default Value

'30 minutes'

Type

str

Source

invenio-accounts


SECURITY_RESET_SALT

Default Value

'reset-salt'

Type

str

Source

unknown


SECURITY_RESET_URL

URL endpoint for password recovery.

Invenio RDM Default Value

'/lost-password/'

Type

str

Source

invenio-accounts


SECURITY_SEND_CONFIRMATION_TEMPLATE

Default template for email confirmation.

Invenio RDM Default Value

'invenio_accounts/send_confirmation.html'

Type

str

Source

invenio-accounts


SECURITY_SEND_LOGIN_TEMPLATE

Default template for email confirmation.

Invenio RDM Default Value

'invenio_accounts/send_login.html'

Type

str

Source

invenio-accounts


SECURITY_SEND_PASSWORD_CHANGE_EMAIL

Default Value

True

Type

bool

Source

unknown


SECURITY_SEND_PASSWORD_RESET_EMAIL

Default Value

True

Type

bool

Source

unknown


SECURITY_SEND_PASSWORD_RESET_NOTICE_EMAIL

Default Value

True

Type

bool

Source

unknown


SECURITY_SEND_REGISTER_EMAIL

Default Value

True

Type

bool

Source

unknown


SECURITY_SUBDOMAIN

Default Value

None

Type

NoneType

Source

unknown


SECURITY_TOKEN_AUTHENTICATION_HEADER

Default Value

'Authentication-Token'

Type

str

Source

unknown


SECURITY_TOKEN_AUTHENTICATION_KEY

Default Value

'auth_token'

Type

str

Source

unknown


SECURITY_TOKEN_MAX_AGE

Default Value

None

Type

NoneType

Source

unknown


SECURITY_TRACKABLE

Enable user tracking on login.

Invenio RDM Default Value

True

Type

bool

Source

invenio-accounts


SECURITY_URL_PREFIX

Default Value

None

Type

NoneType

Source

unknown


SECURITY_USER_IDENTITY_ATTRIBUTES

Default Value

<list>

Type

list

Source

unknown

['email']

SECURITY_ZXCVBN_MINIMUM_SCORE

Default Value

3

Type

int

Source

unknown


*SEND_FILE_MAX_AGE_DEFAULT

Default Value

None

Type

NoneType

Source

unknown

Set by

configure_generic_parameters()


SENTRY_DSN

Set SENTRY_DSN environment variable.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-logging


SERVER_NAME

Default Value

None

Type

NoneType

Source

unknown


SESSION_KEY_BITS

Default Value

64

Type

int

Source

unknown


SESSION_RANDOM_SOURCE

Default Value

<random.SystemRandom object at 0x55ca61a40060>

Type

SystemRandom

Source

unknown


SESSION_REFRESH_EACH_REQUEST

Default Value

True

Type

bool

Source

unknown


*SETTINGS_TEMPLATE

Settings page template used for e.g. display user settings views.

Invenio RDM Default Value

'invenio_theme/page_settings.html'

Type

str

Sources

invenio-theme; invenio-app-rdm

Set by

configure_ui()


SITEMAP_MAX_ENTRY_COUNT

Maximum number of entries (<url> or <sitemap>) per file.

The Sitemap protocol sets it at 50_000, but it also sets the max size of the resulting file at 50 MiB. Following the initial Zenodo implementation, we set it much lower than 50_000 so as to not have to check for generated size.

Following the initial Zenodo implementation, we use the same config for the number of entries in the Sitemap Index and Sitemap files.

Invenio RDM Default Value

10000

Type

int

Source

invenio-sitemap


SITEMAP_ROOT_VIEW_ENABLED

Enable the /sitemap.xml endpoint serving the first sitemap index.

Invenio RDM Default Value

True

Type

bool

Source

invenio-sitemap


SITEMAP_SECTIONS

Instances of sitemap.SitemapSection that will populate the Sitemap files.

Invenio RDM Default Value

<list>

Type

list

Sources

invenio-sitemap; invenio-app-rdm

[]

*SITE_API_URL

Invenio RDM Default Value

'https://127.0.0.1:5000/api'

Type

str

Source

invenio-records-resources

Set by

configure_generic_parameters()


*SITE_UI_URL

Invenio RDM Default Value

'https://127.0.0.1:5000'

Type

str

Source

invenio-records-resources

Set by

configure_generic_parameters()


SQLALCHEMY_BINDS

Default Value

<dict>

Type

dict

Source

unknown

{}

*SQLALCHEMY_DATABASE_URI

Invenio RDM Default Value

'sqlite:////opt/hostedtoolcache/Python/3.14.6/x64/var/instance/invenio.db'

Type

str

Source

invenio-app-rdm

Set by

configure_generic_parameters()


SQLALCHEMY_ECHO

Enable to see all SQL queries.

Invenio RDM Default Value

False

Type

bool

Source

invenio-app-rdm


SQLALCHEMY_ENGINE_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app-rdm

{}

SQLALCHEMY_RECORD_QUERIES

Default Value

False

Type

bool

Source

unknown


SQLALCHEMY_TRACK_MODIFICATIONS

Default Value

True

Type

bool

Source

unknown


STATS_AGGREGATIONS

Invenio RDM Default Value

<dict>

Type

dict

Sources

invenio-stats; invenio-app-rdm

{}

STATS_EVENTS

Enabled Events.

Each key is the name of an event. A queue will be created for each event.

If the dict of an event contains the signal key, and the config variable STATS_REGISTER_RECEIVERS is True, a signal receiver will be registered. Receiver function which will be connected on a signal and emit events. The key is the name of the emitted event.

signal: Signal to which the receiver will be connected to.

event_builders: list of functions which will create and enhance the event.

Each function will receive the event created by the previous function and can update it. Keep in mind that these functions will run synchronously during the creation of the event, meaning that if the signal is sent during a request they will increase the response time.

You can find a sampe of STATS_EVENT configuration in the registrations.py

Invenio RDM Default Value

<dict>

Type

dict

Sources

invenio-stats; invenio-app-rdm

{}

STATS_EVENTS_UTC_DATETIME_ENABLED

Enable timezone-aware UTC datetimes for event timestamps.

When set to False (default), naive UTC datetimes are used (tzinfo is stripped via datetime.replace(tzinfo=None)). Set to True to use timezone-aware UTC datetimes with explicit UTC timezone information.

Invenio RDM Default Value

False

Type

bool

Source

invenio-stats


STATS_MQ_EXCHANGE

Invenio RDM Default Value

Exchange('events', type='direct', delivery_mode='transient')

Type

unknown

Source

invenio-stats


STATS_PERMISSION_FACTORY

Permission factory used by the statistics REST API.

This is a function which returns a permission granting or forbidding access to a request. It is of the form permission_factory(query_name, params) where query_name is the name of the statistic requested by the user and params is a dict of parameters for this statistic. The result of the function is a Permission.

See Invenio-access and Flask-principal for a better understanding of the access control mechanisms.

Invenio RDM Default Value

default_permission_factory

Type

unknown

Sources

invenio-stats; invenio-app-rdm


STATS_QUERIES

Invenio RDM Default Value

<dict>

Type

dict

Sources

invenio-stats; invenio-app-rdm

{}

STATS_REGISTER_INDEX_TEMPLATES

Register templates as index templates.

Default behaviour will register the templates as search templates.

Invenio RDM Default Value

False

Type

bool

Source

invenio-stats


*STATS_REGISTER_RECEIVERS

Enable the registration of signal receivers.

Default is True. The signal receivers are functions which will listen to the signals listed in by the STATS_EVENTS config variable. An event will be generated for each signal sent.

Invenio RDM Default Value

True

Type

bool

Source

invenio-stats

Set by

configure_stats()


TEMPLATES_AUTO_RELOAD

Default Value

None

Type

NoneType

Source

unknown


TESTING

Default Value

False

Type

bool

Source

unknown


THEME_401_TEMPLATE

The template used for 401 Unauthorized errors.

Invenio RDM Default Value

'invenio_theme/401.html'

Type

str

Source

invenio-theme


THEME_403_TEMPLATE

The template used for 403 Forbidden errors.

Invenio RDM Default Value

'invenio_theme/403.html'

Type

str

Source

invenio-theme


THEME_404_TEMPLATE

The template used for 404 Not Found errors.

Invenio RDM Default Value

'invenio_theme/404.html'

Type

str

Source

invenio-theme


THEME_429_TEMPLATE

The template used for 429 Too Many Requests errors.

Invenio RDM Default Value

'invenio_theme/429.html'

Type

str

Source

invenio-theme


THEME_500_TEMPLATE

The template used for 500 Internal Server Error errors.

Invenio RDM Default Value

'invenio_theme/500.html'

Type

str

Source

invenio-theme


THEME_BASE_TEMPLATE

Template which all templates in Invenio-Theme all extends from.

Defaults to value of BASE_TEMPLATE.

Invenio RDM Default Value

'invenio_theme/page.html'

Type

str

Source

invenio-theme


THEME_COVER_TEMPLATE

Template which all cover templates in Invenio-Theme all extends from.

Defaults to value of COVER_TEMPLATE.

Invenio RDM Default Value

'invenio_theme/page_cover.html'

Type

str

Source

invenio-theme


*THEME_CSS_TEMPLATE

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


THEME_ERROR_TEMPLATE

Base template for error pages.

Invenio RDM Default Value

'invenio_theme/page_error.html'

Type

str

Source

invenio-theme


*THEME_FRONTPAGE

Enable or disable basic frontpage view.

Invenio RDM Default Value

False

Type

bool

Sources

invenio-theme; invenio-app-rdm

Set by

configure_ui()


*THEME_FRONTPAGE_TEMPLATE

Template for front page.

Invenio RDM Default Value

'invenio_theme/frontpage.html'

Type

str

Sources

invenio-theme; invenio-app-rdm

Set by

configure_ui()


*THEME_FRONTPAGE_TITLE

The title shown on the frontpage.

Invenio RDM Default Value

l'Invenio'

Type

LazyString

Sources

invenio-theme; invenio-app-rdm

Set by

configure_ui()


THEME_GENERATOR

Generator meta tag to identify the software that generated the page.

Accepts a string or a func returning a string. Set it to None to disable it.

Invenio RDM Default Value

'Invenio'

Type

str

Sources

invenio-theme; invenio-app-rdm


THEME_GOOGLE_SITE_VERIFICATION

List of Google Site Verification tokens to be used.

This adds the Google Site Verification into the meta tags of all pages.

Invenio RDM Default Value

<list>

Type

list

Source

invenio-theme

[]

*THEME_HEADER_LOGIN_TEMPLATE

Header login template, included in THEME_HEADER_TEMPLATE.

Invenio RDM Default Value

'invenio_theme/header_login.html'

Type

str

Sources

invenio-theme; invenio-app-rdm

Set by

configure_ui()


*THEME_HEADER_TEMPLATE

Header template which is normally included in BASE_TEMPLATE.

Invenio RDM Default Value

'invenio_theme/header.html'

Type

str

Sources

invenio-theme; invenio-app-rdm

Set by

configure_ui()


THEME_ICONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-theme

{'bootstrap3': {'*': 'fa fa-{} fa-fw',
                'codepen': 'fa fa-codepen fa-fw',
                'cogs': 'fa fa-cogs fa-fw',
                'key': 'fa fa-key fa-fw',
                'link': 'fa fa-link fa-fw',
                'shield': 'fa fa-shield fa-fw',
                'user': 'fa fa-user fa-fw'},
 'semantic-ui': {'*': '{} icon',
                 'codepen': 'codepen icon',
                 'cogs': 'cogs icon',
                 'exchange': 'exchange icon',
                 'home': 'home icon',
                 'key': 'key icon',
                 'link': 'linkify icon',
                 'shield': 'shield alternate icon',
                 'star_outline': 'star outline icon',
                 'user': 'user icon',
                 'users': 'users icon'}}

*THEME_JAVASCRIPT_TEMPLATE

Javascript assets template, normally included in BASE_TEMPLATE.

The default template just includes the Invenio-Theme JavaScript bundle. Set a new template if you would like to customize which JavaScript assets are included on all pages.

Invenio RDM Default Value

'invenio_theme/javascript.html'

Type

str

Sources

invenio-theme; invenio-app-rdm

Set by

configure_ui()


THEME_LOGO_ADMIN

The logo to be used on the admin views header.

Invenio RDM Default Value

'images/invenio-white.svg'

Type

str

Source

invenio-theme


THEME_MATHJAX_CDN

MathJax configuration for rendering mathematical formulas.

Invenio RDM Default Value

''

Type

str

Source

invenio-theme


THEME_META_ROBOT_TAGS

Robots meta tag to control indexing of the page.

Accepts a list of dicts that will be converted into meta tag attributes, e.g.:

THEME_META_ROBOT_TAGS = [
    {"name": "robots", "content": "noindex, nofollow"},
    {"name": "googlebot", "content": "noimageindex"},
]

will generate:

<meta name="robots" content="noindex, nofollow">
<meta name="googlebot" content="noimageindex">

Invenio RDM Default Value

<list>

Type

list

Source

invenio-theme

[]

*THEME_SEARCH_ENDPOINT

The endpoint for the search bar.

Invenio RDM Default Value

'/search'

Type

str

Source

invenio-theme

Set by

configure_ui()


THEME_SETTINGS_TEMPLATE

Template which all settings templates in Invenio-Theme all extends from.

Defaults to value of SETTINGS_TEMPLATE.

Invenio RDM Default Value

'invenio_theme/page_settings.html'

Type

str

Source

invenio-theme


*THEME_SHOW_FRONTPAGE_INTRO_SECTION

Front page intro section visibility

Invenio RDM Default Value

True

Type

unknown

Source

invenio-app-rdm

Set by

configure_ui()


*THEME_SITENAME

The name of the site to be used on the header and as a title.

Invenio RDM Default Value

l'Invenio'

Type

LazyString

Sources

invenio-theme; invenio-app-rdm

Set by

configure_ui()


THEME_SITEURL

Invenio RDM Default Value

'http://127.0.0.1:5000'

Type

str

Source

invenio-rdm-records


*THEME_TRACKINGCODE_TEMPLATE

Template for including a tracking code for web analytics.

The default template does not include any tracking code.

Invenio RDM Default Value

'invenio_theme/trackingcode.html'

Type

str

Source

invenio-theme

Set by

configure_ui()


THEME_TWITTERHANDLE

Twitter handle.

Invenio RDM Default Value

''

Type

unknown

Source

invenio-app-rdm


TRAP_BAD_REQUEST_ERRORS

Default Value

None

Type

NoneType

Source

unknown


TRAP_HTTP_EXCEPTIONS

Default Value

False

Type

bool

Source

unknown


TRUSTED_HOSTS

A list of host/domain names that can be served.

This is a security measure to prevent HTTP Host header attacks, which are possible even under many seemingly-safe web server configurations.

By default all hosts are allowed. Values in this list can be fully qualified names (e.g. ‘www.example.com’). The validation only applies to request.host.

In addition to this configuration variable, you should make sure that your web server does not route requests to the application with an invalid Host header.

Invenio RDM Default Value

None

Type

NoneType

Sources

invenio-app; invenio-app-rdm


TYPE_CHECKING

Default Value

False

Type

bool

Source

unknown


USERPROFILES

Enable or disable module extensions.

Invenio RDM Default Value

True

Type

bool

Source

invenio-userprofiles


USERPROFILES_BASE_TEMPLATE

Base templates for user profile module.

Invenio RDM Default Value

'invenio_theme/page.html'

Type

str

Source

invenio-userprofiles


USERPROFILES_EMAIL_ENABLED

Include the user email in the profile form.

Invenio RDM Default Value

True

Type

bool

Source

invenio-userprofiles


USERPROFILES_EXTEND_SECURITY_FORMS

Extend the Invenio-Accounts user registration forms.

Invenio RDM Default Value

False

Type

bool

Sources

invenio-userprofiles; invenio-app-rdm


USERPROFILES_PROFILE_TEMPLATE

Default profile template.

Invenio RDM Default Value

'invenio_userprofiles/settings/profile.html'

Type

str

Source

invenio-userprofiles


USERPROFILES_PROFILE_URL

Default profile URL endpoint.

Invenio RDM Default Value

'/account/settings/profile/'

Type

str

Source

invenio-userprofiles


*USERPROFILES_READ_ONLY

Make the user profiles read-only.

Invenio RDM Default Value

False

Type

bool

Source

invenio-userprofiles

Set by

configure_generic_parameters(), configure_einfra_oidc()


USERPROFILES_SETTINGS_TEMPLATE

Settings base templates for user profile module.

Invenio RDM Default Value

'invenio_theme/page_settings.html'

Type

str

Source

invenio-userprofiles


USERS_RESOURCES_AVATAR_COLORS

Invenio RDM Default Value

<list>

Type

list

Source

invenio-users-resources

['#e06055',
 '#ff8a65',
 '#e91e63',
 '#f06292',
 '#673ab7',
 '#ba68c8',
 '#7986cb',
 '#3f51b5',
 '#5e97f6',
 '#00a4e4',
 '#4dd0e1',
 '#0097a7',
 '#d4e157',
 '#aed581',
 '#57bb8a',
 '#4db6ac',
 '#607d8b',
 '#795548',
 '#a1887f',
 '#fdd835',
 '#a3a3a3',
 '#556c60',
 '#605264',
 '#923035',
 '#915a30',
 '#55526f',
 '#67635a']

USERS_RESOURCES_DOMAINS_ORG_SCHEMA

Domains organisation schema config.

Invenio RDM Default Value

OrgPropsSchema

Type

unknown

Source

invenio-users-resources


USERS_RESOURCES_DOMAINS_SEARCH_FACETS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-users-resources

{'category': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7eb3e270>,
              'ui': {'field': 'category'}},
 'flagged': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7ead8850>,
             'ui': {'field': 'flagged'}},
 'organisation': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7eb3e2e0>,
                  'ui': {'field': 'organisation'}},
 'status': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7ead83d0>,
            'ui': {'field': 'status'}},
 'tld': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7eb3e6d0>,
         'ui': {'field': 'tld'}}}

USERS_RESOURCES_DOMAINS_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-users-resources

{'bestmatch': {'fields': ['_score'], 'title': l'Best match'},
 'domain': {'fields': ['domain', '-created'], 'title': l'Domain'},
 'newest': {'fields': ['-created'], 'title': l'Newest'},
 'num-active': {'fields': ['-num_active'], 'title': l'# Active'},
 'num-blocked': {'fields': ['-num_blocked'], 'title': l'# Blocked'},
 'num-confirmed': {'fields': ['-num_confirmed'], 'title': l'# Confirmed'},
 'num-inactive': {'fields': ['-num_inactive'], 'title': l'# Inactive'},
 'num-users': {'fields': ['-num_users'], 'title': l'# Users'},
 'num-verified': {'fields': ['-num_verified'], 'title': l'# Verified'},
 'oldest': {'fields': ['created'], 'title': l'Oldest'},
 'updated': {'fields': ['-updated'], 'title': l'Recently updated'}}

USERS_RESOURCES_GROUPS_ADMIN_FACETS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-users-resources

{'is_managed': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c834e41a0>,
                'ui': {'field': 'is_managed'}}}

USERS_RESOURCES_GROUPS_ADMIN_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-users-resources

{'bestmatch': {'fields': ['_score'], 'title': l'Best match'},
 'managed': {'fields': ['-is_managed', 'name.keyword'], 'title': l'Managed first'},
 'name': {'fields': ['name.keyword'], 'title': l'Name (A-Z)'},
 'name_desc': {'fields': ['-name.keyword'], 'title': l'Name (Z-A)'},
 'unmanaged': {'fields': ['is_managed', 'name.keyword'], 'title': l'Unmanaged first'}}

USERS_RESOURCES_GROUPS_ENABLED

Config to enable features related to existence of groups.

Invenio RDM Default Value

True

Type

bool

Source

invenio-users-resources


USERS_RESOURCES_MODERATION_LOCK_DEFAULT_TIMEOUT

Default timeout, in seconds, to lock a user when moderating.

Invenio RDM Default Value

30

Type

int

Source

invenio-users-resources


USERS_RESOURCES_MODERATION_LOCK_RENEWAL_TIMEOUT

Renewal timeout, in seconds, to increase the lock time for a user when moderating.

Invenio RDM Default Value

120

Type

int

Source

invenio-users-resources


USERS_RESOURCES_PROTECTED_GROUP_NAMES

Invenio RDM Default Value

<list>

Type

list

Source

invenio-users-resources

['admin', 'administration', 'superuser-access', 'administration-moderation']

USERS_RESOURCES_SEARCH_FACETS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-users-resources

{'affiliations': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7eb3e7b0>,
                  'ui': {'field': 'profile.affiliations.keyword'}},
 'domain': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7eb3e740>,
            'ui': {'field': 'domain'}},
 'domain_status': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7eb3e200>,
                   'ui': {'field': 'domain_status'}},
 'roles': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7eb3e970>,
           'facet_options': {'size': 100},
           'ui': {'field': 'roles'}},
 'status': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7eb3e820>,
            'ui': {'field': 'status'}},
 'visibility': {'facet': <invenio_records_resources.services.records.facets.facets.TermsFacet object at 0x7f4c7eb3e900>,
                'ui': {'field': 'visibility'}}}

USERS_RESOURCES_SERVICE_SCHEMA

Schema used by the users service.

Invenio RDM Default Value

UserSchema

Type

unknown

Sources

invenio-users-resources; invenio-app-rdm


USERS_RESOURCES_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-users-resources

{'bestmatch': {'fields': ['_score'], 'title': l'Best match'},
 'domain': {'fields': ['domain', '-created'], 'title': l'Domain'},
 'email': {'fields': ['email_hidden', '-created'], 'title': l'Email'},
 'newest': {'fields': ['-created'], 'title': l'Newest'},
 'oldest': {'fields': ['created'], 'title': l'Oldest'},
 'updated': {'fields': ['-updated'], 'title': l'Recently updated'},
 'username': {'fields': ['username.keyword', '-created'], 'title': l'Username'}}

USER_DASHBOARD_MENU_OVERRIDES

Overrides for “dashboard” menu.

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-app-rdm

{}

USE_X_SENDFILE

Default Value

False

Type

bool

Source

unknown


VCS_TEMPLATE_INDEX

Invenio RDM Default Value

'invenio_vcs/rdm-index.html'

Type

unknown

Source

invenio-app-rdm


VCS_TEMPLATE_INDEX_ITEM

Invenio RDM Default Value

'invenio_vcs/rdm-index-item.html'

Type

unknown

Source

invenio-app-rdm


VCS_TEMPLATE_RELEASE_ITEM

Invenio RDM Default Value

'invenio_vcs/rdm-release-item.html'

Type

unknown

Source

invenio-app-rdm


VCS_TEMPLATE_REPO_SWITCH

Invenio RDM Default Value

'invenio_vcs/rdm-repo-switch.html'

Type

unknown

Source

invenio-app-rdm


VCS_TEMPLATE_VIEW

Invenio RDM Default Value

'invenio_vcs/rdm-view.html'

Type

unknown

Source

invenio-app-rdm


VOCABULARIES_AFFILIATIONS_EDMO_COUNTRY_MAPPING

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-vocabularies

{'Cape Verde': 'Cabo Verde'}

*VOCABULARIES_AFFILIATION_SCHEMES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-vocabularies

Set by

configure_generic_parameters()

{'edmo': {'label': l'EDMO', 'validator': <function is_edmo at 0x7f4c82892fb0>},
 'gnd': {'label': l'GND', 'validator': <function is_gnd at 0x7f4c893fa400>},
 'grid': {'label': l'GRID', 'validator': <function <lambda> at 0x7f4c83262da0>},
 'isni': {'label': l'ISNI', 'validator': <function is_isni at 0x7f4c893f9a60>},
 'pic': {'label': l'PIC', 'validator': <function is_pic at 0x7f4c82891430>},
 'ror': {'label': l'ROR', 'validator': <function is_ror at 0x7f4c893fae50>}}

VOCABULARIES_AWARDS_EC_ROR_ID

ROR ID for EC funder.

Invenio RDM Default Value

'00k4n6c32'

Type

str

Source

invenio-vocabularies


VOCABULARIES_AWARDS_OPENAIRE_FUNDERS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-vocabularies

{'100012733___': '03xkf7525',
 '100013433___': '054tsxk98',
 '100015319___': '04bnxk453',
 '100019637___': '003mr9q86',
 '100022943___': '02g8v2v69',
 '501100001581': '02dd61a62',
 '501100001587': '04q0a4f84',
 '501100001630': '051sx6d27',
 '501100001635': '00a0n9e72',
 '501100001638': '04a1a1e81',
 '501100011626': '04q0a4f84',
 'aka_________': '05k73zm37',
 'anr_________': '00rbzpz17',
 'arc_________': '05mmh0f86',
 'asap________': '03zj4c476',
 'cf__________': '01kpjmx04',
 'cihr________': '01gavpb45',
 'corda_______': '00k4n6c32',
 'corda_____he': '00k4n6c32',
 'corda__h2020': '00k4n6c32',
 'dfgf________': '018mejw64',
 'drf_________': '004j3q729',
 'erasmusplus_': '00k4n6c32',
 'euenvagency_': '02k4b9v70',
 'fcf_________': '027xav248',
 'fct_________': '00snfqn58',
 'fmf_________': '0593mby10',
 'fwf_________': '013tf3c58',
 'hsf_________': '05tdna171',
 'ibf_________': '04jsz6e67',
 'inca________': '03m8vkq32',
 'irb_hr______': '03n51vw80',
 'irfd________': '05svhj534',
 'jaef________': '03vxy9y38',
 'kaute_______': '00zwv5854',
 'kf__________': '05jwty529',
 'lcs_________': '02ar66p97',
 'lf__________': '03hz8wd80',
 'mestd_______': '01znas443',
 'mtnf________': '047egay20',
 'mvt_________': '019pxzh98',
 'nhmrc_______': '011kf5r70',
 'nih_________': '01cwqze88',
 'nnf_________': '04txyc737',
 'nserc_______': '01h531d29',
 'nsf_________': '021nxhr62',
 'nwo_________': '04jsz6e67',
 'pf__________': '048e7gn38',
 'pnf_________': '009vp0837',
 'rcn_________': '00epmv149',
 'rcuk________': '00dq2kk65',
 'rif_________': '00en9ce74',
 'sfi_________': '0271asj38',
 'snsf________': '00yjd3n13',
 'sshrc_______': '006cvnv84',
 'sslf________': '04a31ep84',
 'tubitakf____': '04w9kkr77',
 'twcf________': '00x0z1472',
 'ukri________': '001aqnf71',
 've__________': '05nqkay65',
 'vf__________': '013w1n936',
 'wt__________': '029chgv08'}

VOCABULARIES_AWARD_SCHEMES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-vocabularies

{'doi': {'label': l'DOI', 'validator': <function is_doi at 0x7f4c897bd850>},
 'url': {'label': l'URL', 'validator': <function is_url at 0x7f4c893f9d20>}}

VOCABULARIES_CF

Default Value

<list>

Type

list

Source

unknown

[]

VOCABULARIES_CUSTOM_VOCABULARY_TYPES

Invenio RDM Default Value

<list>

Type

list

Source

invenio-vocabularies

['names', 'affiliations', 'awards', 'funders', 'subjects']

*VOCABULARIES_DATASTREAM_READERS

Invenio RDM Default Value

<dict>

Type

dict

Sources

invenio-vocabularies; invenio-app-rdm

Set by

configure_generic_parameters(), configure_datastreams()

{'csv': <class 'invenio_vocabularies.datastreams.readers.CSVReader'>,
 'gzip': <class 'invenio_vocabularies.datastreams.readers.GzipReader'>,
 'http': <class 'invenio_vocabularies.datastreams.readers.SimpleHTTPReader'>,
 'json': <class 'invenio_vocabularies.datastreams.readers.JsonReader'>,
 'jsonl': <class 'invenio_vocabularies.datastreams.readers.JsonLinesReader'>,
 'oai-pmh': <class 'invenio_vocabularies.datastreams.readers.OAIPMHReader'>,
 'rdf': <class 'invenio_vocabularies.datastreams.readers.RDFReader'>,
 'sparql': <class 'invenio_vocabularies.datastreams.readers.SPARQLReader'>,
 'tar': <class 'invenio_vocabularies.datastreams.readers.TarReader'>,
 'xml': <class 'invenio_vocabularies.datastreams.readers.XMLReader'>,
 'yaml': <class 'invenio_vocabularies.datastreams.readers.YamlReader'>,
 'zip': <class 'invenio_vocabularies.datastreams.readers.ZipReader'>}

*VOCABULARIES_DATASTREAM_TRANSFORMERS

Invenio RDM Default Value

<dict>

Type

dict

Sources

invenio-vocabularies; invenio-app-rdm

Set by

configure_generic_parameters(), configure_datastreams()

{'xml': <class 'invenio_vocabularies.datastreams.transformers.XMLTransformer'>}

*VOCABULARIES_DATASTREAM_WRITERS

Invenio RDM Default Value

<dict>

Type

dict

Sources

invenio-vocabularies; invenio-app-rdm

Set by

configure_generic_parameters(), configure_datastreams()

{'async': <class 'invenio_vocabularies.datastreams.writers.AsyncWriter'>,
 'service': <class 'invenio_vocabularies.datastreams.writers.ServiceWriter'>,
 'yaml': <class 'invenio_vocabularies.datastreams.writers.YamlWriter'>}

VOCABULARIES_FACET_CACHE_SIZE

OARepo Default Value

2048

Type

int

Source

oarepo-vocabularies


VOCABULARIES_FACET_CACHE_TTL

OARepo Default Value

34560

Type

int

Source

oarepo-vocabularies


VOCABULARIES_FUNDER_DOI_PREFIX

DOI prefix for the identifier formed with the FundRef id.

Invenio RDM Default Value

'10.13039'

Type

str

Source

invenio-vocabularies


*VOCABULARIES_FUNDER_SCHEMES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-vocabularies

Set by

configure_generic_parameters()

{'doi': {'label': l'DOI', 'validator': <function is_doi at 0x7f4c897bd850>},
 'gnd': {'label': l'GND', 'validator': <function is_gnd at 0x7f4c893fa400>},
 'grid': {'label': l'GRID', 'validator': <function <lambda> at 0x7f4c83262da0>},
 'isni': {'label': l'ISNI', 'validator': <function is_isni at 0x7f4c893f9a60>},
 'ror': {'label': l'ROR', 'validator': <function is_ror at 0x7f4c893fae50>}}

VOCABULARIES_IDENTIFIER_SCHEMES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-vocabularies

{'gnd': {'label': l'GND', 'validator': <function is_gnd at 0x7f4c893fa400>},
 'grid': {'label': l'GRID', 'validator': <function <lambda> at 0x7f4c83262da0>},
 'isni': {'label': l'ISNI', 'validator': <function is_isni at 0x7f4c893f9a60>},
 'ror': {'label': l'ROR', 'validator': <function is_ror at 0x7f4c893fae50>}}

*VOCABULARIES_NAMES_SCHEMES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-vocabularies

Set by

configure_generic_parameters()

{'gnd': {'datacite': 'GND',
         'label': l'GND',
         'validator': <function is_gnd at 0x7f4c893fa400>},
 'isni': {'datacite': 'ISNI',
          'label': l'ISNI',
          'validator': <function is_isni at 0x7f4c893f9a60>},
 'orcid': {'datacite': 'ORCID',
           'label': l'ORCID',
           'validator': <function is_orcid at 0x7f4c893f9b10>}}

VOCABULARIES_ORCID_ACCESS_KEY

ORCID access key to access the s3 bucket.

Invenio RDM Default Value

'CHANGEME'

Type

str

Source

invenio-vocabularies


VOCABULARIES_ORCID_ORG_IDS_MAPPING_PATH

Path to the CSV file for mapping ORCiD organization IDs to affiliation IDs.

The path can be specified as either an absolute path or a relative path within the Flask app instance folder (i.e. current_app.instance_path).

The CSV file should have the following columns:

  • org_scheme: The ORCiD organization ID.

  • org_id: The ORCiD organization ID.

  • aff_id: The affiliation ID to map to.

Invenio RDM Default Value

None

Type

NoneType

Source

invenio-vocabularies


VOCABULARIES_ORCID_SECRET_KEY

ORCID secret key to access the s3 bucket.

Invenio RDM Default Value

'CHANGEME'

Type

str

Source

invenio-vocabularies


VOCABULARIES_ORCID_SUMMARIES_BUCKET

ORCID summaries bucket name.

Invenio RDM Default Value

'v3.0-summaries'

Type

str

Source

invenio-vocabularies


VOCABULARIES_ORCID_SYNC_MAX_WORKERS

ORCID max number of simultaneous workers/connections.

Invenio RDM Default Value

32

Type

int

Source

invenio-vocabularies


VOCABULARIES_ORCID_SYNC_SINCE

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-vocabularies

{'days': 1}

*VOCABULARIES_RESOURCE_CONFIG

Configure the resource.

Invenio RDM Default Value

VocabulariesResourceConfig

Type

unknown

Source

invenio-vocabularies

Set by

configure_generic_parameters()


*VOCABULARIES_SERVICE_CONFIG

Configure the service.

Invenio RDM Default Value

VocabulariesServiceConfig

Type

unknown

Source

invenio-vocabularies

Set by

configure_generic_parameters()


VOCABULARIES_SUBJECTS_EUROSCIVOC_FILE_URL

Subject EuroSciVoc file download link.

Invenio RDM Default Value

'https://publications.europa.eu/resource/distribution/euroscivoc/rdf/skos_ap_eu/EuroSciVoc-skos-ap-e...

Type

str

Source

invenio-vocabularies


VOCABULARIES_SUBJECTS_GEMET_FILE_URL

Invenio RDM Default Value

'https://www.eionet.europa.eu/gemet/latest/gemet.rdf.gz'

Type

str

Source

invenio-vocabularies


VOCABULARIES_SUBJECTS_NVS_FILE_URL

Subject NVS-P02 file download link.

Invenio RDM Default Value

'http://vocab.nerc.ac.uk/collection/P02/current/?_profile=nvs&_mediatype=application/rdf+xml'

Type

str

Source

invenio-vocabularies


VOCABULARIES_SUBJECTS_SCHEMES

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-vocabularies

{'gnd': {'datacite': 'GND',
         'label': l'GND',
         'validator': <function is_gnd at 0x7f4c893fa400>},
 'url': {'label': l'URL', 'validator': <function is_url at 0x7f4c893f9d20>}}

VOCABULARIES_TYPES_SORT_OPTIONS

Invenio RDM Default Value

<dict>

Type

dict

Source

invenio-vocabularies

{'count': {'fields': ['count'], 'title': l'Number of entries'},
 'name': {'fields': ['id'], 'title': l'Name'}}

VOCABULARY_TYPE_UI_RESOURCE

Default Value

'oarepo_vocabularies.ui.resources.vocabulary_type.resource:VocabularyTypeUIResource'

Type

str

Source

unknown


VOCABULARY_TYPE_UI_RESOURCE_CONFIG

Default Value

'oarepo_vocabularies.ui.resources.vocabulary_type.config:VocabularyTypeUIResourceConfig'

Type

str

Source

unknown


WEBPACKEXT_MANIFEST_PATH

Default Value

'dist/manifest.json'

Type

str

Source

unknown


*WEBPACKEXT_NPM_PKG_CLS

Type

configured by function

Source

oarepo-config

Set by

configure_ui()


*WEBPACKEXT_PROJECT

Default Value

'oarepo_ui.webpack:project'

Type

str

Source

unknown

Set by

configure_ui()


WEBPACKEXT_PROJECT_BUILDDIR

Default Value

'/opt/hostedtoolcache/Python/3.14.6/x64/var/instance/assets'

Type

str

Source

unknown


WEBPACKEXT_PROJECT_DISTDIR

Default Value

'/opt/hostedtoolcache/Python/3.14.6/x64/var/instance/static/dist'

Type

str

Source

unknown


WEBPACKEXT_PROJECT_DISTURL

Default Value

'/static/dist'

Type

str

Source

unknown


WORKFLOWS

Default Value

<dict>

Type

dict

Source

unknown

{}

WORKFLOWS_DEFAULT_WORKFLOW

Default Value

'individual'

Type

str

Source

unknown