A frequently asked question in our Forums is if Open Source users can re-brand the Login and App Logo. You can find more information about licensing in the next Official FAQ PDF, question 33 through 37 which contains related questions and answers about re-branding the logo, but here are some basics:
- How can I add my Logo to the Login and App window?
- This blog entry will show you how, without complex changes in CSS or other Zimbra files.
- It is legal to re-brand the logo if I have Open Source?
- Yes, the CPAL provides that the attribution should be prominently displayed and the size of the logo should be consistent with the size of other elements of the attribution. Therefore, the size of Zimbra’s logo should be consistent with the size of any other logos displayed in the graphical user interface.
- If you are using Open Source Edition, per license agreement you must have the Zimbra Logo equal to, or greater, than you own Logo. Failing to have the image or an image smaller than yours will violate the license agreement.
- How many times do I need to change it?
- Only once, and if you have your logo and the Zimbra logo in one file, and they are the same size, it should take no more than 30 seconds.
- How can I white-label the entire Zimbra Login and App window?
- You must purchase the Network Edition version if you need to do white-labeling in the Zimbra Product.
How to White-Label Zimbra Collaboration?
Re-branding the Logo and White-labeling in Zimbra Collaboration are different things. Re-branding can be done in the Open Source Edition following the steps and the CPAL instructions described in this Post. This step is important to meet the license agreement.
White-Label is a Network Edition Feature and can be done only for our Customers. Please see the image below to understand each status.
Login Banner and Application Banner Sizing
In Zimbra, you will find two different images to re-brand: one is the image that appears in the Login window and the other is the image in the top-left corner when you are logged in. Each image has a different size, and you should constrain your Logo+Zimbra logo (in FOSS case) according to these max sizes:
Application Banner, 200px X 35px in Zimbra Collaboration 8.x
Application Banner, 170px X 42px in Zimbra Collaboration 8.0.x
Login Banner, 440px X 60px in Zimbra Collaboration 8.x
Login Banner, 450px X 36px in Zimbra Collaboration 8.0.x
How to do White-Label the Web Client using Zimbra Collaboration Network Edition
One of the benefits of using the Network Edition of Zimbra Collaboration is that you can White Label easily. If you have Network Edition, you can remove the Zimbra Logos, change the colors of the Login and App windows, or even create your own Login page.
If you are using Zimbra Collaboration Network Edition, login in the Admin Console, go to the Domain where you want to White-Label following the next path Home > Configure > Domains, then edit the Domain.
In the Preferences of the Domain, click Themes. You will be able to select the Colors of the Theme, or you can use an HEX code. You will also be able to add your own Logos and the URL where the logos will point.
Remember that these steps, as well as the ability to White-Label your Zimbra Web Client, are available only in Network Edition.
Zimbra Official Logo to use with your own Logo in Open Source Edition
You can find the official Logos to use here:
Needed commands to set the Logos in Zimbra
Since Zimbra Collaboration 5.0.7, you can set your logos per domain, and you can set the URL where you want to link the logos. Here are the three simple commands to run per domain. As the zimbra user:
Images hosted in external server (recommended)
The recommended way to present the logos is to host the images in a external server and present this public and valid URL to the Zimbra commands. In this case, even if you upgrade the Zimbra release, the logos will remain in the external server:
zmprov md example.com zimbraSkinLogoURL https://mail.example.com zmprov md example.com zimbraSkinLogoLoginBanner https://www.example.com/MyLoginBanner.png zmprov md example.com zimbraSkinLogoAppBanner https://www.example.com/MyAppBanner.png zmmailboxdctl restart
Images hosted in the same Zimbra server (not recommended)
This is not recommended to host the logo files in this path inside the Zimbra server /opt/zimbra/jetty/webapps/zimbra/logos/. Be sure that you give these files the proper zimbra rights, and run the next commands as zimbra user:
Upload your logos to that new folder
zmprov md example.com zimbraSkinLogoURL https://mail.example.com zmprov md example.com zimbraSkinLogoLoginBanner /logos/MyLoginBanner.png zmprov md example.com zimbraSkinLogoAppBanner /logos/MyAppBanner.png zmmailboxdctl restart
If you add your image as root user, you might be want to change the files privileges to Zimbra:
chown zimbra:zimbra /opt/zimbra/jetty/webapps/zimbra/logos/MyLoginBanner.png chown zimbra:zimbra /opt/zimbra/jetty/webapps/zimbra/logos/MyAppBanner.png
This method is easier because you don’t use an external server. However, any Zimbra upgrade will replace your Custom Logos and folders with the default versions.
Final result and examples
The final result will be something like the following. For best results, use .png images. If you are using the default template, we recommend using white logos or white stroke over your logo.
For Open Source Users that comply with the CPAL and follow the License Agreement
Let us know if you have any questions or issues using these steps.
its not working with zimbra open source V 8.0.9 . pls advise.
Did you try the commands in the domain example.com and then you went to mail.example.com, or your FQDN to that domain, and doesn’t work? Are you trying the external logos or the internal path?
I’m using internal path . i tried the command as your mission but after run the command the original logo of zimbra disappeared also . i changed example.com by my domain and changed mail.example.com by my mail server URL. pls advise
Hi Mohammed, try to apply the proper rights to the Logos, do chown zimbra:zimbra to that files, that can be the issue.
it working fine after change the rights to the Logo but there is another issue , my company logo is not show complete when i try to access thru any browser from computers but its working fine with Mobile version when i tries to access it from my mobile its show complete company logo , this issue in zimbra open source v 8.0.9 .
i tested the logo also in zimbra open source in v 8.6.0 and it show the logo complete without any problem .
pls advise if there is any bug with v 8.0.9
Feel free to open a new Thread in our community Forums where I can help you much more if you put there your examples, etc – https://community.zimbra.com/collaboration/f/1886
You must be sure to comply the CPAL license keeping the Zimbra Logo as well as use the Image size described in this Blog Post, we can discuss it in a Forum Thread.
I’m glad that now it’s showing the logo after the privileges.
thanks for your support.
Hi Mohammed, I think that finally we fixed your issue together aren’t we?
Hi Jorge de la cruz,
Thank you very much. a very clear tutorial with proper step-by-step guide explained with screenshot ;-)
Thank you Vavai, I am a truly big fan of your content as well.
There is one issue in “Images hosted in external server” method (at least for FOSS edition).
If we host logo image in external server and use comercial SSL cert, browsers warning us that our https connection has some security issues.
For example Chrome https status icon changes from Green lock icon to Lock icon with yellow warning triangle, obviously because we use logo image from external website. That really can confuse some users.
Because of this better to use not recomended method and store logo image locally if you use comercial ssl cert.
Also could you please advice how to set the default zimbra logo back? Thank you.
Hosting the Logo in external place it’s the recommended way because even with upgrades, you will not lose any logo, if you have one domain that maybe sounds not too hard, but if you have 100 domains, with different domains and logos, you will want not to lose all that work with each upgrade. But, because Zimbra is really flexible and each environment is different, both solutions are ok :)
Chrome will change the color of your Certificate if you embed an image from a HTTP source, like with any other web application, because you are mixing http content and https. I’ve just tried in my side, I have 2 differents SSL, one for zimbra86.zimbra.io and another SSL certificate, completely different for http://www.zimbra.io, and I have green SSL in Chrome, you can try with my images if you want:
zmprov md zimbra.io zimbraSkinLogoLoginBanner https://zimbra.io/MyLoginBanner.png
zmprov md zimbra.io zimbraSkinLogoAppBanner https://zimbra.io/MyAppBanner.png
So I will add a note into the Blog post about that you must have SSL in the Host for the images to avoid SSL issues in the Zimbra Login App.
Thank you for your comment, really good feedback.
Hi Jorge, thank you for your reply. It works with https image source perfectly.
The step works I’m following. But if i used the IP for accessing the webmail, the logos not displaying. How to make work if we use Hostname or IP to accessing the web for showing the logos on both.
Hi Denny, that is not currently possible, as Zimbra uses the virtual-host to determine which logo must use, so in case of the IP, Zimbra shows the default logo. You always search for the .png image inside the server and replace it there, but is not other easy way to do it.
you are the Best by showing that logo only shown when using domain not ip , thanks
I try to add my company logos in my zimbra web mail using internal path
but I can’t find folder logos in /opt/zimbra/jetty/webapps/zimbra/, but I found logos folder in /opt/zimbra/jetty/webapps/zimbra/skin/bases/_skin/logos, this same folder,so I put myLogonbanner.png into this folder. after execute command for add my logos, my company logos not showed and zimbra logos in login banner is missing
how to repair this problem?
Review the Blog article, I’ve updated it clarifying some steps.
thx for your tips, It works,
but how to load zimbra logos, because after add company logo, the zimbra logos in login banner is missing
hi Jorge, sorry, I can solved that
I did this, but I don’t really like the logo. I actually prefer the stock Zimbra image. Is there a way to revert this back to the standard image?
Hi, it would be nice to also have a way to revert back. In case something goes a bit wrong.
Hi, but the original logos, with different colors, like black, white, and color are in this Blog article, you can use them, also, before touch the logos, is always a good practice do a copy first.
You can find the logos as well here: /opt/zimbra/jetty/webapps/zimbra/skin/bases/_skin/logos
Thanks for the quick reply.
Yes, I did found those, and using these commands to try to restore them, as I haven’t created the correct ones, such combining the Zimbra logo with ours. Thats why I want to revert it back. But this is not an urgent issue, but due to some threads I found, it would be nice to have a way to revert it.
zmprov md example.com zimbraSkinLogoURL https://mail.example.com
zmprov md example.com zimbraSkinLogoLoginBanner /opt/zimbra/jetty/webapps/zimbra/skins/_base/logos/LoginBanner.png
zmprov md gastao.eu zimbraSkinLogoAppBanner /opt/zimbra/jetty/webapps/zimbra/skins/_base/logos/ZimbraInside/AppBanner.png
But, those now can’t appear … going to try the others available.
Just let me know if the above is correct.
This for client. How about for administration? I think need to replace zimbra admin application banner. I’m using network edition 8.0.9. Any idea how?
In the open source edition , can i replace the url that point on my company and zimbra logo image ?
How can i revert back to the initial logo ?
Thank you so much for such a descriptive explanation.
What I understood as a opensource user we cannot change or lighter the blue colour on login page but can we add something on the grey area to make the website lively?
As a part of confirmation wanted to know that adding a forgot passoword on login page and adding our companies copyright on login page does not violates any rule.
Is not working in Zimbra 8.6.0. Are there a new procedure for thiese version?
Hello, I’m new to zimbra, I use the version 8.6.0 and I wonder if you can change the background to the home screen and as I do, I place a background made by me, which files do I change which folder should I place the background created, thanks
Not working on latest version. Zimbra default logo disapper after modification as well as my company logo.
Im using Zimbra 8.6.0_GA_1153.RHEL7_64_20141215151110 RHEL7_64 FOSS edition.
Are you using internal image path or external one? Does that folder, and that file have zimbra privileges?
Hi everyone! I followed this Howto and all works fine when I access my webmail through internet, but when I access through VPN (internal IP 10.0.30.13) the logo is not showing up.
What is wrong?
Is the mailbox service restart really needed? I’ve done the configuration and just running “zmprov fc skin” updated the logos.
My best regards,
Fabio S. Schmidt
Hi Fabio. All services was restarted. I ran “zmprov fc skin” but nothing changed.