Getting started

Getting help

This documentation is a work in progress, so some parts might not be accurate. If you need assistance, please contact our support team at cesnet-invenio@eosc.cz.

Prerequisites

To install the CESNET flavor of Invenio repository, you will need the following tools:

Linux or Mac (Windows is not supported)
Latest version of Docker or OrbStack configured so that regular users can run Docker commands without sudo
Node.js , version 20+ and pnpm
Python, version 3.13
Git
Bash, version 5+. On Mac, the system version of bash is usually 3.x, so you may need to install a newer version via Homebrew: brew install bash
uv

Verify prerequisites


❯ uname -a
Darwin MacBookPro.localdomain 25.0.0 Darwin Kernel Version 25.0.0
 
❯ python --version
Python 3.13.2
 
❯ node --version
v20.9.0
 
❯ pnpm --version
10.19.0
 
❯ docker run hello-world
Hello from Docker!
 
❯ docker-compose --version
Docker Compose version v2.39.2
 
❯ git --version
git version 2.50.1
 
❯ uv --version
uv 0.8.18
 
❯ bash --version
5.3.3

Installation and running

I already have an instance of a repository (for example, on GitHub) and I want to set it up locally

Install existing repository

I want to create a new repository with a custom metadata schema from scratch

Create new repository