> For the complete documentation index, see [llms.txt](https://docs.cipp.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cipp.app/user-documentation/cipp/settings/branding.md). # Branding Branding controls the logo, cover image, colours, footer and watermark applied to the PDF reports and documents CIPP generates. Settings apply across the whole instance rather than per user, so any report generated by any technician uses the same branding. The default branding applies to every report that has nothing else assigned. Named presets hold a complete alternative set of branding that individual reports and report templates can be pointed at instead. ## Editing The chips at the top of the page choose what the rest of the page is editing. **Default** is the instance-wide branding, and each remaining chip is a preset. Selecting a chip loads that branding into the editor below, and the caption underneath confirms which one you are changing. | Button | Description | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------- | | New preset | Saves whatever is currently on screen as a new preset under a name you supply. The name is required and is limited to 128 characters. | | Rename | Renames the selected preset. Reports and templates already pointing at it keep pointing at it. | | Duplicate | Saves a copy of the selected preset under a new name, pre-filled as the original name followed by "copy". | | Delete | Removes the selected preset and returns the editor to Default. | Rename, Duplicate and Delete only appear while a preset is selected. {% hint style="info" %} Presets share the same logo and cover galleries as the default branding rather than holding their own copies. Deleting a preset removes only the preset, leaving its logo and cover in the gallery for the default branding and any other preset still using them. {% endhint %} ## Default Preset Per Report Sets which preset each type of report reaches for when nothing else specifies one. Each report has its own selector, offering **Use default branding** plus every preset you have created. | Report | | ------------------ | | Executive Report | | Shadow AI Report | | BEC Remediation | | Sharing Report | | Permissions Report | | Report Builder | Precedence runs in three steps. A report template with its own preset assigned wins over the default set here, and the default set here wins over the default branding. {% hint style="info" %} Changes to these selectors are saved as soon as you make them, without needing to select **Save Branding**. They belong to the default branding regardless of which scope the editor is showing. {% endhint %} ## Logo The logo gallery is a horizontal strip of tiles. Select a tile to make that logo active, select the tile marked with a plus to upload a new one, or select **No logo** to leave reports without one. | Requirement | Detail | | ---------------- | ----------------------------------------------------------------------------------------------------------- | | Format | PNG or SVG preferred. JPG and WebP are accepted. | | Maximum size | 5MB. Larger files are rejected before upload. | | Ideal dimensions | Around 200x100px, or a similar aspect ratio. | | Background | A transparent background is recommended, since the logo appears over both the cover image and page headers. | Uploaded logos can be removed with the delete icon in the corner of their tile. ## Cover Image The cover image appears on report cover pages only and is not used elsewhere in the document. The gallery holds an upload tile, a **No cover image** tile, any covers you have uploaded, and six stock images. | Stock cover | | ----------- | | SOC | | Board | | Glasses | | Working | | Laptop | | City | SOC is the default for a new instance. Selecting **No cover image** produces a cover page with no background image. | Requirement | Detail | | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Format | JPG or PNG. | | Maximum size | 5MB. | | Ideal dimensions | Around 1240x1754px, which is A4 portrait at roughly 150dpi, or a similar portrait aspect ratio. | | Subject matter | Soft or dark imagery works best, because the image is displayed full bleed at around 50% opacity behind the cover text. Busy or bright images make the title hard to read. | Uploaded covers can be removed with the delete icon on their tile. Deleting the cover that is currently selected falls back to **No cover image** rather than to a stock cover. ## Cover Preview Renders a sample cover page using your current logo, cover image, colours, cover note and watermark, so you can judge the combination before saving. **Report Type Preview** switches the sample between the report types CIPP produces, each of which uses a different title and subtitle layout. **Preview full report** replaces the cover mock-up with a rendering of the real report document against sample data, which you can page through to see how colours, tables, charts and the footer land on content pages. **Show cover only** returns to the lighter cover preview. {% hint style="info" %} The preview reflects the unsaved state of the editor, so a colour or footer can be judged before it is committed. Variables are shown resolved rather than as tokens, using a sample tenant name and the report type currently selected, so `%tenantname%` reads the way it will on a real report. The sample figures exist only in the preview. A report run against a tenant with no data still shows that it has none. {% endhint %} ## Colors ### Brand Color Your main brand colour, and the one everything else follows until it is overridden. It drives the cover accent, page rules, section headings, table headers and the first chart series. Text placed on it is switched automatically between white and near-black, whichever is readable. The default is `#F77F00`. ### Accent Color An optional second colour, used for subheadings, callout rules and the second chart series. Leaving it unset uses the brand colour everywhere, which is how reports looked before an accent existed. ### Report Colors Colours individual parts of a report. Each one follows the brand colour until you set it, so leaving them all empty keeps reports as they are, and changing the brand colour still moves everything that follows it. | Setting | Description | | ---------------------- | ---------------------------------------------------------------------------- | | Charts | First series colour in every donut, bar and trend chart. | | Chart accent | Second series colour. The rest of the series is built between the two. | | Page titles | The large heading at the top of every content page. | | Cover text | The title, subtitle, date and client name on the cover page. | | Subtitles | The line under a page title, and captions beneath charts and stats. | | Section headings | The heading above each block of content, and the rule under the page header. | | Body text | Paragraphs, bullet lists and table cells. | | Footer | Footer text and page numbers. | | Info cards | The accent stripe on callout boxes and the rule above each stat card. | | Data tables | The header band across the top of every table. Header text follows it. | | Infographic figure | The large statistic on full-bleed chapter dividers. | | Infographic background | The full-bleed divider page behind the artwork. Its text follows it. | | Watermark | The diagonal mark across each page. Drawn at low opacity. | {% hint style="warning" %} Report Colors are stored with the default branding only. A preset holds the brand and accent colours, logo, cover, footer and watermark, but not the per-role colours, so setting them while a preset is selected has no effect. {% endhint %} ## Page Footer Controls the strip at the bottom of every report page. | Setting | Description | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | Footer text | The text shown at the bottom of every page. Limited to 200 characters. | | Cover Note | Replaces the confidentiality note printed on cover pages. Leave it blank to use each report's own wording. Limited to 200 characters. | | Show footer text | Prints the footer text. Switch it off to keep the wording without showing it. | | Show page numbers | Prints page numbers in the footer. | Both text fields accept replacement variables. Typing `%` offers CIPP's variable list, and reports add `%reportname%` and `%reportdate%` on top of it. Matching is not case sensitive, and a variable CIPP cannot resolve is left written as typed rather than blanked, which is what tells you it was mistyped. The 200 character limit applies to the finished text as well as to the wording you type. Text that grows past it once the variables are filled in, typically because of a long tenant name, is trimmed to fit rather than printed past the edge of the page. {% hint style="info" %} Report templates can override the footer or switch it off for an individual report. {% endhint %} ## Watermark Draws text diagonally across every page of a report, the cover included, at low opacity. A fixed mark such as DRAFT or CONFIDENTIAL is typical. **Show watermark** switches it off without losing the wording, so entering text is enough to make it appear. The field takes replacement variables in the same way the footer does. Typing `%` offers CIPP's variable list plus `%reportname%` and `%reportdate%`, so `%tenantname%` stamps each report with the client it was run for. Text is limited to 40 characters. The limit applies to the finished mark as well as to the wording you type, so a tenant name that resolves longer than that is trimmed rather than stretched across the page. ## Saving and Resetting Uploading and deleting images take effect immediately, as do the Default Preset Per Report selectors. Everything else on the page is only stored when you select **Save Branding**. While a preset is selected the button reads **Save** followed by the preset's name, and saves to the preset rather than to the default branding. {% hint style="warning" %} Leaving the page after uploading an image but before saving keeps the uploaded file in the gallery, but the selection reverts to whatever was last saved. Upload, select, then save. {% endhint %} **Reset** returns the default branding to its defaults, restoring the `#F77F00` brand colour and the SOC stock cover, and clearing the accent colour, footer, watermark and per-role colours. It is only offered on the Default scope, since deleting a preset is the equivalent action for a preset. {% hint style="danger" %} Reset permanently deletes every logo and cover image you have uploaded, not just the active selection. There is no confirmation prompt and the files cannot be recovered. Presets survive a reset, but any preset pointing at a deleted image loses it. Keep copies of any custom artwork outside CIPP. {% endhint %} *** ## Feature Requests / Ideas We value your feedback and ideas. Please raise any [feature requests](https://github.com/CyberDrain/CIPP/issues/new?template=feature.yml) on GitHub. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.cipp.app/user-documentation/cipp/settings/branding.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.