Branding Kit#

Module: spp_branding_kit

Overview#

This module is for sys admins and developers who need to customize OpenSPP's branding, URL routing, and telemetry settings.

Branding Kit provides comprehensive branding customization for OpenSPP deployments. It replaces Odoo branding with OpenSPP branding across the platform, adds URL routing aliases, and manages telemetry configuration.

Use this module when you need to:

  • Replace Odoo branding with OpenSPP or custom branding

  • Provide /openspp URL routes as aliases for /odoo routes

  • Control telemetry data collection

  • Customize email signatures, report footers, and system messages

Module Dependencies#

Dependency

Purpose

spp_security

Central security definitions for OpenSPP modules

base

Odoo core framework

web

Web interface components

base_setup

Base setup wizard

theme_openspp_muk

OpenSPP Theme

Key Features#

URL Routing#

The module provides branded URL paths as aliases:

Branded URL

Original URL

/openspp/programs/123

/odoo/programs/123

/openspp/action/456

/odoo/action/456

/openspp/*

/odoo/*

Telemetry Management#

Control how telemetry data is handled:

Option

Behavior

Enabled

Redirects telemetry to OpenSPP endpoint

Disabled

Completely disables telemetry data collection

Branding Customization#

Element

Customization

System name

Configurable (default: "OpenSPP Platform")

Email signatures

Replaces Odoo signature with OpenSPP

Report headers

Updates company branding

Help links

Custom documentation and support URLs

Module filtering

"OpenSPP Apps" menu for OpenSPP modules

Post-Install Changes#

The module automatically applies these changes on installation:

  • Disables Odoo brand promotion messages

  • Removes module update notification crons

  • Hides theme store menu

  • Injects OpenSPP branding into web client session

Configuration#

After installing:

  1. Open Settings

  2. Scroll to the OpenSPP Branding section

  3. Configure the following options:

Setting

Description

Default

System Name

Name shown in UI

OpenSPP Platform

Documentation URL

Link for help/docs

https://docs.openspp.org

Support URL

Link for support requests

-

Display Branding

Show "Powered by OpenSPP"

Enabled

Enable Telemetry

Send anonymized usage data

Disabled

Telemetry Endpoint

Target URL for telemetry

https://telemetry.openspp.org

Extended Models#

This module does not introduce new models. It extends existing Odoo models:

Model

Extension Purpose

res.users

Custom email signature, removes Odoo URLs

res.config.settings

Branding and telemetry configuration fields

ir.http

Injects OpenSPP branding into session info

ir.module.module

Utility to count paid/proprietary apps