Install Confluence REST Connector on Windows

To install the Confluence REST Connector on Windows, use the following procedure.

To install the Confluence REST Connector

  1. Run the Confluence REST Connector installation program.

    The installation wizard opens.

  2. Read the installation instructions and click Next.

    The License Agreement dialog box opens.

  3. Read the license agreement. If you agree to its terms, click I accept the agreement and click Next.

    The Installation Directory dialog box opens.

  4. Choose an installation folder for Confluence REST Connector and click Next.

    The Service Name dialog box opens.

  5. In the Service name box, type a name to use for the connector’s Windows service and click Next.

    The Service Port and ACI Port dialog box opens.

  6. Type the following information, and click Next.

    Service port The port used by the connector to listen for service actions.
    ACI port The port used by the connector to listen for actions.

    The License Server Configuration dialog box opens.

  7. Type the following information, and click Next.

    License server host The host name or IP address of your License server.
    License server port The ACI port of your License server.

    The IDOL database dialog box opens.

  1. In the IDOL Database box, type the name of the IDOL database into which you want to index documents, and click Next.

    The Proxy Server dialog box opens.

  2. If the connector must use a proxy server to access Confluence, type the following information and click Next.

    Proxy host The host name or IP address of the proxy server to use to access the repository.
    Proxy port The port of the proxy server to use to access the repository.
    Proxy username The user name to use to authenticate with the proxy server.
    Proxy password The password to use to authenticate with the proxy server.

    The Confluence server connection dialog box opens.

  3. Enter the following information, and click Next.

    Confluence server hostname The host name or IP address of the machine that hosts the Confluence instance.
    Confluence server port The port to use to connect to Confluence.
    Use secure connection

    To connect to Confluence over HTTPS, click Yes.

    To connect to Confluence over HTTP, click No.

    The Confluence server user details dialog box opens.

  4. Enter the following information, and click Next.

    Username The user name to use to retrieve data from Confluence.
    Password The password to use to retrieve data from Confluence.

    The Mapped security dialog box opens.

  5. Choose whether to retrieve security information (ACLs) for documents retrieved from Confluence. If you want to use Mapped Security, click Yes. Then, click Next.

    Connector Framework Server dialog box opens.

  6. Choose whether you want to install a new CFS or use an existing CFS.

    • To install a new CFS, select the Install a new CFS check box and click Next.

      The Installation Directory dialog box opens. Go to the next step.

    • To use an existing CFS, clear the Install a new CFS check box and click Next.

      Type the host name and port of your existing CFS installation. Then, click Next and go to step 18.

  1. Choose an installation folder for the Connector Framework Server and then click Next.

    The Installation name dialog box opens.

  2. In the Service name box, type a unique name for the Connector Framework service and click Next. The name must not contain any spaces.

    The CFS dialog box opens.

  3. Type the following information, and click Next.

    Service port

    The port used by CFS to listen for service actions.

    ACI port The port used by CFS to listen for actions.
  4. Type the following information and click Next.

    IDOL Server hostname The host name or IP address of the IDOL server that you want to index documents into.
    ACI port The ACI port of the IDOL server.

    The Pre-Installation Summary dialog box opens.

  5. Review the installation settings. If necessary, click Back to go back and change any settings. If you are satisfied with the settings, click Next.

    The connector is installed.

  6. Click Finish.

    You can now edit the connector's configuration file and start the connector.