Getting started with Invenio

Installation and first steps
Installation
Invenio 1.2

Install latest stable release in a virtual machine using vagrant:

$ git clone https://github.com/inveniosoftware/invenio -b maint-1.2 $ cd invenio $ vagrant up && vagrant ssh web web> source .inveniorc web> /vagrant/scripts/create-instance.sh web> /vagrant/scripts/populate-instance.sh $ firefox http://192.168.50.10/record/1

See detailed instructions for Invenio 1.2

Invenio 3.0

Install latest developer preview using docker:

$ git clone https://github.com/inveniosoftware/invenio $ cd invenio $ docker-compose build $ docker-compose up -d $ docker-compose run --rm web ./scripts/populate-instance.sh $ firefox http://127.0.0.1/ $ firefox http://127.0.0.1/records/1

See detailed instructions for Invenio 3.0

Development

Invenio is a modular framework of independent collaborative component packages. You can find a list of available packages in our documentation. The packages are located in three different GitHub organistations:

  • inveniosoftware: A collection of base packages, core packages, and additional feature packages that are maintained in a coherent, homogeneous way by the Invenio project team. The main organisation.
  • inveniosoftware-contrib: A collection of third-party packages extending Invenio functionalities. They are maintained by contributing teams and may follow different practices. The packages may also incubate an experimental or unproven feature that can later mature into the main organisation.
  • inveniosoftware-attic: A collection of disconinued or retired packages that are no longer maintained.

You may be interested in our development practices and contributing guide.

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.

Further project related information such as our roadmap or our build status overview can be found on GitHub wiki pages.