Confluence Cloud Streaming Configuration

Overview

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

To enable DDR (Streaming) for an existing Confluence Cloud instance, follow these steps:

Prerequisites

Ensure the following prerequisites are met:

1. Existing Confluence Cloud Instance: There needs to be an active Confluence Cloud instance.

2. Enable Development Mode: Activate Development Mode on the Confluence Cloud site to be monitored. Refer to the official Confluence documentation.

3. Deploy Proxy Container: Set up the Getvisibility container with a public proxy to allow integration with Confluence Cloud.

Steps to Enable Data Streaming

Step 1: Configure Confluence Cloud Data Streaming

1. In the product UI, go to the Data Sources > Confluence Cloud page.

2. Locate the 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 it will be used later.

   
5. Click Save & Close to apply changes.

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

Deployment Instructions

1. Download Docker image parts: Please download all files listed below:

1. Merge Docker image parts:

   Copy

   cat confluence-cloud-streaming-proxy.tar.gz.part* > \
   confluence-cloud-streaming-proxy.tar.gz.joined

2. Load Docker image:

   Copy

   docker load --input confluence-cloud-streaming-proxy.tar.gz.joined

3. Prepare a Docker Environment: Ensure that Docker is installed and configured on the infrastructure where the confluence-cloud-streaming-proxy application will be hosted. This will be the user environment.

4. Set Environment Variables: Configure the following environment variables to allow the Confluence Cloud instance to communicate with the proxy application:

1. 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 the Docker configuration. Update the values as needed for the specific 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 configured setup.

Step 3: Expose the Application

To expose the application publicly, consult with relevant internal team such as IT or DevOps team. For testing ngrok's free plan can be used 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 the 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