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.0 (for CQ 5.3)
This section describes how to install, start, and stop CRX instances. For troubleshooting tips during installation, see Troubleshooting.
Copy the CRX quickstart jar file (crx-<version>-<edition>.jar) to the desired directory on the host file system.
Only US-ASCII characters are allowed in the name of the folder used to store the Quickstart jar (or any other runnable jar).
Copy a valid license.properties file into the same directory as the quickstart jar file.
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.
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.
In order to start CRX, simply double-click CRX Quickstart or start CRX from the command line or a custom script.
To start CRX:
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.
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.
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.
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.
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.
Showing Startup Statistics
The CRX Quickstart window shows the startup time:
This also forms a link to startup statistics of the individual elements:
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.
|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.
java -jar quickstart.jar
(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.
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.