Configure the installation properties for IXIASOFT CCMS Web

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

  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 Describes
    IXIASOFT_PATH

    The location where the components will be installed.

    Important: The specified location must NOT exist prior to the script being run.

    Default value:

    • Windows: c:\Ixiasoft\ccms
    • Linux: /opt/ixiasoft/ccms
    SERVICE_RUN_AS (Linux only)

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

    Default value: root

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

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

    Default value: admin
    TOMCAT_PASSWORD

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

    Default value: admin
    TOMCAT_HTTP_PORT

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

    Default value: 8080
    SESSION_TIMEOUT

    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.

    Default value: 480
    TOMCAT_DISPLAY_NAME

    (Windows only)

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

    Default value: Ixiasoft Tomcat CCMS

    TOMCAT_SERVICE_NAME

    The actual name (without spaces) of the Apache Tomcat service. In Windows, this is the name of the Apache Tomcat service used by the Services Microsoft Management Console (services.msc). In Linux, it is the name of the script in /etc/init.d for the Apache Tomcat service.

    Default value: tomcat-ccms

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

    Default value: 8192
    TOMCAT_XMS Sets the minimum memory size available to the Apache Tomcat application.

    Default value: 512
    REVERSE_PROXY_SETUP

    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.

    Default value: false
    TEXTML_SERVER_HOST

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

    Default value: textml-server-host
    PORT

    The port for TEXTML Server.

    Default value: 2500
    DOCBASE_NAME

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

    Default value: docbase-name

    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

    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.

    Default value: false
    SSL_FOLDER

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

    Default value: ssl-certs
    KEYSTORE_PASS

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

    Default value: changeit
    APPSERVER_LOGIN_DOMAIN

    The domain used by the IXIASOFT 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).

    Default value: ixiasoft

    APPSERVER_LOGIN_NAME

    The service user name used by the IXIASOFT 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).

    Default value: cmsserviceuser

    APPSERVER_LOGIN_PASSWORD

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

    Default value: password

    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 Hostname of the server where IXIASOFT CCMS Output Generator is installed.

    Default value: HOSTNAME

    The hostname cannot include spaces.
    OUTPUTGENERATOR_PORT

    Default value: 1500
    OUTPUTGENERATOR_SHARED_DIRECTORY The directory where outputs are stored. This directory must be writable by CCMS Web Server. UNC paths are supported.

    Default value: c:\Ixiasoft\OutputGeneratorSharedDir
    OUTPUTGENERATOR_DAYS_TO_KEEP The number of days that CCMS Web Server stores outputs generated in CCMS Web. After the set number of days, the outputs are deleted.

    Default value: 7
    DITA_FRAMEWORK_VERSION

    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.

    Default value: 1.3
  3. Save and close the properties.txt file.