Procedures (Zimbra) - Revision history

Sstrutt: /* Enable Spam BlockList */ Added example output in daily mail

2013-07-31T08:02:18Z

Enable Spam BlockList: Added example output in daily mail

@@ Line 234: / Line 234: @@
 # Check restriction has been added
 #* <code> zmprov gacf | grep zimbraMtaRestriction </code>
 === Enable DKIM ===

Sstrutt: /* Configuration Changes */ Added "Enable Spam BlockList"

2013-07-30T13:42:25Z

Configuration Changes: Added "Enable Spam BlockList"

@@ Line 221: / Line 221: @@
   grep 'purge' /opt/zimbra/log/mailbox.log
   zgrep 'purge' /opt/zimbra/log/mailbox.log.2012-08-05.gz
 === Enable DKIM ===

Sstrutt: /* Install Commercial Certificate */ Added CLI procedure

2013-02-06T21:13:51Z

Install Commercial Certificate: Added CLI procedure

@@ Line 87: / Line 87: @@
 #* <code> more /opt/zimbra/ssl/zimbra/commercial/commercial.csr </code>
 # Upload CSR to certificate authority
-# Install received keys via GUI and restart server
+# Install received certificates via GUI and restart server
 === Migrate Commercial Certificate To New Server ===

Sstrutt: Added "Enable DKIM" and Meta

2012-10-09T13:33:31Z

Added "Enable DKIM" and Meta

← Older revision		Revision as of 13:33, 9 October 2012
Line 152:		Line 152:
	Any probs, refer to the Zimbra doc at the start of this for things to investigate.		Any probs, refer to the Zimbra doc at the start of this for things to investigate.

	== Install Zimlet ==		== Configuration Changes ==
	Zimlets ''only'' work when accessing via the web client, they are not usable from the full-fat Zimbra client.		=== Install Zimlet ===
			Zimlets ''only'' work when accessing via the web client, they are not usable from the full-fat Zimbra desktop client.

	# Copy the Zimlet to the server		# Copy the Zimlet to the server
Line 161:		Line 162:
	#* EG <code> zmzimletctl deploy com_zimbra_tasksreminder.zip </code>		#* EG <code> zmzimletctl deploy com_zimbra_tasksreminder.zip </code>

	== Signature Length Increase ==		=== Signature Length Increase ===
	The maximum length of an email signature is limited to 10240 by default, to increase...		The maximum length of an email signature is limited to 10240 by default, to increase...

Line 176:		Line 177:
	## Delete, then re-add the account and allow to resync fully		## Delete, then re-add the account and allow to resync fully

	== Message Sizes ==		=== Maximum Message Sizes ===
	To see the current max IMAP request size...		To see the current max IMAP request size...
	* <code> zmlocalconfig \| grep -i imap_max_request_size </code>		* <code> zmlocalconfig \| grep -i imap_max_request_size </code>
