CCA InvenioRDM

CCA InvenioRDM instance. This is mostly a cookiecutter Invenio project with some custom settings and vocabularies. See our "notes" folder for further documentation.

Setup

Development requires docker, python, uv, node, and ImageMagick. invenio-cli check-requirements --development checks these requirements (though it fails if you do not have pipenv even though uv can replace it). See our mise.toml file; mise isn't required, but is helpful. To install on an M2 Mac, additional packages may be needed: brew install cairo libffi libxmlsec1 pkg-config. See build.md for notes on overcoming build errors.

Many configuration values are in Secret Manager; see configure.md for details.

Some fixtures are not in this repository. Build them with the tools in the vault_migration repository and copy them here.

# in vault_migration
gsutil cp gs://integration-success/employee_data.json employee_data.json
gsutil cp gs://integration-success/student_data.json student_data.json
uv run python taxos/users.py employee_data.json student_data.json
INVENIO_REPO=/path/to/this/repo ./vocab/sync # copies to this repo

Then run the commands below from the root of this project to install the app:

uv tool install invenio-cli # install invenio-cli globally (recommended instead of using pip)
invenio-cli install all --dev # creates the virtualenv, install dependencies, & other setup
invenio-cli services setup --no-demo-data # sets up db, cache, search, task queue
uv run invenio files location create gs-invenio-local s3://invenio-local --default # connect to cloud storage
export ENVIRONMENT=local # if not using `mise` ensure vars from .env exist
invenio-cli run

The services setup enqueues many tasks rather than completing them synchronously, so the first time you run the app it takes a while before setup is complete. When done, Ctrl + C kills the dev server but invenio-cli services stop is needed to stop the db, cache, and search.

Overview

Project files and folders:

Name	Description
Dockerfile	Dockerfile used to build your application image.
pyproject.toml	Python dependency requirements
uv.lock	Locked requirements
app_data	Application data such as vocabularies.
assets	Web assets (CSS, JavaScript, LESS, JSX templates) used in the Webpack build.
docker	Example configuration for NGINX, Postgres Admin, and uWSGI.
docker-compose.yml	Backend services needed for local development.
docker-services.yml	Common services for the Docker Compose files.
invenio.cfg	Main configuration file.
notes	CCA's documentation on running & developing the app.
site	Custom site code and modules.
static	Static files that need to be served as-is (e.g. images).
templates	Folder for your Jinja templates.
tests	Tests for our custom components
translations	Translations for UI strings.
.invenio	Common file used by Invenio-CLI to be version controlled.
.invenio.private	Private file used by Invenio-CLI not version controlled.
.env, example.env	Environment variables automatically loaded with dotenv
mise.toml	mise manages env vars & languages (node, python)

Documentation

See the InvenioRDM Documentation for general details and our notes for more specifics.

LICENSE

ECL 2.0