Overview / CRX 2.3 / How To / 

Installing, Starting, and Stopping CRX
You are reading the CRX 2.3 version of Installing, Starting, and Stopping CRX.
This documentation is also available for the following versions: CRX 2.2  CRX 2.1  CRX 2.0 (for CQ 5.3) 

This section describes how to install, start, and stop CRX instances. For troubleshooting tips during installation, see Troubleshooting.

Installing CRX

To install CRX:

  1. Copy the CRX quickstart jar file (crx-<version>-<edition>.jar) to the desired directory on the host file system.

    Caution

    Only US-ASCII characters are allowed in the name of the folder used to store the Quickstart jar (or any other runnable jar).

  2. Copy a valid license.properties file into the same directory as the quickstart jar file.

    Note

    Note: If when starting the application, you do not provide the license.properties file, CRX asks you for a valid license key. You can request a valid license key from Day at this time.

  3. Start CRX Quickstart for the first time.

    • When CRX is started for the first time, it will automatically create a crx-quickstart folder in the same directory as the quickstart jar file. 
    • Inside the crx-quickstart directory, CRX will place its working files and create a fresh repository.

    Due to this initialization process, the first startup will take longer than subsequent startups. See Starting CRX for detailed instructions on how to start CRX Quickstart.

Starting CRX

In order to start CRX, simply double-click CRX Quickstart or start CRX from the command line or a custom script.

To start CRX:

  1. Navigate to the quickstart jar file (crx-<version>-<edition>.jar), either in your GUI file-system window or in a terminal, using the command line.

  2. Do one of the following:

    • If using a GUI (for example, Windows Explorer or MAC Finder), double-click the quickstart jar file (crx-<version>-<edition>.jar).
    • If using the command line, enter the java command using the following principle:
      with a 32bit VM:
          java -Xmx384M -jar crx-<version>-<edition>.jar
      or, with a 64bit VM
          java -XX:MaxPermSize=128m -Xmx512M -jar crx-<version>-<edition>.jar
      CRX is ready when the message "Press CTRL-C to shutdown the Quickstart server..." is seen.

    Note

    By default, CRX will automatically open a browser window on startup. When starting CRX from the command line on a remote server, you may want to suppress this by adding the -nobrowser option to the above command line.

  3. In order to automate the startup of CRX, you can use a startup script.

    When CRX is started the first time, it places example startup scripts in the crx-quickstart/server folder. The start and stop scripts are for UNIX, Linux and Macintosh, the server.bat script is for Windows.

Note

See Configuring JVM Settings for CRX if you need to change some of the advanced JVM settings for CRX (such as JVM memory size).

CRX starts and automatically opens the appropriate page in your web browser. Once started, you have access to CRX. See the CRX User Guide for details on using CRX.

file

Showing Startup Statistics

The CRX Quickstart window shows the startup time:

file

This also forms a link to startup statistics of the individual elements:

file

Stopping CRX

To stop CRX, do one of the following:

  • If you started CRX from the command line, press Ctrl+C to shut down the server.
  • If you started CRX with the start script, now use the stop script.
  • If you started CRX by double-clicking on the jar file, click on the On button in the Quickstart window. This will change to Off as the server shuts down.

Configuring JVM Settings for CRX

CRX is a Java application and runs within a Java Virtual Machine runtime environment (java process within your operating system). The default settings of the JVM are usually correct for the majority of CRX use cases, but sometimes you need to adjust them to match your specific use case or the application running on top of CRX. One of the settings that might require modification is the JVM memory size.

Depending on how CRX is started, the table below presents the ways of changing the JVM settings for CRX.

 

Startup method
 Default JVM Memory
 How to change JVM settings
Double-clicking the quickstart.jar

384MB heap for a 32bit VM.
512MB heap and 128MB PermGen for a 64bit VM.

(equivalent to using the -Xmx and -XX:MaxPermSize JVM options)

 You cannot change these settings when using double-click. Please use other startup methods.

Command line:

java -jar quickstart.jar

 64MB
(default JVM setting; needs to be increased)
 

