The guide is intended for system administrators and developers who want to try, customize or develop with InvenioRDM on their local machine.
This guide covers how to install InvenioRDM locally on your machine, how to setup and configure your system for InvenioRDM.
1. Install CLI tool¶
Install the InvenioRDM CLI tool (see reference), e.g. via
pip install invenio-cli
2. Check system requirements¶
Information on requirements
Please do read the system requirements section! There's important information related to supported versions.
You can check if the proper requirements are installed via
invenio-cli check-requirements --development
3. Scaffold project¶
Scaffold your InvenioRDM instance. Replace
<version> with the version you want to install:
- LTS release (for production systems):
- STS release (for feature previews):
invenio-cli init rdm -c <version> # e.g: invenio-cli init rdm -c v9.1
You will be asked several questions. If in doubt, choose the default.
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 you want to customize InvenioRDM).
cd my-site/ invenio-cli containers start --lock --build --setup
cd my-site/ invenio-cli install invenio-cli services setup invenio-cli run
Linux: Managing Docker as a non-root user & Context Errors
If you encounter Docker errors running
invenio-cli services setup, see our section on Docker pre-requisites.
5. Explore InvenioRDM¶
Go and explore your InvenioRDM instance on:
- Local: https://127.0.0.1:5000
- Container: https://127.0.0.1
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
To create a new administrator account:
pipenv run invenio users create <EMAIL> --password <PASSWORD>
- Activate it with
pipenv run invenio users activate <EMAIL>
- If you have email verification enabled (as per defaults) you may want to verifiy the account manually
- Allow the user to access the administration panel:
pipenv run invenio access allow administration-access user <EMAIL>
6. Stop it¶
When you are done, you can stop your instance and optionally destroy the containers:
To just stop the containers:
invenio-cli containers stop
To destroy them:
invenio-cli containers destroy
^C [CTRL+C] invenio-cli services stop
invenio-cli services destroy