Installation

To get started with InvenioRDM, you need to install invenio-cli, our command line tool for creating and updating your instance.

Pre-Requirements

Some system requirements are needed beforehand:

Other Python distributions

InvenioRDM targets CPython 3.6 (lowest 3.6.2). Anaconda Python in particular is not currently supported and other Python distributions are not tested.

In addition, make sure the user that will be executing the CLI has access to the docker command (i.e. it is not only available for the root user):

sudo usermod --append --groups docker $USER

Hardware requirements

We usually deploy the RDM in machines that have around 8GB of RAM and at least 4 cores. InvenioRDM can certainly run (for demo purposes) with less, just take into account that you are going to be running between 4 and 8 containers (among them an Elasticsearch container, which is quite demanding).

Once you have installed these requirements, you can install the CLI.

Install the CLI

You can install and manage your InvenioRDM instance using the Invenio CLI package, aptly named invenio-cli. The package is available on PyPI. Use your favorite way to install a Python package:

Via pip:

pip install invenio-cli

Via pipenv:

pipenv install invenio-cli

Via pipx:

pipx install invenio-cli

To make sure you've installed successfully:

invenio-cli --version

invenio-cli, version 0.10.1

CLI version

The CLI is in pre 1.0 release. The last release's version is 0.10.1. Your version may be different than the above.