Installing the Ephox Editors manually

Installing an Epoxy Editor: TinyMCE or Textbox.io manually is provided as a fallback in case, for whatever reason, the automated installers don't work or you prefer to install manually rather than using the installation wizard.

Before you begin

Before beginning installation, be sure to review the information in the IBM Connections documentation on customizations.

About this task

Procedure

  1. Locate the IBM Connections Customizations directory, which is where Ephox Editors for IBM Connections will be installed.
    The value for this path is provided by the CONNECTIONS_CUSTOMIZATION_PATH variable within WebSphere Application Server. For more information on IBM Connections customizations and the CONNECTIONS_CUSTOMIZATION_PATH, see the topic, Customizing the user interface.
  2. Within the CONNECTIONS_CUSTOMIZATION_PATH/javascript directory, create the installation location for the Ephox Editor for IBM Connections as follows:
    Create the following subdirectory structure: ephox/editors/connections, resulting in the following complete path: CONNECTIONS_CUSTOMIZATION_PATH/javascript/ephox/editors/connections.
    Note: If this directory already exists, then it indicates that previous Ephox Editor customizations have been made to your IBM Connections environment. Any existing files in the CONNECTIONS_CUSTOMIZATION_PATH/javascript/ephox/editors/connections directory must be either deleted or moved to a new folder. It is best to back up these customizations to a separate folder before proceeding.
  3. Copy the Ephox Editors for IBM Connections integration files as follows:
    1. Locate the config directory within the root directory of the uncompressed Ephox Editors for IBM Connections package.
    2. Copy the contents of the config directory to the CONNECTIONS_CUSTOMIZATION_PATH/javascript/ephox/textbox/connections directory.
  4. Locate the IBM Connections Web Resources Provisioning directory, which is where the extension enabling Ephox Editors for IBM Connections will be installed.
    The Web Resources Provisioning directory was created during installation of IBM Connections. By default, this is CONNECTIONS_HOME/data/shared/provision/webresources, for example /opt/IBM/Connections/data/shared/provision/webresources.
  5. Copy the Ephox Editors for IBM Connections extension files as follows:
    1. Locate the editor directory within the root directory of the uncompressed installer package.
    2. Copy the editor directory and all of its contents to the Web Resources Provisioning directory.
  6. Update the IBM Connections cache as follows:
    After Ephox Editors for IBM Connections has been deployed, the IBM Connections server must be notified of the changes.
    1. The cache must be cleared to ensure users download the new files from the server. To update the IBM Connections server cache, perform the steps described in the topic, Post-customization step.
    2. Restart the Common.ear Common enterprise application.
  7. Verify that all Ephox editor services have installed correctly by navigating to the following URL in any web browser: http://<your server and port>/connections/resources/web/ephox.editors.connections/verify.HTML.
    If the installation has been successful, a confirmation message appears alongside installed version numbers.
  8. Configure certificate validation to ensure that this server can connect to other servers in your IBM Connections deployment.
    1. Run the following commands to add both root and intermediate certificates to the default Java trust store of the WebSphere Java SDK (which is different from the WebSphere Cell Default Truststore where you might have added certificates already).
      Attention: Make this change on every WebSphere Application Server node.
      1. cd /opt/IBM/WebSphere/AppServer/java/jre/lib/security
      2. 
        ../../bin/keytool -import -trustcacerts -alias alias_for_root_cert -file path/root_cert_file_name -keystore cacerts -storepass changeit -noprompt
      3. 
        ../../bin/keytool -import -trustcacerts -alias alias_for_intermediate_cert -file path/intermediate_cert_file_name -keystore cacerts -storepass changeit -noprompt
    2. After you have updated all nodes, restart the cluster.
  9. Configure the use of an HTTP proxy for outgoing HTTP/HTTPS requests made by the editor's server-side components.

    Create a configuration file named application.conf and add a proxy element that defines the proxy attributes listed in Table 1.

    Table 1. Proxy settings
    Attribute Description
    http.proxyHost Required. A string defining the host name of the proxy for HTTP (unsecured) connections.
    http.proxyPort Required. An integer defining the port number of the proxy for HTTP (unsecured) connections.
    http.nonProxyHosts Optional. A list of strings separated by vertical lines ("|") listing hosts and domains to be excluded from proxying, for both plain HTTP and HTTPS connections. The strings can contain asterisks ("*") as wild cards. Defaults to "localhost|127.*|[::1]" if not set.
    https.proxyHost Optional. A string defining the host name of the proxy for HTTPS connections.
    https.proxyPort Optional. An integer defining the port number of the proxy for HTTPS connections.
    http.proxyUser Optional. User name for authenticating to both the HTTP and HTTPS proxy.
    http.proxyPassword Optional. Password for authenticating to both the HTTP and HTTPS proxy.

    The following example shows typical proxy settings:

    ephox {
        proxy {
            http.proxyHost = someproxy.internal.corp
            http.proxyPort = 8080
            https.proxyHost = someproxy.internal.corp
            https.proxyPort = 8080
            http.nonProxyHosts = localhost|*.internal.corp
        }
    }