Toromiro Guide

First Steps

Download

Download Toromiro

Run It

Unzip the downloaded package, and run the Toromiro executable:

• On Windows, run toromiro.exe.
• On Mac, extract and run toromiro.app from the DMG file.
• On Linux, run toromiro.

When you run Toromiro for the first time, it will ask for a license key. Copy and enter the following evaluation license key:

----- BEGIN LICENSE KEY -----
AQDvrO0ABXNyABFqYXZhLnV0aWwuSGFzaE1hcAUH2sHDFmDRAwACRgAKbG9hZEZhY3RvckkACXRo
cmVzaG9sZHhwP0AAAAAAAAx3CAAAABAAAAAFdAAHbGljZW5zZXQABXRyaWFsdAAJcHJvZHVjdElk
dAAVY29tLnN1YnNoZWxsLnRvcm9taXJvdAAMY3JlYXRpb25EYXRldAANMTYxODU4NDA3NzAwNHQA
EXJhbmRvbU51bWJlckR1bW15dAAULTMwMTM5NDg1ODU5OTM3NzQ5Mzl0AA5leHBpcmF0aW9uRGF0
ZXQACTMwMDAtMDEtMXgEADq7/Uj0IgD3Qx2wrcTrp23N0clejTyoGS7vGkT6H3YgR7eO0sPYQ1yz
y/JQJb5KKBxa0Az+ZwnrpI0LoxNhTFh3KDIFNBLzTJEF0ykP0yekax7mM2vtPs5xtZIZNgeqFBBw
jUM6eeo2/7CzHnPdz9kWC54fN5X0krEpMeibAF9MQRgcFs67ANgaw3VYttTAsPuw030in4obYmZX
BU2Nozdouo/hRkqKdH0I2uF/Hsd5nnzNtv59TKorCfGgullLLd+ZoXEJRC14yY0ug6b5M7mRRoMs
V3iJvnZmmuFxEVPZHYVvsKKUDpDW0HrZbUVipct59ZNshKtw+ddtNub4gPgsbFkCD/V3UUWGsm2A
HXql0PoTXAdn6E6MOTHdm0ADBvhBPEXCsg+2VqQcY6cGQn4oBCdxXGS1US1iYLnc7cMO/+EKxRtj
lRgiMUb+mZJNj5mASWPmlSpCyKbjfozoix1zTeF+ufOkyTnTnHA12GLvxnV1D+7bqNEUSjmIDMEZ
+WQk3OsQ9hbC5QJLPb/qcP2EymY2UaaOmU0BG/7lawh8dVLJEMDlpJm0DKw2PcL6ujkkGza1ZhLk
GT3yBkO4Cxwp6SIlAEHK+e4kqd3RZuEQLG9vOGRALG523lhJ7q6NpdqtoFDADL1OTPOy0ObE1X3Q
EuA4E3IkRir0qlqUvH51p4814CDFBF2HLxmWOUSgzWSJWMmKdExH2LcZG7w0c8m9GpWVh0Lpbule
8yXRfVz00BiYvkFWIc8pnWR1WH7nwOfFdef7Lu3X8IjG6sFu/RkOkm9YFLoZLLp0fI5i3b/i7I0N
pjBv863Zf3deJYL0PPEpjJc6jlj4Zq6+QALAzI7HA2YcubfBF/zVzAJ+U3B4iLyCRmTfG44RUf4e
bYqKggiy/8HA01u0A23de/4nMLtm8E3OZpqlZHQXE5TytcBkr5fO3Y2HN/JmNCMchFqgg8Azo9iI
bVVGX7kByeRxU+3AbEK+WBvLeLimXPkw0qHUEfOU3pRhLobeoDxsD7nAMF0kbsGrWpXwewx1Zx8y
BJO8ThV3ZT1zmOmK5du+9XvfTgGrgpO3voL2sxb1Ww6YrtrQvovrwcXR0VYCp5yF2lxgaokFWULj
GXjBRmHNXrlD8dRtaf3d9RzagPbSimtxlXvFRhyTUOOWadMJmB5uHXO+oNiG+q6WuJxlyxQOpnma
mccqzq9kuJs/ST0NsEHiGXip/HDpsNTYOfFvQ9aP/h7GiEeMqSufZjEsCdiUUww0DbCKwwr72bVR
LC5ZwqAD/BwWje8osXBbiwfvIfU9aglqJY5D6fJ0kEGlRU9AStkOf4xaUFkWJy0mNYOH/9VYAlZY
dM6ujkLWCo1BhoMGAv4=
----- END LICENSE KEY -----

