Configure the installation properties

Before running the installation script, you must set properties specific to your deployment, such as TEXTML_SERVER_HOST and DOCBASE_NAME.

About this task

To configure the installation properties:

Procedure

  1. In the location where you extracted the package, open the properties.txt file in a text editor.
  2. Configure the following parameters as required.
    Depending on your deployment, some of the parameters can be left at their defaults, except for TEXTML_SERVER_HOST and DOCBASE_NAME. Verify that all the domains, user names, and passwords reflect what has been configured in your deployment.
    Parameter, default value Describes
    IXIASOFT_PATH

    Default value:

    • Windows: c:\Ixiasoft\ccms
    • Linux: /opt/ixiasoft/ccms

    The location where the components will be installed.

    Important: The specified location must NOT exist prior to the script being run.
    SERVICE_RUN_AS (Linux only)

    Default value: root

    The service account username under which the service will be run.

    Note: MadCap Software strongly recommends changing the default and not using the root account.
    TOMCAT_USER

    Default value: admin

    The service user name you want to use to access the Apache Tomcat Administration Console.
    TOMCAT_PASSWORD

    Default value: admin

    The password you want to use to access the Apache Tomcat Administration Console.
    TOMCAT_HTTP_PORT

    Default value: 8080

    The port used by the Apache Tomcat application server for HTTP requests.
    TOMCAT_SHUTDOWN_PORT

    Default value: 8035

    		 The port that the Apache Tomcat application server uses to listen for shutdown requests.
    TOMCAT_AJP_PORT

    Default value: 8039

    		 The port used for AJP implementation if in use.
    SESSION_TIMEOUT

    Default value: 480

    Leave the value as is. This property defines the session timeout in minutes for the Apache Tomcat application server. This value defines the amount of time until an inactive session expires.
    TOMCAT_DISPLAY_NAME (Windows only)

    Default value: Ixiasoft Tomcat CCMS

    The display name of the Apache Tomcat service as you want it to appear in the Services Microsoft Management Console (services.msc).

    TOMCAT_SERVICE_NAME

    Default value: tomcat-ccms

    The actual name, without spaces, of the Apache Tomcat service.

    • Windows: The name of the Apache Tomcat service used by the Services Microsoft Management Console (services.msc).
    • Linux: The name of the script in /etc/init.d for the Apache Tomcat service.
    TOMCAT_XMX

    Default value: 8192

    		 Sets the maximum memory size available to the Apache Tomcat application.
    TOMCAT_XMS

    Default value: 512

    		 Sets the minimum memory size available to the Apache Tomcat application.
    REVERSE_PROXY_SETUP

    Default value: false

    Whether you are using Tomcat behind an Apache HTTP reverse proxy server. Type one of the following:

    • false: when not using a reverse proxy.
    • true: when using a reverse proxy.
    TEXTML_SERVER_HOST

    Default value: textml-server-host

    The name or IP address of the TEXTML Server containing the Content Store to which you want to connect.
    PORT

    Default value: 2500

    The port for TEXTML Server.
    DOCBASE_NAME

    Default value: docbase-name

    The name of the Content Store to which you want to connect.

    The value specified in the DOCBASE_NAME property cannot include spaces. However, once the installation is successful, the CMSServerService.config file can be configured to connect to any docbase, even one with spaces in the name.
    TEXTML_SSL_ENABLE

    Default value: false

    Whether your TEXTML Server is using SSL. Type one of the following:

    • false: when it is not using SSL security.
    • true: when it is using SSL security. Place your SSL root and intermediate certificates into the folder you specified as the SSL_FOLDER value.
    SSL_FOLDER

    Default value: ssl-certs

    The name of the folder containing the SSL root and intermediate certificates.

    KEYSTORE_PASS

    Default value: changeit

    Leave the value as is. This property declares the default password for the Java keystore.
    APPSERVER_LOGIN_DOMAIN

    Default value: ixiasoft

    The domain used by the IXIA CCMS Web Server to log into TEXTML Server. Type it exactly as it is configured in the users.xml configuration file in the Content Store (case sensitive).
    APPSERVER_LOGIN_NAME

    Default value: cmsserviceuser

    The service user name used by the IXIA CCMS Web Server to log into TEXTML Server. Type it exactly as it is configured in the users.xml configuration file in the Content Store (case sensitive).
    APPSERVER_LOGIN_PASSWORD

    Default value: password

    The password used by the IXIA CCMS Web Server to log into TEXTML Server. The password should be the one you configured in your corporate authentication service.

    Note: The following characters are not supported in passwords as clear text: & ' ". However, these characters can be used if the password is encrypted.
    OUTPUTGENERATOR_HOSTNAME

    Default value: HOSTNAME

    		 Hostname of the server where IXIA CCMS Output Generator is installed.

    The hostname cannot include spaces.
    OUTPUTGENERATOR_PORT

    Default value: 1500
    OUTPUTGENERATOR_SHARED_DIRECTORY

    Default value: c:\Ixiasoft\OutputGeneratorSharedDir

    		 The directory where outputs are stored. This directory must be writable by CCMS Web Server. UNC paths are supported.
    OUTPUTGENERATOR_DAYS_TO_KEEP

    Default value: 7

    		 The number of days that CCMS Web Server stores outputs generated in CCMS Web. After the set number of days, the outputs are deleted.
    DITA_FRAMEWORK_VERSION

    Default value: 1.3

    The DITA version used in your company's DTD plugin. Type one of the following:

    • 1.2: if your DTD plugin uses DITA 1.2.
    • 1.3: if your DTD plugin uses DITA 1.3.
  3. Save and close the properties.txt file.
    The CCMS Web Server installation properties are installed.