This is the source repsository for CaltechDATA, Caltech's Institutional Data and Software Repository. It is an instance of the InvenioRDM repository platform.
- Introduction
- Installation
- Usage
- Known issues and limitations
- Getting help
- Contributing
- License
- Authors and history
- Acknowledgments
This repository was initialized following the InvenioRDM instructions/. It was then customized to meet the needs of the Caltech community. This is only one deployment example, and may or not be appropriate for your specific institution and IT setup.
We currently deploy CaltechDATA on a m6i.xlarge AWS EC2 instance with Ubuntu 20.04. We use this cloud-init file to do most of the initial setup.
Clone this repository into /Sites, then go to that directory
invenio-cli install
invenio-cli services setup --no-demo-data
You'll need a .env file in /Sites/caltechdata, which includes secrets. Copy .env.example, which documents each variable, and fill in the blanks:
cp .env.example .env
chmod 600 .env
This configuration uses S3 for storage. You need to change the bucket name with
pipenv run invenio files location s3-default s3://caltechdata --default
You can load the funders vocabulary with
wget https://zenodo.org/record/7038913/files/v1.5-2022-08-31-ror-data.zip?download=1 -O ror.zip
pipenv run invenio vocabularies import --vocabulary funders --origin "/Sites/caltechdata/ror.zip"
We have a local CaltechPEOPLE list, which is loaded with
pipenv run invenio vocabularies import --vocabulary names --filepath ./vocabularies-future.yaml
You'll need a domain name, and set an A record to point the domain name to your AWS instance.
Install the nginx configuration with ./nginx-deploy.bash (see
docs/nginx.md). The configuration is in the nginx/ directory, which mirrors
/etc/nginx: the site file, the TLS snippets, the log format and
redirect-map.conf (TIND record numbers to RDM identifiers). The script
checks it with nginx -t on a staged copy before changing anything, then
links the files into /etc/nginx (so a git pull changes what nginx reads)
and leaves the packaged /etc/nginx/nginx.conf alone. After any pull, run
sudo ./nginx-deploy.bash verify before restarting nginx; the post-merge hook
that apply enables does this and warns if it fails. Get the certificate with
sudo certbot certonly, never certbot --nginx
(docs/Adding-a-Certbot-Hostname.md): that edits files the script owns.
docs/nginx.md also covers rolling back and a host that still has copies.
Two scripts in admin/ serve the reboot check: safe_to_reboot.bash reports
whether a reboot is safe (units, a SQL backup, an OpenSearch snapshot, an
upload in progress) and caltechdata_down.bash stops the services in order.
check-for-reboot.bash from the private admin-shell-scripts repository calls
the first; cloud-init installs both into /usr/local/bin.
We need three services to run InvenioRDM. Set them up with
sudo cp rdm_rest.service /etc/systemd/system/.
sudo cp rdm.service /etc/systemd/system/.
sudo cp rdm_celery.service /etc/systemd/system/.
sudo systemctl daemon-reload
sudo systemctl start rdm
sudo systemctl start rdm_rest
sudo systemctl start rdm_celery
You should now have a InvenioRDM repository fully running!
cd /Sites/caltechdata
sudo systemctl stop nginx
sudo systemctl stop rdm
sudo systemctl stop rdm_rest
sudo systemctl stop rdm_celery
invenio-cli services stop
cd /Sites/caltechdata
invenio-cli services start
# Make sure there are no errors in the invenio-saml install
sudo systemctl start rdm_celery
sudo systemctl start rdm_rest
sudo systemctl start rdm
sudo systemctl start nginx
These insttallation instructions are intended for this specific Caltech deployment, and you may need to modify them to work for your specific configuration.
Please open an issue or pull request if you notice any problems or have questions.
Please see our Contributing guidelines
Software produced by the Caltech Library is Copyright © 2022 California Institute of Technology. This software is freely distributed under a BSD/MIT type license. Please see the LICENSE file for more information.
Tom Morrell led the CaltechDATA InvenioRDM development. Tommy Keswick did all the themeing and site design. Robert Doiel implemented the Shibboleth login. Mike Hucka worked on the GitHub integration. TUGraz and all the other InvenioRDM partners were instrumental in getting all the customizations working.
This work was funded by the California Institute of Technology Library.