Line 195:		Line 196:
	* <code> zmprov modifyConfig zimbraMailContentMaxSize 20480000 </code>		* <code> zmprov modifyConfig zimbraMailContentMaxSize 20480000 </code>

	== Mailbox ~~Purging~~ ==		=== Mailbox Purge Interval ===
	Mailbox purging carries on continuously in the background. The process pauses/sleeps between each mailbox by a user defined interval (default is 1 minute). What's purged is defined in the ''Class of Service (COS)'' for a particular mailbox - see the '''Email Retention Policy''' on the ''Advanced'' tab in the admin console (it can be overridden for individual mailboxes in the ''Advanced'' tab of the account config).		Mailbox purging carries on continuously in the background. The process pauses/sleeps between each mailbox by a user defined interval (default is 1 minute). What's purged is defined in the ''Class of Service (COS)'' for a particular mailbox - see the '''Email Retention Policy''' on the ''Advanced'' tab in the admin console (it can be overridden for individual mailboxes in the ''Advanced'' tab of the account config).

Line 209:		Line 210:
	zgrep 'purge' /opt/zimbra/log/mailbox.log.2012-08-05.gz		zgrep 'purge' /opt/zimbra/log/mailbox.log.2012-08-05.gz

			=== Enable DKIM ===
			[[Acronyms#DKIM\|DKIM]] allows for the signing of certain fields of an email (for example the From: field, allowing the recipient to trust that the email is from whoever it purports to be and not from a spammer). This is achieved by adding a DKIM signature to an email, which can be cross referenced with a public key provided in DNS for the sending domain.

			'''DKIM is not available in versions prior to Zimbra v8 !'''

			For more info on DKIM see...
			* http://www.dkim.org/
			* http://www.wikipedia.org/wiki/DomainKeys_Identified_Mail

			For fuller, Zimbra specfifc instructions see...
			* http://wiki.zimbra.com/wiki/Configuring_for_DKIM_Signing

			To set-up
			# Create the DKIM keys on your Zimbra server for your domain
			## Log into your Zimbra server as the Zimbra user
			## Run DKIM key utility
			##* EG <code> /opt/zimbra/libexec/zmdkimkeyutil -a -d domain.com </code> (replace <code> domain.com </code> with your domain)
			# Add the public key generated into your DNS as a TXT (text) record (the field names will be vary dependant on your provider's DNS managment interface)
			#* EG: Label/Name/Entry: <code>5E56FFDC-11F6-11E2-9862-DA8801AF17E6._domainkey</code>
			#* EG: Data/Target: <code>v=DKIM1;=rsa; p=MIGfMA0GCSqGSIb3...<etc - your key will be longer!></code>
			# Confirm the DNS entry is correct
			#* EG <code> dig -t txt 5E56FFDC-11F6-11E2-9862-DA8801AF17E6._domainkey.domain.com </code>

	[[Category:Zimbra]]		[[Category:Zimbra]]

Sstrutt: /* Upgrade */ Added link to Zimbra v7 to v8 upgrade notes

2012-10-04T11:24:21Z

Upgrade: Added link to Zimbra v7 to v8 upgrade notes

← Older revision		Revision as of 11:24, 4 October 2012
Line 35:		Line 35:
	== Software Updates ==		== Software Updates ==
	=== Upgrade ===		=== Upgrade ===
			* See also: [[Upgrade Zimbra FOSS v7 to v8]]

	Get the appropriate version from http://www.zimbra.com/downloads/os-downloads.html		Get the appropriate version from http://www.zimbra.com/downloads/os-downloads.html

Sstrutt: Added "Mailbox Purging"

2012-09-06T08:05:42Z

Added "Mailbox Purging"

@@ Line 192: / Line 192: @@
 and so update to say 20 MB, use...
 * <code> zmprov modifyConfig zimbraMailContentMaxSize 20480000 </code>
 [[Category:Zimbra]]

Sstrutt: /* Upgrade */ Added download link

2012-04-27T10:40:55Z

Upgrade: Added download link

← Older revision		Revision as of 10:40, 27 April 2012
Line 35:		Line 35:
	== Software Updates ==		== Software Updates ==
	=== Upgrade ===		=== Upgrade ===
			Get the appropriate version from http://www.zimbra.com/downloads/os-downloads.html

	Use the same package to upgrade the software as used for a brand new install (there is no separate upgrade package). The important part of any upgrade ''IS NOT'' how to get your system upgraded, it ''IS'' how you're going to recover if it all goes horribly wrong.		Use the same package to upgrade the software as used for a brand new install (there is no separate upgrade package). The important part of any upgrade ''IS NOT'' how to get your system upgraded, it ''IS'' how you're going to recover if it all goes horribly wrong.

Sstrutt: /* Backup */ Bit of a tidy up

2012-04-04T09:50:20Z

Backup: Bit of a tidy up

← Older revision		Revision as of 09:50, 4 April 2012
Line 1:		Line 1:
	== Backup ==		== Backup ==
	=== Basic Manual Mackup ===		=== Basic Manual Mackup ===
			Useful just before you perform an upgrade or some other potentially disastrous change (be aware that if your server is still accessible to users or can receive incoming email from the internet, any interim changes will be lost if you roll back)
	# SU to Zimbra admin		# SU to Zimbra admin
	#* <code> su - zimbra </code>		#* <code> su - zimbra </code>
Line 6:		Line 7:
	#* <code> zmcontrol stop </code>		#* <code> zmcontrol stop </code>
	# Exit Zimbra user and create copy of directory		# Exit Zimbra user and create copy of directory
	#* EG <code> cp -rp /opt/zimbra /home/simons/~~zimbra_backup_100301~~ </code>		#* EG <code> cp -rp /opt/zimbra /home/simons/zimbra_backup_20100301 </code>
	# Once completed, go back to zimbra user and start		# Once completed, go back to zimbra user and start
	#* <code> su - zimbra </code>		#* <code> su - zimbra </code>
Line 13:		Line 14:
	=== Full Scripted Backup ===		=== Full Scripted Backup ===
	* For more info see - http://www.zimbra.com/forums/administrators/15275-solved-yet-another-backup-script-community-version.html		* For more info see - http://www.zimbra.com/forums/administrators/15275-solved-yet-another-backup-script-community-version.html
	* Script is downloadable from - http://www.osoffice.de/downloads/viewcategory-7.html		** Script is downloadable from - http://www.osoffice.de/downloads/viewcategory-7.html
			** Or see my modified version at [[Zimbra FOSS Full Backup]]

			This method performs a full (offline) backup of your whole Zimbra installation, an user data only online backup can also be achieved, see [[Zimbra FOSS User Backup]]

	# Check the size of the <code> /opt/zimbra </code> dir, this will be replicated to a sync directory, from which the actual backup is taken, and check available free space		# Check the size of the <code> /opt/zimbra </code> dir, this will be replicated to a sync directory, from which the actual backup is taken, and check available free space

Sstrutt: Initial creation - content from Zimbra page

2012-02-14T13:54:12Z

Initial creation - content from Zimbra page

New page

== Backup ==
=== Basic Manual Mackup ===
# SU to Zimbra admin
#* <code> su - zimbra </code>
# Stop Zimbra services
#* <code> zmcontrol stop </code>
# Exit Zimbra user and create copy of directory
#* EG <code> cp -rp /opt/zimbra /home/simons/zimbra_backup_100301 </code>
# Once completed, go back to zimbra user and start
#* <code> su - zimbra </code>
#* <code> zmcontrol start </code>

=== Full Scripted Backup ===
* For more info see - http://www.zimbra.com/forums/administrators/15275-solved-yet-another-backup-script-community-version.html
* Script is downloadable from - http://www.osoffice.de/downloads/viewcategory-7.html

# Check the size of the <code> /opt/zimbra </code> dir, this will be replicated to a sync directory, from which the actual backup is taken, and check available free space
#* <code> du -hs /opt/zimbra </code>
#* <code> df -h </code>
# Un-gzip and upload the config file to somewhere convenient
# Edit required config params at start of script
# Run the script to install (as root), allow creation of required folders and install of required utils
#* <code> ./zmbak_v.0.8.sh --INSTALL </code>
# Perform a first full run to check everything works alight and to create the first full backup
#* <code> ./zmbak_v.0.8.sh -f </code>

To restore, see http://www.zimbra.com/forums/administrators/15275-solved-yet-another-backup-script-community-version-24.html

I've modified the above script, to suit my own purposes. I've added an FTP option so that completed backup's are copied off to a remote FTP server (the copy isn't encrypted so should only be used within a private/secure network - [[Zimbra FOSS Full Backup]]

== Software Updates ==
=== Upgrade ===
Use the same package to upgrade the software as used for a brand new install (there is no separate upgrade package). The important part of any upgrade ''IS NOT'' how to get your system upgraded, it ''IS'' how you're going to recover if it all goes horribly wrong.

# Isolate the server from the internet (so new mails can't received following the pre-upgrade backup)
# Stop the mail server running
#* <code> su - zimbra </code>
#* <code> zmcontrol stop </code>
# Backup the server 1st
#* If hosted on an ESX, probably most easily achieved by starting a snapshot (remember to delete the snapshot after a few days if no probs are encountered)
#* Also copy off any existing local backup (so that a new full backup can be started following the upgrade)
# Copy the install to the server
#* EG <code> pscp zcs-6.0.6_GA_2324.UBUNTU8.20100406144520.tgz simons@mail:zcs-6.0.6_GA_2324.UBUNTU8.20100406144520.tgz </code>
# Uncompress the package
#* <code> tar -xzf zcs-6.0.6_GA_2324.UBUNTU8.20100406144520.tgz </code>
# Start the upgrade using the install script
#* <code> ./install.sh </code>
# The script should detect an existing installation and upgrade it, do not install additional components, but do confirm the upgrade.
# Once completed, test thoroughly
# Perform a full local backup
# Reconnect to network

=== Patch ===
Sometimes patch packages are supplied for minor upgrades between specific versions. Take the same backup precautions as for a normal upgrade. The actual application of the patch varies slightly from an upgrade...

# Copy the patch package to the server
#* EG <code> pscp zcs-patch-6.0.6_GA_2332.tgz simons@mail:zcs-patch-6.0.6_GA_2332.tgz </code>
# Uncompress the package
#* <code> tar -xzf zcs-patch-6.0.6_GA_2332.tgz </code>
# Start the patch upgrade using the install script
#* <code> ./installPatch.sh </code>
# Restart the software to apply changes
#* <code> su - zimbra </code>
#* <code> zmcontrol stop </code>
#* <code> zmcontrol start </code>

== Certificates ==
=== Install Commercial Certificate ===
# Create a Certificate Signing Request (CSR) - can be done via the GUI admin console, but doesn't always work properly
## Logged into the server as root...
## Generate CSR, EG <code> /opt/zimbra/bin/zmcertmgr createcsr comm -new -keysize 2048 -subject "/C=GB/L=London/O=SandfordIT Limited/CN=mail.sandfordit.com" </code>
##* /C - Country
##* /ST - Region / county (optional)
##* /L - City
##* /O - Organisation / company name
##* /OU - Department (optional)
##* /CN - Server FQDN
# Display and copy CSR key
#* <code> more /opt/zimbra/ssl/zimbra/commercial/commercial.csr </code>
# Upload CSR to certificate authority
# Install received keys via GUI and restart server

=== Migrate Commercial Certificate To New Server ===
This is essentially an updated version of the old procedure that can be found here - http://wiki.zimbra.com/wiki/Transfer_SSL_certificates_between_servers for ZCS v7.

# On your old server make a copy of the SSL folder
#* EG <code>cp -r /opt/zimbra/ssl /home/user/sslbk </code>
# Delete any back folders from within your copy so that only a zimbra folder exists
#* EG <code> rm -rf /home/user/sslbk/zimbra.* </code>
# Compress the folder into a file
#* EG <code>tar cvzf sslbk.tgz /sslbk/ </code>
# Copy the file to your new server
#* EG <code> pscp user@oldmail.domain.com:/home/user/sslbk.tgz c:\temp\sslbk.tgz </code>
#* EG <code> pscp c:\temp\sslbk.tgz user@newmail.domain.com:/home/user/ </code>
# Backup the SSL folder
#* <code> mv /opt/zimbra/ssl/ /opt/zimbra/ssl_old </code>
# Uncompress file copied from old server
#* <code> tar -xvf /home/user/sslbk.tgz </code>
# Copy the folder into place and rename
#* <code> cp -r sslbk/ /opt/zimbra/ssl </code>
#* <code> mv /opt/zimbra/sslbk/ /opt/zimbra/ssl </code>
# Deploy the certificate
#* EG <code> /opt/zimbra/bin/zmcertmgr deploycrt comm /home/user/sslbk/zimbra/commercial/commercial.crt /home/user/sslbk/zimbra/commercial/commercial_ca.crt</code>
# Restart Zimbra
#* <code> su - zimbra </code>
#* <code> zmcontrol restart </code>
# If services don't start properly, force java to accept your certificate
#* EG <code> /opt/zimbra/java/bin/keytool -import -alias new -keystore /opt/zimbra/java/jre/lib/security/cacerts -storepass changeit -file /sslbk/zimbra/commercial/commercial.crt </code>

== Change Server Hostname ==
This is based on the article found here - http://wiki.zimbra.com/wiki/ZmSetServerName. I've used this procedure for Zimbra v7 FOSS installations on Ubuntu 8 32-bit and 10 64-bit (LTS).

This procedure requires downtime, and because zimbra services need to be up to complete the change, if you can stop new mail being received by the server (by disabling through a firewall for example) do so. If you have to fall back to your backup, any mail received during the backup will be lost.

# Ensure that new DNS records are already set-up and working.
#* EG <code> dig domain.com mx </code>
# Create a backup of your entire installation (if running as a VMware VM, take a snapshot as well)
## Stop Zimbra (as zimbra user)
##* <code> zmcontrol stop </code>
## Create copy (as root)
##* <code> mkdir /backup/opt </code>
##* <code> mkdir /backup/opt/zimbra </code>
##* <code> cp -r /opt/zimbra/ /backup/opt/zimbra/ </code>
## Start Zimbra (as zimbra user)
##* <code> zmcontrol start </code>
# Perform rename to Zimbra installation
#* EG <code> /opt/zimbra/libexec/zmsetservername -n mailsvr.domain.com </code>
# Perform rename to operating system
## Update the following files
##* <code> /etc/hosts </code>
##* <code> /etc/hostname </code>
## Set the hostname (not FQDN)
##* <code> hostname <servername> </code>
# Reboot the server
#* <code> shutdown -r now </code>

Once your server is back up, run through the following to check everything is in working order...
# <code> zmcontrol status </code>
# <code> zmprov gacf | grep oldhostname </code>
# <code> zmprov gs `zmhostname` | grep oldhostname </code>
# <code> zmlocalconfig | grep oldhostname </code>
# Plus I'd tail the <code> /var/log/zombra.log </code> while sending and receiving a few test emails to make sure everything is running sweetly.

Any probs, refer to the Zimbra doc at the start of this for things to investigate.

== Install Zimlet ==
Zimlets ''only'' work when accessing via the web client, they are not usable from the full-fat Zimbra client.

# Copy the Zimlet to the server
#* EG <code> pscp com_zimbra_tasksreminder.zip simons@mail:com_zimbra_tasksreminder.zip </code>
# Move the file to the <code> /opt/zimbra/zimlets </code> directory
# Deploy the Zimlet
#* EG <code> zmzimletctl deploy com_zimbra_tasksreminder.zip </code>

== Signature Length Increase ==
The maximum length of an email signature is limited to 10240 by default, to increase...

# '''Update appropriate CoS/user pref...'''
## In server admin console
## Either update the
### ''User''
###* Addresses > Accounts > <user>
### Or ''CoS''
###* Configuration > Class of Service > <CoS>
## Go to Preferences > Mail Options > Composing mail
## Change ''Maximum length of mail signature'' value (eg 20480)
# '''Update Zimbra Desktop'''
## Delete, then re-add the account and allow to resync fully

== Message Sizes ==
To see the current max IMAP request size...
* <code> zmlocalconfig | grep -i imap_max_request_size </code>
To increase the size, to say 20MB...
* <code> zmlocalconfig -e imap_max_request_size=20480 </code>

Its also worth being aware of the following settings, which are altered through the admin console...
* In Global Settings | General Information...
** Maximum size of an uploaded file for Briefcase, Email messages, Calendar appointments and Tasks (KB)
*** <code> zimbraFileUploadMaxSize </code>
* In Global Settings | MTA...
** Maximum message size (KB)
*** <code> zimbraMtaMaxMessageSize </code>

And there's also an additional setting, <code> zimbraMailContentMaxSize</code>, which also appears to affect the maximum size of attachments. To see what you're set to currently use...
* <code> zmprov getConfig zimbraMailContentMaxSize </code>
and so update to say 20 MB, use...
* <code> zmprov modifyConfig zimbraMailContentMaxSize 20480000 </code>

[[Category:Zimbra]]