Installing, Starting, and Stopping CQ5 WCM

How to Install CQ WCM Author and Publish Instances using Quickstart

This section describes how to install CQ WCM. Generally, when you set up CQ WCM, you need to set up an Author and a Publish instance, which are described in Installing an Author instance and Installing a Publish instance. If, for testing or other purposes, you need to install CQ WCM out of the box, you can use the generic procedure.

Installing a CQ WCM instance - Generic procedure

This procedure is a generic, quickstart procedure for installing CQ WCM. You do not need to perform this procedure before installing an author or publish instance. To install an author or publish instance, see Installing an Author instance and Installing the Publish instance.

To install a CQ WCM instance:

  1. Copy the CQ WCM cq-wcm-quickstart-<version>.jar file (for example, cq-wcm-quickstart-5.1.0.20081114.jar) to the desired directory on the host file system.

  2. Copy a valid license.properties file into the same directory as the cq-wcm-quickstart-<version>.jar file.

    [Note]Note

    If when starting the application, you do not provide the license.properties file, CQ WCM redirects you to the Welcome screen where you enter a valid license key. You can also request a valid license key from Day at this time.

  3. Start CQ WCM Quickstart by doing one of the following:

    • If using a GUI file-system explorer, double-click the cq-wcm-quickstart-<version>.jar file. This installs and automatically starts the server.

      [Note]Note

      The repository data is stored in the subdirectory crx-quickstart/repository.

    • If using the command line, type the following:

      java -jar cq-wcm-quickstart-<version>.jar
    • Use a custom script located in the crx quickstart folder, such as server.bat to start CQ. The Start and Stop scripts are for UNIX, Linux, and Macintosh. The server.bat script is for Windows.

      [Note]Note

      You cannot use a custom script when you install the quickstart.jar file unless you expand the file first. Use the -unpack option on the command line to unpack the contents before running the script as in java -jar cq-wcm-quickstart-<version>.jar -unpack.

  4. When the installation is complete, you are automatically redirected to http://localhost:4502/bin/login.html.

    [Note]Note

    CQ WCM quickstart selects the first available port from the following list: 4502,8080,8081,8082,8083,8084,8085,8888,9362,<random>. You can also set the port number. See installing an author instance for an example on how to set a port number.

Installing an Author instance

This procedure describes how to set up a default Author instance on port 4502 of the desired host.

To install an author instance:

  1. On the host file system, create a directory and name it author.

  2. Copy the CQ5 cq-wcm-quickstart-<version>.jar file into author/ and rename the file cq5-author-4502.jar. A different port can be set in the filename.

  3. Copy a valid license.properties file into the same directory as the cq-wcm-quickstart-<version>.jar file.

    [Note]Note

    If when starting the application, you do not provide the license.properties file, CQ WCM redirects you to the Welcome screen where you enter a valid license key. You can also request a valid license key from Day at this time.

  4. Start CQ WCM Quickstart:

    • If using a GUI file-system explorer, double-click the cq5-author-4502.jar file.

    • If using the command line, type:

      java -jar cq5-author-4502.jar
    • Use a custom script located in the crx quickstartfolder, such as server.bat to start CQ. The Start and Stop scripts are for UNIX, Linux, and Macintosh. The server.bat script is for Windows.

      [Important]Important

      You cannot use a custom script when you install the quickstart.jar file unless you expand the file first. Use the -unpack option on the command line to unpack the contents before running the script as in java -jar cq-wcm-quickstart-<version>.jar -unpack.

  5. When the installation is completed, you are automatically redirected to http://localhost:4502/bin/login.html.

    [Note]Note

    With the default settings, the syndication agent points toward the publish instance at http://localhost:4503/.

Installing a Publish instance

To set up a publish instance on port 4503 of the desired host, you perform the same steps as in installing an author instance except that you create a directory named publish (instead of author) and you rename the quickstart.jar file as cq5-publish-4503.jar. You can select any port number.

To install a publish instance:

  1. On the host file system, create a directory and name it publish.

  2. Copy the CQ WCM cq-wcm-quickstart-<version>.jar file into publish/ and rename it cq5-publish-4503.jar. A different port can be set in the filename.

  3. Copy a valid license.properties file into the same directory as the cq-wcm-quickstart-<version>.jar file.

    [Note]Note

    If when starting the application, you do not provide the license.properties file, CQ WCM redirects you to the Welcome screen where you enter a valid license key. You can also request a valid license key from Day at this time.

  4. Start CQ WCM Quickstart:

    • If using a GUI file-system explorer, double-click the cq5-publish-4503.jar file.

    • If using the command line, type:

      java -jar cq5-publish-4503.jar
    • Use a custom script located in the crx quickstartfolder, such as server.bat to start CQ. The Start and Stop scripts are for UNIX, Linux, and Macintosh. The server.bat script is for Windows.

    [Important]Important

    You cannot use a custom script when you install the quickstart.jar file unless you expand the file first. Use the -unpack option on the command line to unpack the contents before running the script as in java -jar cq-wcm-quickstart-<version>.jar -unpack.

  5. When the installation is completed, you can browse your site (for example, http://localhost:4503/content/geometrixx/en/company.html)

Starting CQ WCM

Running CQ WCM is the same as starting it: you double-click CQ Quickstart or start CQ from the command line or a custom script.

To start CQ WCM:

  1. Navigate to the quickstart.jar file.

  2. Do one of the following:

    • If using a GUI file-system explorer, double-click the quickstart.jar file.

    • If using the command line, type java -jar cq-wcm-quickstart-<version>.jar.

    • Use a custom script located in the crx quickstart folder, such as server.bat to start CQ. The Start and Stop scripts are for UNIX, Linux, and Macintosh. The server.bat script is for Windows.

      [Note]Note

      You cannot use a custom script when you install the quickstart.jar file unless you expand the file first. Use the -unpack option on the command line to unpack the contents before running the script.

    server.bat looks like the following:

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

Stopping CQ5 WCM

To stop CQ WCM, do one of the following:

  • If you started CQ WCM from either a script or the command line, press Ctrl+C to shut down the server.

    [Note]Note

    If you are running UNIX with the start script, you must use the Stop script to stop CRX.

  • If you started CQ WCM by double-clicking the jar file, click the On button (which then changes to Off) to shut down the server.