diff --git a/content/collections/docs/white-labeling.md b/content/collections/docs/white-labeling.md new file mode 100644 index 000000000..7b0ee37c0 --- /dev/null +++ b/content/collections/docs/white-labeling.md @@ -0,0 +1,72 @@ +--- +title: 'White Labeling' +intro: 'White Labeling allows you to customize the logo, visible name, and basic theme of the CMS throughout the control panel.' +template: page +stage: 'Needs Polish & Humor' +updated_by: 3a60f79d-8381-4def-a970-5df62f0f5d56 +updated_at: 1612297554 +id: 5bd9426f-23cf-4196-9848-471dff67f5ea +--- + +## Configuration +Your White Label options are available in `config/statamic/cp.php` or through their corresponding .env variables. + +> Keep in mind that according to the license terms you can only rebrand for personal, internal, or client usage. You cannot resell Statamic under another name. + +### CP Theme + +You can choose to switch the default "rad" login theme with a more vanilla (and boring) "business" theme. + +``` php +'theme' => env('STATAMIC_THEME', 'rad'), +``` + +**Available options**: + +- `rad` +- `business` + +
+ Statamic White Label Theme +
Here's the "business" theme with a custom logo
+
+ +### Custom CMS Name + +Set a custom name for the CMS. + +``` php +'custom_cms_name' => env('STATAMIC_CUSTOM_CMS_NAME', 'Statamic'), +``` + +### Custom Logo + +Swap out the logo with a URL to one of your own. + +``` php +'custom_logo_url' => env('STATAMIC_CUSTOM_LOGO_URL', null), +``` + +You may set different logos for inside and outside Control Panel (nav bar and login screen, respectively) by passing an array. + +``` php +'custom_logo_url' => [ + 'nav' => '/logo-white.png', + 'outside' => '/logo-dark.png' +], +``` + +### Custom Favicon + +Swap out the favicon with a URL to one of your own. + +``` php +'custom_favicon_url' => env('STATAMIC_CUSTOM_FAVICON_URL', null), +``` +### Custom CSS + +Set the path to a CSS file and easily add your own styles to the control panel. + +``` php +'custom_css_url' => env('STATAMIC_CUSTOM_CSS_URL', null), +``` diff --git a/content/navigation/docs.yaml b/content/navigation/docs.yaml index 32ce332c7..6587217f1 100644 --- a/content/navigation/docs.yaml +++ b/content/navigation/docs.yaml @@ -94,6 +94,8 @@ tree: entry: cdffd2c9-cf42-495d-a8f1-f416ddfddc29 - entry: 79129d32-3f7c-4215-b6b1-21a2fccafa8d + - + entry: 5bd9426f-23cf-4196-9848-471dff67f5ea - entry: 4b77c19b-129c-4271-a724-eea884eb3e2e - diff --git a/public/img/white-label-login.png b/public/img/white-label-login.png new file mode 100644 index 000000000..aeb92d70e Binary files /dev/null and b/public/img/white-label-login.png differ