{"id":18480463,"url":"https://github.com/caltechlibrary/caltechauthors","last_synced_at":"2025-04-13T05:49:57.303Z","repository":{"id":111427888,"uuid":"594120116","full_name":"caltechlibrary/caltechauthors","owner":"caltechlibrary","description":"The CaltechAUTHORS InvenioRDM source code","archived":false,"fork":false,"pushed_at":"2025-03-04T18:42:43.000Z","size":5060,"stargazers_count":5,"open_issues_count":71,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-13T05:49:52.164Z","etag":null,"topics":["inveniordm","repository"],"latest_commit_sha":null,"homepage":"https://authors.library.caltech.edu","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/caltechlibrary.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":"codemeta.json","zenodo":null}},"created_at":"2023-01-27T16:41:10.000Z","updated_at":"2025-03-26T20:33:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"ea38bb75-c588-4ccd-9571-679997c68de8","html_url":"https://github.com/caltechlibrary/caltechauthors","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caltechlibrary%2Fcaltechauthors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caltechlibrary%2Fcaltechauthors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caltechlibrary%2Fcaltechauthors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caltechlibrary%2Fcaltechauthors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caltechlibrary","download_url":"https://codeload.github.com/caltechlibrary/caltechauthors/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248670501,"owners_count":21142901,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["inveniordm","repository"],"created_at":"2024-11-06T12:19:00.346Z","updated_at":"2025-04-13T05:49:57.275Z","avatar_url":"https://github.com/caltechlibrary.png","language":"HTML","funding_links":[],"categories":["Overlays"],"sub_categories":[],"readme":"# CaltechAUTHORS\n\nThis is the source repsository for CaltechAUTHORS, Caltech's Institutional Publications Repository. It is an instance of the [InvenioRDM repository\nplatform](https://inveniosoftware.org/products/rdm/).\n\n[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?color=orange)](https://choosealicense.com/licenses/bsd-3-clause)\n[![Latest release](https://img.shields.io/github/v/release/caltechlibrary/caltechauthors.svg?color=b44e88)](https://github.com/caltechlibrary/caltechauthors/releases)\n\n\n\n## Table of contents\n\n* [Introduction](#introduction)\n* [Installation](#installation)\n* [Usage](#usage)\n* [Known issues and limitations](#known-issues-and-limitations)\n* [Getting help](#getting-help)\n* [Contributing](#contributing)\n* [License](#license)\n* [Authors and history](#authors-and-history)\n* [Acknowledgments](#authors-and-acknowledgments)\n\n\n## Introduction\n\nThis repository was initialized following [the InvenioRDM\ninstructions/](https://inveniordm.docs.cern.ch/install/). It was then\ncustomized to meet the needs of the Caltech community. This is only one\ndeployment example, and may or not be appropriate for your specific\ninstitution and IT setup. \n\n## Installation\n\nWe currently deploy CaltechAUTHORS on a m6i.xlarge AWS EC2 instance with Ubuntu\n22.04. We use this [cloud-init\nfile](https://github.com/caltechlibrary/cloud-init-examples/blob/main/invenio-rdm-12-init.yaml)\nto do most of the initial setup.\n\n### Install NVM\n\nWe haven't gotten NVM to install with cloud-init. Run `curl -o-\nhttps://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash`, then\nreboot and type `nvm install 16`\n\n### Install InvenioRDM\n\nWe use a local copy of idutils with custom identifiers\n\n```\ngit clone https://github.com/caltechlibrary/idutils.git\ncd idutils\ngit checkout authors\ncd ../caltechauthors\npipenv install\ninvenio-cli packages install ../idutils\ninvenio-cli services setup --no-demo-data\n```\n\nYou'll also need to install the new-authors branch of https://github.com/caltechlibrary/invenio-rdm-records and authors branches of https://github.com/caltechlibrary/invenio-communities.git and https://github.com/caltechlibrary/invenio-app-rdm\nYou'll need a .env file in /Sites, which includes secrets:\n\n```\nINVENIO_DATACITE_PASSWORD=\nINVENIO_SECRET_KEY=\nINVENIO_S3_ACCESS_KEY_ID=\nINVENIO_S3_SECRET_ACCESS_KEY=\nINVENIO_LOGGING_CONSOLE_LEVEL=\nINVENIO_MAIL_PASSWORD=\n```\n\nEdit /etc/sysctl.conf and add vm.max_map_count=262144\n\nThis configuration uses S3 for storage. You need to change the bucket name with\n\n`pipenv run invenio files location s3-default s3://caltechauthors --default`\n\nAdd access to the admin panel `pipenv run invenio access allow administration-access role admin`\n\nGet the latest ROR data from https://doi.org/10.5281/zenodo.6347574 and import the funders vocabulary with\n\n```\nwget https://zenodo.org/record/7038913/files/v1.5-2022-08-31-ror-data.zip?download=1 -O ror.zip\npipenv run invenio vocabularies import --vocabulary funders --origin \"/Sites/caltechdata/ror.zip\"\n```\n\nWe have a local awards list, generated by https://github.com/caltechlibrary/irdmtools awards2vocabulary.py. Load into RDM with\n\n```\npipenv run invenio vocabularies import --vocabulary awards --filepath ./vocabularies-future.yaml\n```\n\nWe have a local CaltechPEOPLE list, which is loaded with\n\n```\npipenv run invenio vocabularies import --vocabulary names --filepath ./vocabularies-future.yaml\n```\n\n### Domain Configuration\n\nYou'll need a domain name, and set an A record to point the domain name to your\nAWS instance.\n\nMove nginx.conf to `/etc/nginx/sites-enabled/default`\n\nCopy redirect-map.conf to `/etc/nginx/`\n\nGet a certificate with `sudo certbot --nginx`\n\nRestart nginx with `sudo service nginx restart`\n\n### Systemctl\n\nWe need three services to run InvenioRDM. Set them up with\n\n```\nsudo cp rdm_rest.service /etc/systemd/system/.\nsudo cp rdm.service /etc/systemd/system/.\nsudo cp rdm_celery.service /etc/systemd/system/.\nsudo systemctl daemon-reload\nsudo systemctl start rdm\nsudo systemctl start rdm_rest\nsudo systemctl start rdm_celery\n```\n\nYou should now have a InvenioRDM repository fully running!\n\n## Usage\n\n### Stopping InvenioRDM\n\n```\ncd /Sites/caltechdata\nsudo systemctl stop nginx\nsudo systemctl stop rdm\nsudo systemctl stop rdm_rest\nsudo systemctl stop rdm_celery\ninvenio-cli services stop\n```\n\n### Starting InvenioRDM\n\n```\ncd /Sites/caltechdata\ninvenio-cli services start\n# Make sure there are no errors in the invenio-saml install\nsudo systemctl start rdm_celery\nsudo systemctl start rdm_rest\nsudo systemctl start rdm\nsudo systemctl start nginx\n```\n\n## Known issues and limitations\n\nThese insttallation instructions are intended for this specific Caltech\ndeployment, and you may need to modify them to work for your specific\nconfiguration.\n\n## Getting help\n\nPlease open an issue or pull request if you notice any problems or have\nquestions.\n\n## Contributing\n\nPlease see our [Contributing\nguidelines](https://github.com/caltechlibrary/caltechdata/blob/main/CONTRIBUTING.md)\n\n## License\n\nSoftware produced by the Caltech Library is Copyright © 2024 California Institute of Technology.  This software is freely distributed under a BSD/MIT type license.  Please see the [LICENSE](LICENSE) file for more information.\n\n\n## Authors and history\n\nTom Morrell led the CaltechDATA InvenioRDM development. Tommy Keswick helped with themeing and site design.  TUGraz and all the other\nInvenioRDM partners were instrumental in getting all the customizations\nworking.\n\n## Acknowledgments\n\nThis work was funded by the California Institute of Technology Library.\n\n\n\u003cdiv align=\"center\"\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://www.caltech.edu\"\u003e\n    \u003cimg width=\"100\" height=\"100\" src=\"https://raw.githubusercontent.com/caltechlibrary/template/main/.graphics/caltech-round.png\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaltechlibrary%2Fcaltechauthors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaltechlibrary%2Fcaltechauthors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaltechlibrary%2Fcaltechauthors/lists"}