Page Status: In Progress.
Please let us know if you encounter any issues or have suggestions.
Installing the ORR System¶
ORR Deployment via Docker¶
The installation of the ORR is greatly facilitated with the use of Docker container technology.
Please install on your target machine:
The user performing the deployment should have the relevant Docker privileges.
For example, via a command like:
sudo usermod -a -G docker username
The Docker images required to run the ORR system are:
|mmisw/orr||ORR||The ORR system itself|
|mongo||MongoDB||Persist all data|
|franzinc/agraph||AllegroGraph||Triple store and SPARQL endpoint|
docker-compose.yml file indicated below takes care of pulling and running
A complete deployment of the ORR, including the required supporting services, consists of the following steps.
Create a directory on your host machine as a base location for all configuration files and data (ontology files, MongoDB data, etc.).
Create these subdirectories:
$ mkdir mongo_data $ mkdir orr_data
Get these files:
$ curl -o docker-compose.yml https://mmisw.org/orrdoc/install/docker-compose.yml $ curl -o orront.conf https://mmisw.org/orrdoc/install/orront.conf $ curl -o local.config.js https://mmisw.org/orrdoc/install/local.config.js
Optionally, to specify a list of email addresses that should be notified whenever there's a user, organization, or ontology registration, create a
notifyemailstext file and put each email address on a line by itself, e.g.,:
$ cat > notifyemails email@example.com firstname.lastname@example.org ^D
Edit the downloaded files as indicated in their contents.
There's some redundancy between
local.config.js. This will be fixed/simplified in a future version of the system.
Launch the ORR:
$ docker-compose up -d Starting agraph Starting mongo Starting orr
$ docker cp local.config.js orr:/usr/local/tomcat/webapps/ont/js/
Inspect the log:
$ docker logs -f --tail=100 orr
Open the ORR in your browser. For example, assuming 9090 is the associated host port, you can now open http://localhost:9090/ont/. You can login with the username "admin" and the password indicated in
To shutdown the whole ORR:
$ docker-compose down Stopping orr ... done Stopping mongo ... done Stopping agraph ... done Removing orr ... done Removing mongo ... done Removing agraph ... done
To stop and restart individual containers:
$ docker stop orr $ docker start orr $ docker restart orr
A crontab like the following could be defined for a complete ORR start at reboot time:
@reboot docker start mongo agraph orr
The above Docker set-up should in general be complemented with appropriate mechanisms toward a production environment. Aspects to consider include: making your ORR instance externally visible, re-starting the containers to reflect configuration and image updates, logging, backups, etc. Please check with your sysadmin.
Apache HTTPD proxy configuration¶
Just as a suggestion (please check with your sysadmin), the following is a possible Apache
proxy configuration to expose the ORR itself and the SPARQL endpoint through the
/sparql context paths under your main HTTP server:
ProxyPass /ont http://localhost:9090/ont ProxyPassReverse /ont http://localhost:9090/ont ProxyPass /sparql http://localhost:10035/repositories/mmiorr ProxyPassReverse /sparql http://localhost:10035/repositories/mmiorr