Installation

Intended audience

The guide is intended for system administrators and developers who want to try, customize or develop with InvenioRDM on their local machine.

Scope

This guide covers how to install InvenioRDM locally on your machine, how to setup and configure your system for InvenioRDM.

Checkout the Deploy Guide if you are looking for a guide on how to deploy InvenioRDM to a server infrastructure.

Project status

InvenioRDM is NOT suitable for production use yet. We expect to release the first Long-Term Support (LTS) release of InvenioRDM in July 2021. Until then, we are making a new major-version release every month with breaking changes. For more information, see our project roadmap.

Quick start

1. Install CLI tool

Install the InvenioRDM CLI tool (see reference):

pip install invenio-cli

2. Check system requirements

Do read the system requirements section. There's important information related to supported versions.

invenio-cli check-requirements --development

3. Scaffold project

Scaffold your InvenioRDM instance. You will be asked several questions. If in doubt, choose the default:

invenio-cli init rdm

4. Build, setup and run

You can run the main InvenioRDM application in two modes (choose one):

  • Containerized application and services (good for a quick preview)
  • Local application with containerized services (good for developers or if want to customize InvenioRDM).

Containerized application

cd my-site/
invenio-cli containers start --lock --build --setup

Local application

cd my-site/
invenio-cli install
invenio-cli services setup
invenio-cli run

5. Explore InvenioRDM

Go and explore your InvenioRDM instance at on:

Self-signed SSL certificate

Your browser will display a big warning about an invalid SSL certificate. This is because InvenioRDM generates a self-signed SSL certificate when you scaffold a new instance and because InvenioRDM requires that all traffic is over a secure HTTPS connection.

All major browsers allow you to bypass the warning (not easily though). In Chrome/Edge you have to click in the browser window and type thisisunsafe.