Skip to content

Configuration Scope: Environment-Specific

This setting is environment-specific and must be configured separately in each environment (dev, test, prod). Changes here will not be included in configuration exports.

Enabling PDF Watermarking

Overview

Brief Connect can add a watermark to all generated PDF documents, such as PDF Packs and Snapshots. This feature enhances traceability by embedding details about the document's origin directly onto each page.

When enabled, the watermark includes: * The full name of the user who generated the document. * The user's email address. * The precise date and time of generation.

This guide explains how to enable and configure PDF watermarking.


How it Works

The watermarking feature is controlled by a single environment variable on the Brief Connect server. When this variable is set to true, a diagonal watermark is applied across every page of the generated PDF files.

The watermark text is formatted to be visible but not obstructive, appearing with partial transparency behind the main content.


Configuration

To enable PDF watermarking, you must configure the following environment variable on the server hosting the Brief Connect application:

Environment Variable: WatermarkPDF

Set this variable to true to activate the feature. If the variable is set to false, is empty, or does not exist, watermarking will be disabled by default.

Configuration Example:

To turn on watermarking for all PDF documents:

WatermarkPDF=true

Resulting Behavior: * All newly generated PDF Packs, Snapshots, and exported PDFs will contain a watermark. * Existing PDFs will not be affected. * The watermark is applied in addition to the standard PDF security restrictions, which prevent editing.