Confluence Cloud Streaming Configuration
This document provides information on how to configure Confluence Cloud connection with real-time events monitoring and data streaming.
Last updated
Was this helpful?
This document provides information on how to configure Confluence Cloud connection with real-time events monitoring and data streaming.
Last updated
Was this helpful?
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:
Ensure the following prerequisites are met:
Existing Confluence Cloud Instance: You must have an active Confluence Cloud instance.
Enable Development Mode: Activate Development Mode on your Confluence Cloud site. Refer to the official Confluence documentation.
Deploy Proxy Container: Set up our container with a public proxy to allow integration with Confluence Cloud.
In the product UI, go to the Data Sources > Confluence Cloud page.
Locate your existing Confluence Cloud scan configuration and select Edit Configuration.
Within the Edit Confluence Cloud Configuration page, toggle Data Streaming to ON.
Copy the Webhook URL provided, as you will use it later.
Click Save & Close to apply changes.
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.
confluence-cloud-streaming-proxy ApplicationDeployment Instructions
Download Docker image parts: Please download all files listed below:
Merge Docker image parts:
Load Docker image:
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 a your environment.
Set Environment Variables: Configure the following environment variables to allow your Confluence Cloud instance to communicate with the proxy application:
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 Getvisibility UI Confluence Cloud connector configuration form)
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:
Once configured, start the container by running docker-compose up -d or an equivalent command based on your setup.
To expose the application publicly, consult with your IT or DevOps team. For testing, you can use ngrok's free plan to expose the app port as needed.
Start the Application: Ensure the application runs before proceeding with the integration setup.
To install the integration, follow the steps:
Go to the Manage apps page in Confluence Cloud.
Select the Upload app
Paste the publicly accessible address in the form and press Upload.
The application will install, and your integration will be ready in a few seconds.
To uninstall the integration follow the steps:
Go to the Manage apps page in Confluence Cloud.
Find Getvisibility Confluence Cloud Streaming Proxy and click Uninstall.
Confirm by selecting Uninstall app.
Delete any associated containers and settings from your organization’s infrastructure
e.g.
e.g.