Connect To The Demo Repository

We have a public demo repository running on our servers. Connect to it using the following steps:

• Select File >> New >> Repository from the main menu.
• A dialog will pop up where you'll have to enter the following connection details:
• Name: Toromiro Demo Repository
• Group: <leave empty>
• JCR adapter: Apache Jackrabbit 2.20 (RMI)
• Repository URL: rmi://cmsdemo.sophoracms.com:1999/repository
• Username: admin
• Password: admin
• Workspace: <leave empty>
• Observation: Checked
• To connect to the Toromiro demo repository, double-click the new entry "Toromiro Demo Repository" in the Repository Browser view.

Once connected to the demo repository, try the following:

• You can browse its contents in the Repository Browser.
• You can search for documents in the Repository Search using an XPath query. E.g. enter the following query: //element(*, sophora-content-nt:story)
• You can search for documents by UUID by clicking on the UUID button in the Repository Search view. E.g. search for the UUID 43c945f0-97d3-42fe-9c9e-e2c92f70d9d7.
• View node type definitions as diagrams or CND in the Repository Node Types view.

Connect To A Jackrabbit Repository

Toromiro can be used to connect to Apache Jackrabbit repositories in different ways.

Connect To Jackrabbit Server by RMI

This example shows how to connect to a remote Jackrabbit repository using RMI. In this example, we'll connect to the Jackrabbit standalone server, which can be installed as follows:

1. Download the jackrabbit-standalone jar from the Apache Software Foundation. This example uses the version 2.20.2.

2. Rename it to jackrabbit-standalone.jar

3. Run it using: java -jar jackrabbit-standalone.jar

In Toromiro, create a repository connection with the following details:

• Name: Jackrabbit Standalone RMI
• Group: Jackrabbit
• JCR adapter: Apache Jackrabbit 2.20 (RMI)
• Repository URL: http://localhost:8080/rmi
• Username: admin
• Password: admin
• Workspace: <leave empty>
• Observation: Checked

Connect To Jackrabbit Server by WebDAV

This example shows how to connect to a remote Jackrabbit repository using WebDAV. In this example, we'll connect to the Jackrabbit standalone server, which can be installed as follows:

1. Download the jackrabbit-standalone jar from the Apache Software Foundation. This example uses the version 2.20.2.

2. Rename it to jackrabbit-standalone.jar

3. Run it using: java -jar jackrabbit-standalone.jar

In Toromiro, create a repository connection with the following details:

• Name: Jackrabbit Standalone WebDAV
• Group: Jackrabbit
• JCR adapter: Apache Jackrabbit 2.20 (WebDAV)
• Repository URL: http://localhost:8080/server/
• Username: admin
• Password: admin
• Workspace: <leave empty>
• Observation: Checked

Create And Edit A Local Jackrabbit Repository Directly

Toromiro can also be used to create and edit a local Jackrabbit repository directly. Instead of configuring an url to connect to, the directory where the repository is located / will be created has to be given, as well as the path to a repository.xml configuration file.

Create A Repository

Create a directory for the repository in your file system, e.g. C:/temp/repo. Copy the attached repository.xml into this directory.

In Toromiro, create a repository connection with the following details:

• Name: Jackrabbit Local
• Group: Jackrabbit
• JCR adapter: Apache Jackrabbit 2.20 (Local, Derby 10.14.2.0)
• Home directory: C:/temp/repo
• Configuration file: C:/temp/repo/repository.xml
• Username: anything
• Password: anything
• Workspace: <leave empty>
• Observation: Checked

