teamneusta/pimcore-backend-branding-bundle

Configurable branding for the Pimcore admin backend

0.9.1 2024-09-04 15:32 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0
• pimcore/pimcore: ^10.6 || ^11.0
• symfony/config: ^5.4 || ^6.4
• symfony/dependency-injection: ^5.4 || ^6.4
• symfony/event-dispatcher: ^5.4 || ^6.4
• symfony/http-foundation: ^5.4 || ^6.4
• symfony/http-kernel: ^5.4 || ^6.4
• symfony/routing: ^5.4 || ^6.4
• symfony/serializer: ^5.4 || ^6.4

Requires (Dev)

• dama/doctrine-test-bundle: ^6.0 || ^7.3
• ergebnis/composer-normalize: ^2.43.0
• friendsofphp/php-cs-fixer: ^3.64
• laminas/laminas-zendframework-bridge: ^1.8
• phpstan/extension-installer: ^1.4.2
• phpstan/phpstan: ^1.12.1
• phpstan/phpstan-phpunit: ^1.4.0
• phpstan/phpstan-symfony: ^1.4.8
• phpunit/phpunit: ^9.6.20
• spatie/phpunit-snapshot-assertions: ^4.2.17
• symfony/browser-kit: ^5.4 || ^6.4.8
• teamneusta/pimcore-testing-framework: ^0.12.5

GPL-3.0-or-later

• team neusta GmbH
• Jacob Dreesen

• pimcore

README

This bundle allows you to configure the branding of thr Pimcore admin backend.

Installation

1. Require the bundle

   composer require teamneusta/pimcore-backend-branding-bundle

2. Enable the bundle

   Add the Bundle to your config/bundles.php:

   Neusta\Pimcore\BackendBrandingBundle\NeustaPimcoreBackendBrandingBundle::class => ['all' => true],

Configuration

neusta_pimcore_backend_branding:
    favicon: <url-of-your-fav-icon>
    signet: # or just: <url-of-your-logo>
        url: <url-of-your-logo>
        size: 70%
        position: center
        color: '#000'
    tab_bar_icon:
        url: <url-of-your-logo>
        size: 40px
    # Configure Pimcore's own branding settings (pimcore_admin.branding)
    login:
        color: '#fff'               # => color_login_screen
        invert_colors: true         # => login_screen_invert_colors
        image: <url-of-your-logo>   # => login_screen_custom_image
    backend:
        color: '#fff'               # => color_admin_interface
        background_color: '#000'    # => color_admin_interface_background

when@dev:
    neusta_pimcore_backend_branding:
        title: ACME Development
        sidebar_color: '#fcc243'

when@test:
    neusta_pimcore_backend_branding:
        title: ACME Testing
        sidebar_color: '#005ea1'

when@prod:
    neusta_pimcore_backend_branding:
        title:
            login: Welcome to ACME!
            backend: '{hostname} :: ACME'
        bezel_color: '#00a13a'

Contribution

Feel free to open issues for any bug, feature request, or other ideas.

Please remember to create an issue before creating large pull requests.

Local Development

To develop on your local machine, the vendor dependencies are required.

bin/composer install

We use composer scripts for our main quality tools. They can be executed via the bin/composer file as well.

bin/composer cs:fix
bin/composer phpstan
bin/composer tests