Confluence Cloud Streaming Configuration

This document provides information on how to configure Confluence Cloud connection with real-time events monitoring and data streaming.

Overview

Follow this guide to integrate Confluence Cloud with your system for real-time events monitoring.

To enable Real Time Events Monitoring (Streaming) for an existing Confluence Cloud instance, follow these steps:

Prerequisites

Ensure the following prerequisites are met:

  1. Existing Confluence Cloud Instance: You must have an active Confluence Cloud instance.
  2. Enable Development Mode: Activate Development Mode on your Confluence Cloud site. Refer to the official Confluence documentation.
  3. Deploy Proxy Container: Set up our container with a public proxy to allow integration with Confluence Cloud.

Step 1: Configure Confluence Cloud Data Streaming

  1. In the product UI, go to the Data Sources > Confluence Cloud page.
  2. Locate your existing Confluence Cloud scan configuration and select Edit Configuration.
  3. Within the Edit Confluence Cloud Configuration page, toggle Data Streaming to ON.
  4. Copy the Webhook URL provided, as you will use it later.
  5. Click Save & Close to apply changes.
    Note: To enable data streaming, you will need to deploy the confluence-cloud-streaming-proxy container in your own infrastructure e.g. using Docker or Kubernetes. This step involves configuring environment variables and setting up Docker for integration with Confluence Cloud.

Step 2: Set Up confluence-cloud-streaming-proxy Application

Deployment Instructions
  1. Download Docker image parts: Download all files listed below:
  2. Merge Docker image parts: 
    cat confluence-cloud-streaming-proxy.tar.gz.part* > \
confluence-cloud-streaming-proxy.tar.gz.joined
  3. Load Docker image: 
    docker load --input confluence-cloud-streaming-proxy.tar.gz.joined
  4. Prepare a Docker Environment: Ensure you have Docker installed and configured on the infrastructure where you’ll host the confluence-cloud-streaming-proxy application. This will be your environment.
  5. Set Environment Variables: Configure the following environment variables to allow your Confluence Cloud instance to communicate with the proxy application.
    Table 1.
    Environment variable Description
    APP_LISTENER_PUBLIC_ACCESSIBLE_URL Publicly accessible URL at which app can be accessed. It is used in communication between Confluence Cloud Webhook mechanism and app
    APP_WEBHOOK_URL Webhook URL (taken from Forcepoint DSPM UI Confluence Cloud connector configuration form)
  6. Map Persistent Volume: Map a persistent volume to the /app/db/ directory within the container to ensure data retention across sessions.

    Example docker-compose.yml Configuration

    Use the following example to help set up your Docker configuration. Update the values as needed for your environment:
    services:
  app:
    image: getvisibility/confluence-cloud-streaming-proxy:v0.3.2
    ports:
      - "8080:8080"
    environment:
      APP_LISTENER_PUBLIC_ACCESSIBLE_URL: https://5977-88-156-142-22.ngrok-free.app
      APP_WEBHOOK_URL: https://tenantabc.getvisibility.com/scan-manager/external/webhooks/notification/71ccab3d56980a2d9c766f42c86d36ffedc34258a0f226aaf56a628f06e9d89d
    volumes:
      - ./app-db/:/app/db/

    Once configured, start the container by running docker-compose up -d or an equivalent command based on your setup.

Step 3: Expose the Application

To expose the application publicly, consult with your IT or DevOps team. For testing, you can use ng rok's free p lan to expose the app port as needed.

  1. Start the Application: Ensure the application runs before proceeding with the integration setup.

Step 4: Install the Integration in Confluence Cloud

To install the integration, follow the steps:

  1. Go to the Manage apps page in Confluence Cloud.

  2. Select the Upload app.

  3. Paste the publicly accessible address in the form and press Upload.

  4. The application will install, and your integration will be ready in a few seconds.

Uninstall integration from Confluence Cloud

To uninstall the integration, follow the steps:

  1. Go to the Manage apps page in Confluence Cloud.

  2. Find Getvisibility Confluence Cloud Streaming Proxy and click Uninstall.

  3. Confirm by selecting Uninstall app.

  4. Delete any associated containers and settings from your organization's infrastructure.