DOI registration bot for web annotations, optimized for use by the Heidelberg University Library.
- Ensure you have the prerequisites:
- Ubuntu 22.04 or later
- Node.js v20 or later
- Clone this repo and chdir to your clone's top directory.
- Run
npm install . - Continue at chapter "Configuration".
- You can modify the configuration at any time. Changes will take effect the next time the DOI bot runs.
- The available config options can be found (not: modified) in the default settings file.
- To customize configuration, create a subdirectory named
config, and in there, one or more text files whose name ends in.rc(e.g.basics.rc).- All these files are read in your locale's sorting order,
which may or may not be case-sensitive.
For reliable ordering, start all filenames with a fixed number of
digits, e.g.
010_basics.rc,023_doi_format.rc,080_hotfixes.rc.
- All these files are read in your locale's sorting order,
which may or may not be case-sensitive.
For reliable ordering, start all filenames with a fixed number of
digits, e.g.
- manually: Run
./doibot.sh - via cron or a similar scheduler: Configure a schedule that runs
/path/to/this/repo/doibot.sh cron_task
- Needs more/better tests and docs.
MIT