Specify the required settings on the command line (before the -jar parameter).

For example, to adjust the default memory setting to 512MB and the PermGen space to 128MB, use the following command line:

java -Xmx512M -XX:MaxPermSize=128M -jar quickstart.jar

Recommended values are the ones used when double-clicking the jar file, see above.

See Java JDK Tools, java launcher tool documentation for your version of Java (e.g., for Java 1.5)


Note: the Quickstart -fork option overrides JVM settings with its own defaults. Not recommended if you need full control over JVM settings. If you do need to use it, you can specify the extra JVM parameters using the -forkargs option.

Startup scripts:

startup.bat (Win)

start/stop (Unix)

Defined by script variables:

JVM_MINHEAP / JVM_MAXHEAP

CQ_HEAP_MIN / CQ_HEAP_MAX

 Change the settings in the startup scripts. Some settings (for example, memory) have dedicated script variables. You can also add arbitrary settings for JVM by adding options to the java launcher tool with the JVM_OPTS / CQ_JVM_OPTS script variables.
Your comments are welcome!
Did you notice a way we could improve the documentation on this page? Is something unclear or insufficiently explained? Please leave your comments below and we will make the appropriate changes. Comments that have been addressed, by improving the documentation accordingly, will then be removed.

COMMENTS

  • By charles rose - 11:36 PM on Feb 24, 2011   Reply
    Don't see where the quickstart window is. Therefore couldn't stop it. Went to admin console. Clicked Stop Framework. Said framework stopped but port 7402 still open. Tried going to the quickstart server directory, running the stop script - said server not running, but port still open. Not very good situation.
    • By Chris Zumbrunn - 4:54 PM on Feb 27, 2011   Reply
      How did you start CRX? Did you start it with the -nobrowser option? Were you running CRX locally on your system or on a remote server?

      Clicking Stop Framework in the OSGI console just stops the OSGI framework, not CRX Quickstart, which will usually trigger the OSGI framework to start again.

      In a shell on the system where you started CRX, you would be able to see the PID of the running CRX Quickstart in the list of all running processes. Attempting to kill that PID should cause CRX to stop. Depending on what CRX is doing at the time, it may take some time to shut down.
    • By David Scott - 11:09 PM on Mar 04, 2011   Reply
      If you stated CRX on the command-line using "java -jar crx-<version>-<edition>.jar" (such as through an Ant script), how can you stop CRX using the command-line? I want to run CRX on an automated system that I do not have a DOS console that I can send Ctrl+C to. Thanks!
      • By jkautzma - 6:05 PM on Mar 07, 2011   Reply
        Hi, for your automated use case you should use the start and stop scripts.
        • By David Scott - 8:43 PM on Mar 07, 2011   Reply
          I figured I would need scripts, and I already have a start script that works in Ant. But what would the content of the stop script need to be on Windows? Thanks.
          • By Bertrand Delacretaz - 4:34 PM on Mar 14, 2011   Reply
            If you're creating your tests in Java you might want to have a look at the Sling testing tools found at http://svn.apache.org/repos/asf/sling/trunk/testing/

            Those are still a work in progress and there's no documentation there yet (besides the code which is very readable IMO), but studying the samples/integration-tests module in there should show you how those tools start and stop the Sling runnable jar. You should be able to use the same mechanism for CRX.

            Feedback and questions about those tools are welcome on the Sling mailing lists, see http://sling.apache.org/site/project-information.html#ProjectInformation-lists

      ADD A COMMENT

       

      In order to post a comment, you need to sign-in.

      Note: Customers with DayCare user accounts need to create a new account for use on day.com.

      ***
      On this page:
      - Installing CRX
      - Starting CRX
      - Showing Startup Statistics
      - Stopping CRX
      - Configuring JVM Settings for CRX
      Jump to Page Comments
      Reviewed by TRUSTe: site privacy statement

      Copyright © 2012 Adobe Systems Incorporated. All rights reserved.

      Use of this website signifies your agreement to the Terms of Use and Online Privacy Policy.