instance

Welcome to your InvenioRDM instance.

This repository is based on InvenioRDM v14. The exact pinned version lives in pyproject.toml / uv.lock.

Make sure you have invenio-cli package installed.

Run the following commands to have the instance ready for development:

uv sync # base install, creates the .venv
# theme-specific packages are installed by local_theme.sh 
invenio-cli install symlink
invenio-cli services setup

# then in 2 different terminals
invenio-cli run worker # 1 terminal
invenio-cli run web # 1 terminal

# for UI dev
invenio-cli assets watch # run this to have the UI change done automatically in the running app

The instance ships several looks. local_theme.sh does locally what the Dockerfiles do for the images: install that theme's dependencies from its own pyproject.toml/uv.lock, install its invenio.cfg, swap the theme files into the collected assets and build. Local and CI therefore resolve the same package versions.

./local_theme.sh default   # core InvenioRDM look, with our theme on top
./local_theme.sh TUG       # TU Graz
./local_theme.sh MUG       # Med Uni Graz

invenio-cli run

Good to know:

• the script replaces invenio webpack buildall - do not run that afterwards, it re-runs webpack create and undoes the theme swap
• the script installs from that theme's own pyproject.toml/uv.lock - the same files its Dockerfile builds from - so local matches the image. switching theme re-syncs the venv, no uv sync --extra needed
• if a switch looks wrong, run invenio webpack clean first: webpack create never overwrites files it already collected
• log in with the local email/password form - the Keycloak button needs credentials that only exist in the deployed images
• the theme cfgs expect the database URI and search index prefix from environment variables in the images, so the script appends local dev values

Run the following commands in order to start your new InvenioRDM instance:

invenio-cli containers start --lock --build --setup

The above command first builds the application docker image and afterwards starts the application and related services (database, Opensearch, Redis and RabbitMQ). The build and boot process will take some time to complete, especially the first time as docker images have to be downloaded during the process.

Once running, visit https://127.0.0.1 in your browser.

Note: The server is using a self-signed SSL certificate, so your browser will issue a warning that you will have to by-pass.

Following is an overview of the generated files and folders:

To learn how to configure, customize, deploy and much more, visit the InvenioRDM Documentation.

For detailed steps on working with UV, check the Working with UV documentation.

Each image has a correspondent instance variant that a user can choose to deploy.

The main goal is CI so that the end result of this workflow is a fully functional instance image, whenever triggered.

This repository's only workflow runs automatically on every commit to the main branch and whenever a new tag is created for the repository. Additionally, it can be triggered manually from the Actions tab under 'Run workflow,' where you can select the following

• the invenio-override branch
• the branch of this repository to run the workflow from.

This process results in the creation of 4 new Docker images, tagged with the branch name or the tag name.