- The Oryx Project: https://bpt.hpi.uni-potsdam.de/Oryx/WebHome
- oryx-editor on Google Code Archive: https://code.google.com/archive/p/oryx-editor/
- The base used in this project is the upstream-vcs branch from koppor/oryx-editor (latest commit: 817ef05 / 7 Oct 2012)
- Related projects:
- andreaswolf/oryx-editor (mirror 29 Jun 2010, changes): https://github.com/andreaswolf/oryx-editor
- koppor/oryx-editor (mirror 7 Oct 2012): https://github.com/koppor/oryx-editor
- code-d/oryx-editor (mirror 7 Oct 2012, less commit history, migrated issues): https://github.com/code-d/oryx-editor
- tiku01/oryx-editor (mirror 7 Oct 2012, less commit history, changes): https://github.com/tiku01/oryx-editor
- SINTEF-9012/oryx-neffics (mirror 15 Jun 2011, changes): https://github.com/SINTEF-9012/oryx-neffics
- yuanqixun/oryx-editor (restructured): https://github.com/yuanqixun/oryx-editor
- hcacha/angular-oryx-editor: https://github.com/hcacha/angular-oryx-editor
- CrossOryx Editor: https://sites.google.com/site/crossoryxeditor/
The subsections below cover the following installation steps:
- Prerequisites
- Build web apps
- Deploy web apps and database in {Docker,local} containers
- Set JAVA_HOME to the installation path of Oracle Java JDK {6,7,8} or OpenJDK 8 (other versions have not been tested)
- Java SE Development Kit 6u45: download from Oracle's Java SE 6 Downloads page
- NB - This JDK is currently included as a Debian package in docker/packages/oracle-java6-jdk_6u45_amd64.deb following this guide: https://wiki.debian.org/JavaPackage. For security reasons the package should probably be replaced.
- packages: ant graphviz subversion postgresql-client
- Tomcat 6 with JRE 6 (available as Docker container)
- PostgreSQL 8.4 with PL/Python (available as Docker container)
- [OPTIONAL] Docker Community Edition (CE) (Docker Engine 1.13.1+)
- ./Dockerfile (Tomcat 6) and ./poem-jvm/Dockerfile (PostgreSQL 8.4) included
- [OPTIONAL] docker-compose
- ./docker-compose.yml
- In ./build.properties change java-home to the installation path (JAVA_HOME) of Java SE Development Kit 6u45
$ cd /path/to/oryx-editor-extension
$ ant build-all
Expected result: after a successful deployment, the following sites are available in the browser:
- Oryx Repository: http://localhost:9090/backend/poem/repository
- Oryx Editor: http://localhost:9090/oryx/editor
$ cd /path/to/oryx-editor-extension
$ cp ./build.properties.sample ./build.properties
and configure the values- Change value of attribute docker-container-web to the container name of the web container (usually should be oryxeditorextension_web_1, but check
$ docker ps
if automatic naming has changed)
- Change value of attribute docker-container-web to the container name of the web container (usually should be oryxeditorextension_web_1, but check
$ cp ./poem-jvm/db.env.sample ./poem-jvm/db.env
and configure the values$ sh setup.sh
$ docker exec -it oryxeditorextension_web_1 /bin/bash
# ant create-schema
- Supply the password specified in
./poem-jvm/db.env
when prompted
- Supply the password specified in
# exit
- Documentation: https://tomcat.apache.org/tomcat-6.0-doc/
- In ./build.properties change deploymentdir to the web apps directory of the tomcat installation
$ cd /path/to/oryx-editor-extension
$ ant deploy-all
- Documentation: https://www.postgresql.org/docs/8.4/static/
- In ./poem-jvm/etc/hibernate.cfg.xml modify the following lines:
<property name="connection.url">jdbc:postgresql://database/poem</property>
<property name="connection.username">poem</property>
<property name="connection.password">poem</property>
- In ./build.properties modify the following lines:
postgresql-hostname = localhost
postgresql-username = poem
postgresql-port = 5432
postgresql-bin-dir = /usr/bin
- NB - the default hostname in the property with name="connection.url is database to accomodate the Docker setup. Change to the hostname of your postgres server (same for postgresql-hostname in ./build.properties)
- Then run ./poem-jvm/data/database/db_schema.sql for that url/username/password
The web container needs the following Java options (address and the port used later must be equal):
JAVA_OPTS="-Xdebug -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000"`
- NB - JRE System Library vendor must match the one used in Tomcat 6 container and should match version
- Select "Run" -> "Debug Configurations..."
- Right-click "Remote Java Application" -> Select "New"
- "Connection Properties":
- Host: localhost
- Port: 8000
- Select "Apply" -> "Debug"
- Select "Window" -> "Show View" -> "Debug"
$ cd /path/to/oryx-editor-extension
$ ant javadoc-editor
Update editor (example): $ ant build-editor undeploy-editor-docker deploy-editor-docker
- In editor/client/scripts/Plugins/plugins.xml add a plugin element as a child of the plugins element:
<plugin source="countObjects.js" name="ORYX.Plugins.PetrinetCountObjects">
<requires namespace="http://b3mn.org/stencilset/petrinet#"/>
</plugin>
- Add localization in editor/data/i18n/{translation_de.js,translation_en_us.js,translation_es.js,translation_ru.js}
- Add plugin functionality in editor/client/scripts/Plugins as a JavaScript file which extends AbstractPlugin (editor/client/scripts/Core/abstractPlugin.js)