This chapter covers the tasks required to install and start OpenIDM.

This section covers what you need to know before running OpenIDM.

Java Requirements OpenIDM requires Oracle Java SE JDK 6 update 24 or later. The equivalent version of OpenJDK should work for evaluation, too.

Application container Requirements OpenIDM services run in an OSGi container with an embedded Servlet container, and an embedded noSQL database. By default the OSGi container is Apache Felix. The default Servlet container is Jetty. For OpenIDM , the only supported configuration is running the services in Apache Felix and Jetty.

Follow the procedures in this section to install and run OpenIDM. Installing Follow these steps to install OpenIDM. Make sure you have an appropriate version of Java installed. $ java -version java version "1.6.0_24" Java(TM) SE Runtime Environment (build 1.6.0_24-b07-334) Java HotSpot(TM) 64-Bit Server VM (build 19.1-b02-334, mixed mode) Check the release notes for Java requirements in the chapter, Before You Install OpenIDM Software. Downloading Download OpenIDM from the download page. Unpack the contents of the .zip file into the install location. $ cd /path/to $ unzip ~/Downloads/openidm-.zip ... inflating: openidm/connectors/openicf-scriptedsql-connector-.jar inflating: openidm/bin/felix.jar inflating: openidm/bin/openidm.jar $ By default, OpenIDM listens for HTTP connections on port 8080. To change the default port, edit openidm/conf/jetty.xml. Repository database Requirements Before running OpenIDM in production, replace the default OrientDB repository provided for evaluation with a JDBC repository. See the chapter on Installing a Repository For Production for details. Starting OpenIDM Follow these steps to run OpenIDM interactively. To run OpenIDM as a background process, see the chapter on Starting & Stopping OpenIDM in the Integrator's Guide. Start the Felix container, load all OpenIDM services, and start a command shell to allow you to manage the container. Start OpenIDM (UNIX). $ ./startup.sh Using OPENIDM_HOME: /path/to/openidm Using OPENIDM_OPTS: -Xmx1024m Using LOGGING_CONFIG: -Djava.util.logging.config.file=/path/to/openidm/conf/logging.properties Using boot properties at /path/to/openidm/conf/boot/boot.properties -> Start OpenIDM (Windows). $ cd \path\to\openidm $ startup.bat Start in debug mode [1] default Start in normal mode [2] Show help [3] Chose a number (1-3): Listening for transport dt_socket at address: 5005 ... -> At the resulting -> prompt, you can enter commands such as help for usage, or ps to view the bundles installed. To see a list of all the OpenIDM core services and their states, enter the following command. -> scr list Id State Name [ 16] [active ] org.forgerock.openidm.config.starter [ 7] [active ] org.forgerock.openidm.external.rest [ 11] [active ] org.forgerock.openidm.provisioner.openicf.connectorinfoprovider [ 1] [active ] org.forgerock.openidm.router [ 18] [active ] org.forgerock.openidm.scheduler [ 13] [active ] org.forgerock.openidm.restlet [ 6] [unsatisfied ] org.forgerock.openidm.external.email [ 15] [active ] org.forgerock.openidm.repo.orientdb [ 5] [active ] org.forgerock.openidm.sync [ 3] [active ] org.forgerock.openidm.script [ 2] [active ] org.forgerock.openidm.scope [ 9] [active ] org.forgerock.openidm.http.contextregistrator [ 17] [active ] org.forgerock.openidm.config [ 0] [active ] org.forgerock.openidm.audit [ 14] [unsatisfied ] org.forgerock.openidm.repo.jdbc [ 4] [active ] org.forgerock.openidm.managed [ 12] [active ] org.forgerock.openidm.provisioner.openicf [ 8] [active ] org.forgerock.openidm.authentication [ 10] [active ] org.forgerock.openidm.provisioner -> If startup was successful, all states except email and repo.jdbc are active. If any other services remain unsatisfied, check openidm/logs for errors, and refer to the chapter on Troubleshooting in the Integrator's Guide. Alternatively, you can manage the container and services from the Felix administration console. Use these hints to connect to the console. Default Console URL: http://localhost:8080/system/console Default user name: admin Default password: admin Some basic hints on using the Felix administration console follow. Select the Components tab to see OpenIDM core services and their respective states. Select the Shell tab to access the -> prompt. Select the System Information tab to stop or restart the container. Getting started OpenIDM provides RESTful access to users in the OpenIDM repository. Access the following URL to get a JSON file including all users in the OpenIDM repository. $ curl --header "X-OpenIDM-Username: openidm-admin" --header "X-OpenIDM-Password: openidm-admin" http://localhost:8080/openidm/managed/user/?_query-id=query-all-ids When you first install OpenIDM with an empty repository, no users exist. The curl command line tool is included with most operating systems.For more information on curl, see http://curl.haxx.se/. Create a user joe by sending a RESTful PUT. The following curl commands create the user joe in the repository. Create joe (UNIX). $ curl --header "X-OpenIDM-Username: openidm-admin" --header "X-OpenIDM-Password: openidm-admin" --request PUT --data '{ "name":"joe", "firstname":"joe", "lastname":"smith", "email":"joe@abc.com", "userPassword":"11111111" }' http://localhost:8080/openidm/managed/user/joe {"_id":"joe","_rev":"0"} Create joe (Windows). C:\>curl --header "X-OpenIDM-Username: openidm-admin" --header "X-OpenIDM-Password: openidm-admin" --request PUT --data { \"name\":\"joe\", \"firstname\":\"joe\", \"lastname\":\"smith\", \"email\":\"joe@abc.com\", \"userPassword\":\"11111111\" } http://localhost:8080/openidm/managed/user/joe {"_id":"joe","_rev":"0"} Fetch the newly created user from the repository with a RESTful GET. $ curl --header "X-OpenIDM-Username: openidm-admin" --header "X-OpenIDM-Password: openidm-admin" http://localhost:8080/openidm/managed/user/joe { "userPassword": "11111111", "lastname": "smith", "firstname": "joe", "_id": "joe", "_rev": "0", "email": "joe@abc.com", "name": "joe" } The JSON output shown above is formatted for easier reading. OpenIDM returns the JSON object all on one line. Stopping OpenIDM You can stop OpenIDM Services from the -> prompt, or through the Felix console. Either enter the shutdown command at the -> prompt. -> shutdown ... $ Or click Stop on the System Information tab of the Felix console, by default http://localhost:8080/system/console. This stops the Servlet container as well, and the console is no longer accessible.