raffaelj/cockpit-whitelabel

Custom logo and custom colours for Cockpit CMS

0.1.1 2020-08-15 18:33 UTC

Requires

• composer/installers: ^1.9

MIT

• Raffael Jesche

• cockpit
• white label
• custom colours

README

This addon is not compatible with Cockpit CMS v2.

See also Cockpit CMS v1 docs, Cockpit CMS v1 repo and Cockpit CMS v2 docs, Cockpit CMS v2 repo.

Custom logo and custom colours for Cockpit CMS. Maybe I'll add some more options in the future.

Installation

Copy this repository into /addons and name it WhiteLabel or

cd path/to/cockpit
git clone https://github.com/raffaelj/cockpit_WhiteLabel.git addons/WhiteLabel

Configuration

Upload an image, copy it's url and set a config variable in config/config.yaml or config/config.php.

whitelabel:
    logo: "#uploads:2019/11/08/5dc548b41c0cdlogo.png"
    logoWidth: 8em    # optional, default: 30px
    logoHeight: 3em   # optional, default: 30px
    hideName: true    # hide app name
    colors:
        - #ff0000
        - #00ff00
        - #0000ff

return [
    'whitelabel' => [
        'logo'       => '#uploads:2019/11/08/5dc548b41c0cdlogo.png',
        'logoWidth'  => '8em',   # optional, default: 30px
        'logoHeight' => '3em',   # optional, default: 30px
        'hideName'   => true,    # hide app name
        'colors' => [
            '#ff0000',
            '#00ff00',
            '#0000ff',
        ],
    ];
];

I didn't write a user interface, because normally you do this task once and forget about it.

The logo url can be in the following formats

• internal paths (my favourite, because it works on local and production host without changes)
  • #uploads:2019/11/08/5dc548b41c0cdlogo.png
  • assets:app/media/icons/code.svg
• full url
  • https://example.com/storage/uploads/2019/11/08/5dc548b41c0cdlogo.png
  • https://example.com/logo.png
• relative path to site url
  • /logo.png
• full path
  • /var/www/virtual/username/html/storage/uploads/2019/11/08/5dc548b41c0cdlogo.png
  • /var/www/virtual/username/html/logo.png

The colors are used for the custom color picker in the settings of collections, forms and singletons.