spp_branding_kit

OpenSPP Branding Kit

Replaces Odoo branding with OpenSPP branding across the platform. Adds /openspp URL routing as an alias for /odoo routes, redirects telemetry to OpenSPP endpoints or disables it entirely, and customizes system messages, email signatures, and report footers. Works with theme_openspp_muk for visual styling.

Key Capabilities

• URL routing: /openspp/programs/123 works as an alias for /odoo/programs/123
• Telemetry control: redirect to OpenSPP endpoint or disable entirely via configuration
• Session branding: injects OpenSPP system name and version into web client session
• Email signatures: replaces default Odoo signature with OpenSPP branding
• Report customization: updates company report headers and footers with OpenSPP text
• Post-install debranding: disables Odoo brand promotion messages, update notification crons, and theme store menu
• Module filtering: adds "OpenSPP Apps" filter and menu to view OpenSPP-specific applications
• Debug restriction: optionally restricts debug mode access to administrators only

Key Models

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

Model	Extension Purpose
res.users	Custom email signature, removes Odoo account URL
res.config.settings	Adds branding and telemetry configuration fields
ir.http	Injects OpenSPP branding into web client session info
ir.module.module	Provides utility to count paid/proprietary apps

Configuration

After installing:

1. Open Settings
2. Scroll to the OpenSPP Branding app card
3. Configure System Name (default: "OpenSPP Platform")
4. Set Documentation URL and Support URL for help links
5. Toggle Display OpenSPP Branding to show/hide "Powered by OpenSPP"
6. Configure telemetry: Enable Telemetry (redirects to OpenSPP endpoint) or disable
7. Set Telemetry Endpoint if redirecting (default: https://telemetry.openspp.org)

Post-install hook automatically disables Odoo brand promotion, module update notifications, and theme store menu.

UI Location

• Apps > OpenSPP Apps — filtered view of OpenSPP-specific applications
• Settings > OpenSPP Branding — branding and telemetry configuration
• Settings > General Settings > About — OpenSPP platform information card

Security

This module does not define new security groups or access control entries. It extends existing models that already have ACLs. Configuration access requires base.group_system (Settings).

Extension Points

• Override get_branding_config(env) in utils.py to customize branding data injected into session
• Inherit res.users to further customize email signatures or user menu elements
• Inherit ir.http.session_info() to add custom branding keys to web client session
• Patch JavaScript router in static/src/js/router_patch.js to customize URL prefix beyond /openspp

Dependencies

spp_security, base, web, base_setup, theme_openspp_muk

Table of contents

• Changelog

Changelog

19.0.2.0.1

• Upgrade to Production/Stable status
• Fix category to OpenSPP/Configuration
• Use search_count() in get_paid_apps_count() for efficiency
• Add proper JSON response content-type to /openspp/about endpoint
• Clean up outdated requirements.txt referencing Odoo 17
• Increase test coverage to 95%+ (utils, settings, controllers, HTTP endpoints)
• Update readme/DESCRIPTION.md to follow module description template
• Fix uninstall hook to clean up spp.* parameters (was using wrong openspp.* prefix)
• Remove global Apps menu override that forced OpenSPP filter on all users
• Scope CSS branding selectors to login page context
• Change /openspp/about endpoint from public to authenticated access
• Remove empty placeholder view files (login_templates.xml, backend_customization.xml)
• Remove missing banner.png reference from manifest
• Add CSRF justification comment on /publisher-warranty endpoint

19.0.2.0.0

• Initial migration to OpenSPP2

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

• OpenSPP.org
• OpenSPP Project

Maintainers

Current maintainers:

This module is part of the OpenSPP/OpenSPP2 project on GitHub.

You are welcome to contribute.