# Mautic Whitelabeler

Whitelabeling [Mautic](http://github.com/mautic/mautic) is a tedious process. Not to mention you have to redo your work each time you update Mautic because your files are overwritten in the update process.

Mautic Whitelabeler makes customizing the core branding elements of Mautic a super simple, automated process. Just clone this directoy on your server and navigate to it in your browser.

![Screenshot](preview.png)

**With this script, you can easily customize:**

* The main logo at the top of the sidebar and its background color.
* Logo on the login screen
* Company name in page titles, globally
* Colors (links, buttons, panel headings)
* Favicon
* Company name in the footer

## Requirements

* Mautic versions 2.5.0 - 2.15.0
* PHP cURL extension
* `allow_url_fopen` php.ini directive set to true (uses file_get_contents)
* Apache `mod_rewrite` enabled
* GD Library

## Installation / Usage

1. It's probably smart to backup your files first. At least do it the first time you use this.

2. Clone this repository somewhere on your server that can access your Mautic installation (it's most convenient to clone it in the root of your Mautic directoy).

3. Specify the "Company Name," which will replace "Mautic" in the page titles and footer.

4. Specify your color hex codes.
	* **Logo Background:** This is the color behind the Mautic logo in the sidebar (top left corner).
	* **Primary Color:** This color will replace Mautic's primary purple in links, buttons and panel headers.
	* **Secondary Color:** This will define the link and button mouse hover state color.

5. Specify sidebar and login logos files (preferably transparent PNG files) and their widths and margins, which you can adjust with a live preview.
	* Avoid uploading large images (i.e., "large" in terms of dimensions ~ > 1500px might be too large).
	* `imagecreatefrompng` function can exceed PHP's memory limit and fail while trying to process and resize large images.

6. Specify a favicon. If you don't have a .ico file, one will be created. If you don't specify a file, a favicon will be generated from your login logo file.

7. Make sure to REMOVE or MOVE this directory so it's not publicly accessible once you're done using it.

## Common Issues

**Mautic installation not found here**

This means the script is not able to find the absolute path to the Mautic files on your server. This validation checks for a `version.txt` file in the `/app` folder. Make sure this file exists and is accessible by your web server (usually `chown -R www-data:www-data /path/to/mautic` does the trick).

**Mautic installation not found at this URL**

This means the script is not able to find your Mautic installation via its publicly accessible URL. This validation checks for the `LICENSE.txt` file in Mautic's root directory to confirm Mautic's root URL. Make sure the file exists and is accessible in your browser.

Make sure the `allow_url_fopen` php.ini directive is set to true (uses file_get_contents). Make sure the cURL PHP extension is also installed. Open the `phpinfo.php` file in this folder and search the page for `allow_url_fopen` and `cURL support` to make sure they are enabled.

Join our [Mautic Whitelabeler Mattermost chat channel](https://chat.contacts.live/signup_user_complete/?id=mn5jirj38iyi5psskf6epb8m8r) if you need help troubleshooting or want to discuss an idea.

## Credits

Mautic Whitelabeler makes use of a couple of other libraries:

* [PHP-ICO](https://github.com/chrisbliss18/php-ico) for favicon generation
* [Spectrum](https://github.com/bgrins/spectrum) for the color selector
