Install TEXTML Server

This procedure describes how to install TEXTML Server on Linux.

Note: If you are installing the TEXTML Server, please see Installing and Configuring TEXTML Server for DITA CMS on the DITA CMS documentation website. Do not use the procedure in this topic.

When you install TEXTML Server, you also create a TEXTML Server instance. The TEXTML Server instance is the service that runs the TEXTML Server software.

The name of the service will be as follows:
textml.<instance_name>
For example, if the instance name is ts01, the service name will be:
textml.ts01
And the command to start TEXTML Server will be:
service textml.ts01 start

This procedure assumes that the .bin installation file was copied to the Linux machine, in the /root folder.

Note: You must perform this procedure as user root.

To install TEXTML Server:

  1. Open a command-line interface to the Linux machine as user root, using a secure shell client such as PuTTY.
  2. Run the following command to install bzip2 and Perl:
    yum install bzip2 perl
  3. Navigate to the /root folder and run the following command:
    sh <installer_name>
    For example:
    sh setuptextmlserver-gcc[x.x]-Linux-x86_64-[version].bin
    The following message is displayed:
    Textmlserver installation
    (I)nstallation (default) or files (E)xtract only? (I/e)
  4. Press Enter to launch the installation.
    The following message is displayed:
    Installation files will be extracted in: /tmp/25005/
    Note: The extraction location (tmp/25005 in the example above) is a temporary folder labeled with a random numerical string.
  5. Wait while the files are extracted.

    When the extraction is completed, the following prompt is displayed:

    (F)ull Installation (default) or (C)ustomized Installation (F/c) 
  6. Do one of the following:
    • To install all TEXTML Server components on the machine, press Enter.
    • To choose which components to install, enter c and press Enter. You will be asked which component to install. Select the components required for your deployment.

    The following message is then displayed:

    Specify location for Ixiasoft folder (Default: /opt/ixiasoft)
  7. Specify the location for TEXTML Server, or press Enter to install to the default location.
    The installation runs; messages similar to the following are displayed, depending on the components you are installing:
    Textmlserver will be installed in: /opt/ixiasoft
                        Installing Textmlserver...
                        Installing libraries...
                        Installing Metaservices...
                        Installing clients (Perl, Php, Java)
                        Installing Administration Console...
                        Installing samples
    When the TEXTML Server is installed, the following message is displayed:
    Are you ready to configure your installation? (Y/n)
  8. Do one of the following:
    • To stop the installation at this point, type N and press Enter. Make sure to run the procedure Configure the TEXTML Server components later, otherwise the installation won't be complete.

      You have completed this procedure.

    • To complete your installation now, press Enter. The following message is displayed:
      Do you want to (create/update/delete) a Textml Server instance? (create)
  9. Do one of the following:
    • If this is the first time that you are installing TEXTML Server, or if you are updating an existing installation but want to create a new instance of TEXTML Server, press Enter.
    • If you are updating an existing installation and want to use the same instance name, enter update and press Enter.

    The following message is displayed:

    What is the path that will contain all TextmlServer instances?
     [/opt/ixiasoft/textmlserver]
  10. Press Enter to accept the default path.
    If this directory does not exist, a message similar to the following is displayed:
    The path "/opt/ixiasoft/textmlserver" does not exist currently. This
    program is going to create it, including needed parent directories. Is this
    what you want? [yes]
    Press Enter to accept.
    A message similar to the following is then displayed:
    The list of instances of Textml Server:
      (none)
    End of the list
    
    What is the name of the instance? [default]
    Note:
    If TEXTML Server instances are already installed on the server, they are listed; for example:
    The list of instances of Textml Server:
      ts01
      ts02
    End of the list
  11. Enter the name of the TEXTML Server instance to create or update and press Enter.
    The following message is displayed:
    What user ID to use? [textml]
    This is the name of the user that will run the TEXTML Server instance. (When you create a docbase, you will need to give write permissions on the docbase folder to this username.)

    You can specify an existing user; if you specify a user that does not exist, the installation procedure will create it.

  12. To accept textml as the username (recommended), press Enter.
    Do one of the following:
    • If you are updating an existing installation, you see the following message and you have completed this procedure.
      Done.
    • If you are creating a new instance, the following message is displayed:
      Do you want to install textmlserver as a service? [yes]
  13. To configure the TEXTML Server component so that it starts automatically when the TEXTML Server service is started, press Enter.
    Note: For a cluster installation, enter no. TEXTML Server will be started manually.
    The installation program confirms that the TEXTML Server configuration is complete:
    Done.
    Note: The next steps depend on the components that you are installing. This procedure assumes that you have installed all components. Simply skip the steps that do not apply.

    The following message is displayed:

    Configuring MetaServices...
    Do you want to: (create/update/delete) a MetaService instance? [create]
  14. Do one of the following:
    • If this is the first time that you are installing TEXTML Server, or if you are updating an existing installation but want to create a new Meta Service instance, press Enter.
    • If you are updating an existing installation and want to use the same instance name, enter update and press Enter.
    The following message is displayed:
    What is the path that will contain all the MetaServices instances?
    [/opt/ixiasoft/metaservices]
  15. Press Enter to accept the default path.
    The following message is displayed:
    The list of instances of Meta Service:
      (none)
    End of the list
    
    What is the name of the instance? [default]
    
    Note: If Meta Service instances are already installed on the server, they are listed.
  16. Enter the name of the TEXTML Server instance to create or update and press Enter.
    The following message is displayed:
    What user ID to use? [textml]
  17. Press Enter to accept the default Metaservices user ID, textml:
    The following message is displayed:
    Do you want to install MetaServices as a service? [yes]
  18. To install the Metaservices component as a service (starts automatically), press Enter:.
    The following message is displayed:
    Done.
    Configuring Clients...
    Which action do you want (install/delete) the Client APIs? [install]
  19. To install the client components, press Enter.
    The following message is displayed:
    What is the path that will contain all Client APIs?
    [/opt/ixiasoft/clients]
  20. To accept the default path, press Enter.
    If this directory does not exist, a message similar to the following is displayed:
    The path "/opt/ixiasoft/clients" does not exist currently. This
                        program is going to create it, including needed parent directories. Is this
                        what you want? [yes]
                    
    Press Enter to accept.
    The installation program confirms that the configuration is complete:
    Done.