Getting started with Invenio

Installation and first steps
Get started
1

Scaffold

First, scaffold the new instance:

# prerequisites: cookiecutter and pipenv
# scaffold my-site instance
$cookiecutter \
gh:inveniosoftware/cookiecutter-invenio-instance -c v3.1
2

Install

Next, start the backend services and install the new instance:

$cd my-site
# start services (db, es, mq, etc)
$docker-compose up -d
# bootstrap my-site instance
$./scripts/bootstrap
3

Run

Setup the database and indexes and run your instance:

# setup database and indexes
$./scripts/setup
# Run your instance
$./scripts/server
# your site is running!
$firefox https://127.0.0.1:5000/
4

Use

We can submit and query records:

# create a new record
$curl -k --header "Content-Type: application/json" \
--request POST \
--data '{"title":"Some title", "contributors": [{"name": "Doe, John"}]}' \
https://127.0.0.1:5000/api/records/?prettyprint=1
# view record
$firefox https://127.0.0.1:5000/records/1
# download record
$curl -k --header "Content-Type: application/json" \
https://127.0.0.1:5000/api/records/1?prettyprint=1
# search for records
$curl -k --header "Content-Type: application/json" \
"https://localhost:5000/api/records/?prettyprint=1&q=title:Some"

For more information and comments, please see our Quickstart documentation.

Looking for Invenio 1.x or 2.x versions? Please see our legacy releases documentation.
Documentation

All the documentation can be found on Read The Docs. You can read about the installation and customisation of Invenio instances, the architecture and the technology overview, as well as our development practices.

See also our further project related information such as our roadmap, governance and code of conduct.