teamneusta / pimcore-backend-branding-bundle
Configurable branding for the Pimcore admin backend
Package info
github.com/teamneusta/pimcore-backend-branding-bundle
Type:pimcore-bundle
pkg:composer/teamneusta/pimcore-backend-branding-bundle
Requires
- php: ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0
- pimcore/admin-ui-classic-bundle: ^1.0 || ^2.0
- pimcore/pimcore: ^11.5 || ^12.0
- symfony/config: ^6.4 || ^7.4
- symfony/dependency-injection: ^6.4 || ^7.4
- symfony/event-dispatcher: ^6.4 || ^7.4
- symfony/http-foundation: ^6.4 || ^7.4
- symfony/http-kernel: ^6.4 || ^7.4
- symfony/routing: ^6.4 || ^7.4
- symfony/serializer: ^6.4 || ^7.4
Requires (Dev)
- dama/doctrine-test-bundle: ^6.0 || ^7.3 || ^8.2
- ergebnis/composer-normalize: ^2.50.0
- friendsofphp/php-cs-fixer: ^3.94.2
- phpstan/extension-installer: ^1.4.3
- phpstan/phpstan: ^2.1.42
- phpstan/phpstan-phpunit: ^2.0.16
- phpstan/phpstan-symfony: ^2.0.15
- phpunit/phpunit: ^9.6.34
- spatie/phpunit-snapshot-assertions: ^5.3.2
- symfony/browser-kit: ^6.4 || ^7.4
- teamneusta/pimcore-testing-framework: ^0.13
README
This bundle allows you to configure the branding of thr Pimcore admin backend.
Installation
-
Require the bundle
composer require teamneusta/pimcore-backend-branding-bundle
-
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, instance identification for Pimcore 12 is needed.
Copy the compose.override.yaml.dist file to compose.override.yaml:
cp -n compose.override.yaml.dist compose.override.yaml
And replace all replace_with_secret values with your data.
Then install the dependencies:
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
For the tests there is a different script that includes a database setup.
bin/run-tests