Home¶
Welcome to the InvenioRDM project!
InvenioRDM is a ready-to-go, turn-key Research Data Management repository. It puts together the Invenio framework so you don't have to.
This documentation walks you through installing, configuring, and deploying your very own InvenioRDM instance. Furthermore, you can customize it for your needs and even add your own extensions! Follow the sections below in order to get a full picture of how to use InvenioRDM, or go straight to what you're interested in - each section is independent.
Install¶
To get started with InvenioRDM, you will want to install invenio-cli, our
command line tool for creating and updating your instance. This tool in turn
allows you to easily install an instance and manage it.
Preview¶
To quickly get a sense for what InvenioRDM is and what it can do, you can preview
the default instance after installing invenio-cli. Just follow the one-page
guide below.
Develop¶
Once you are ready to dive in and work on your own instance - that is, configure, customize, debug, and iterate -, you will want to setup your project for development. Various commands are at your disposal and we walk you through the workflow for how to be effective with them.
> Getting Started on your Instance
Extend¶
InvenioRDM supports a great variety of extensions that can adapt it to your infrastructure. It also supports the addition of custom ones.
Deploy¶
Ready to deploy into production? Follow these guides to put a small instance in production and learn the avenues to take and decisions to make to grow it. Whether you use Openshift or Kubernetes, we've got you covered.
Reference¶
Read up on the internal metadata schema used by InvenioRDM. All fields are detailed here, so you understand what we store and how.
Read up on the Command Line Tool used by InvenioRDM to bootstrap, install and manage the instance and its required services.
> InvenioCLI Reference Document
Contribute¶
InvenioRDM is an open-source project that welcomes contributions. This is how we operate and how you can participate. Contributions don't have to just be code: we love feedback, metadata expertise, community outreach, translations and documentation too.