Notes:
- This has been tested with MacOS on arm64
- authentication details not provided, you will need to provide your own (AKA, you need to configure either github or cilogon to login, however it is not requried for Farms to freeways to display data)
-
Install docker and docker-compose
-
Create your ocfl directory for oni.
- This is after you have followed the README.md
- This involves running
npm install
- This involves running
- Edit
make_ocfl_for_local_oni.sh
to include your data- FARMS_TO_FREEWAYS_TEMPLATE_DIR
- FARMS_TO_FREEWAYS_DATA_DIR
- save file
- Run
make_ocfl_for_local_oni.sh
- you should have an ocfl directory in
oni/data/ocfl
- you should have an ocfl directory in
- This is after you have followed the README.md
-
cd into
oni
-
Verify your
configuration.json
configuration file (You will launch in production mode) -
Launch docker-compose
docker-compose up
- if you need to re-index, both structural index and elastic index do:
docker-compose restart api
Make sure your configuration file has
"api": {
"bootstrap": true,
and
"elastic": {
"bootstrap": true,
- You should be able to launch a portal in http://localhost:9000
- If you dont see any data it means that the ocfl directory is incorrect or it did not have a change to index; force to reindex by doing
docker-compose restart api
- If you dont see any data it means that the ocfl directory is incorrect or it did not have a change to index; force to reindex by doing