When you connect to the repository for the first time, it will be created with the default Jackrabbit content in the given directory.

Database

The example above uses a Derby persistence manager which is supported by Toromiro out of the box. If your repository uses another persistence manager, e.g. a h2 database, you have to configure the JDBC driver in the toromiro.ini file (only since Toromiro 1.13.0). To do so set the property JDBC_DRIVER to the path of your driver jar file. Afterwards the "Apache Jackrabbit <version> (Local, Derby <version>)" JCR adapters will work with the configured JDBC driver, too.

Here is an example of the toromiro.ini file (Windows 64 bit, h2 database). Note that JDBC_DRIVER is a system property and must be set after -vmargs. Moreover the toromiro.ini file must end with an empty line.

-startup
plugins/org.eclipse.equinox.launcher_1.5.500.v20190715-1310.jar
--launcher.library
plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.1100.v20190907-0426
-vmargs
-Xmx1024m
-DJDBC_DRIVER=C:/path/to/h2driver/h2-1.4.180.jar

Connect To An Existing Jackrabbit Repository

Instead of creating the repository with Toromiro, you can also open an existing Jackrabbit repository directly. For example, you can open a repository from a Sophora CMS installation without needing to start the Sophora server.

There are, however, limitations: Be sure to use an adapter with the exact same version of Jackrabbit and Derby as the CMS that created the repository. If non-matching versions are used, Jackrabbit might upgrade the database schema to a new version.

When using a Jackrabbit RMI adapter, the version number of the adapter has to be roughly the same as the version of the Jackrabbit server used in the CMS. E.g. if the CMS uses Jackrabbit 2.18.x, use the "Apache Jackrabbit 2.18 (RMI)" adapter in Toromiro. Using an adapter with a non-matching version might work, but could lead to exceptions.

Sophora CMS

Sophora is accessible using Jackrabbit RMI, so it is possible to connect to the JCR repository of a Sophora CMS while it is running. The user that is used for the connection must have the admin role.

• Name: Sophora Repository Remote
• Group: Sophora
• JCR adapter: Apache Jackrabbit 2.18 (RMI)
• Repository URL: rmi://<Sophora Server URL>:<RMI port>/repository
• The port here is the port set in the sophora.properties of your Sophora installation using the property sophora.rmi.registryPort.
• Username: <username of a Sophora admin user>
• Password: <password of the Sophora admin user>
• Workspace: <leave empty>
• Observation: Unchecked

Updates

Toromiro can look for new versions each time when started and update automatically. To enable/disable automatic updates, these may be switched on/off in the Preferences within the Install/Update > Automatic Updates section. A manual update can be started using Help > Check for Updates from the main menu.

The update URL for Toromiro is: http://toromiro.subshell.com/subshell-update/toromiro/

Proxy Settings

A Proxy can be configured in the Preferences within the Network Connections section. Restarting the application afterwards is recommended.

Add-ons

There are several add-ons available for Toromiro. To install add-ons use Help > Install New Software... from the main menu and select the Toromiro Updates.

Available Add-ons

• Sophora Add-on: This is a special Sophora Feature for users of the Sophora content management system. This add-on adds search support for documents via Sophora ID, External ID and Childnode ID to the Repository Search view.
• ModeShape Add-on: This add-on provides ModeShape JCR adapters for connecting to ModeShape repositories. (Toromiro 1.6.0 to 2.x only)
• Hippo Add-on: This add-on provides Hippo CMS adapters for connecting to Hippo repositories. (Toromiro 1.7.0 to 2.x only)

User Guide

The full User Guide for further information about using Toromiro is available in Toromiro's main menu via Help > Help Contents. There is also a Dynamic Help available (via help menu or by pressing F1), that displays help topics about the current view, editor, or wizard you have selected. The User Guide can be downloaded here, too:

• Download Toromiro 3.0 User Guide (PDF)
• Download Toromiro 2.0 User Guide (PDF)