Enabling Zimbra Proxy

From Zimbra :: Wiki

Jump to: navigation, search
Admin Article

Article Information

This article applies to the following ZCS versions.
  ZCS 8.0 Article  ZCS 8.0


Contents

ZCS Versions

This document is applicable to ZCS 8.0+.

Multi-node

Simple Command With Defaults

The zmproxyconfig command can be run with limited arguments if the command defaults are acceptable. Run /opt/zimbra/libexec/zmproxyconfig to view all the argument options and the usage

Preparing Proxy Hosts

Log into each proxy server hosts and run as user zimbra

  • Enable (-e) IMAP/POP3 mail (-m) and HTTP (-w) in both HTTP and HTTPS (-x) mode for host (-H) returned by the zmhostname command
/opt/zimbra/libexec/zmproxyconfig -m -w -e -x both -H `zmhostname`

or

  • Enable IMAP/POP3 proxy only without HTTP
/opt/zimbra/libexec/zmproxyconfig -m -e -H `zmhostname`

or

  • Enable HTTP proxy only without IMAP/POP3 in both mode
/opt/zimbra/libexec/zmproxyconfig -w -e -x both -H `zmhostname`

Note: the zmproxyconfig command can be run more than once with the (-e) flag to enable proxy services. It is common, for example, to enable HTTP proxy after having used proxy for IMAP/POP3 services.

Preparing Mailbox Server Hosts

Log into each mailbox server host and run as user zimbra

/opt/zimbra/libexec/zmproxyconfig -m -w -e -H `zmhostname`

** STOP ** here if the simple commands are used.


HTTP

When using zmproxyconfig to enable HTTP proxy, -w is used to indicate web proxy and -a is used to specify a colon separated list of web ports in format HTTP-STORE:HTTP-PROXY:HTTPS-STORE:HTTPS-PROXY. Note these port designations only specify listener ports for the server specified with -H, therefore, use a value of "0" (disabled) to avoid port conflict errors.

Preparing Proxy Hosts

Enable the proxy host to listen on ports 80 and 443. Login to each host running zimbra-proxy and run

/opt/zimbra/libexec/zmproxyconfig -w -e -a 0:80:0:443 -x both -H `zmhostname`

HTTP-PROXY and HTTPS-PROXY ports are set to indicate listener ports for the HTTP proxy host. HTTP-STORE and HTTPS-STORE designations are 0 (disabled) since they apply only to mailbox server configurations and this is a proxy only host.

Preparing Mailstore Hosts

Login to each host running zimbra-mailbox and run

/opt/zimbra/libexec/zmproxyconfig -w -e -a 8080:0:8443:0 -H `zmhostname`

HTTP-STORE and HTTPS-STORE ports of 8080 and 8443 are set to indicate listener ports for the mailbox server host. HTTP-PROXY and HTTPS-PROXY designations are 0 (disabled) since they apply only to proxy server configurations and this is a mailbox only host.

Alternatively, mailbox servers can listen on ports 80 and 443 without conflict to the proxy or other service. Just specify the desired listener ports with zmproxyinit's -a flag

/opt/zimbra/libexec/zmproxyconfig -w -e -a 80:0:443:0 -H `zmhostname`

Protocol Requirements Including HTTPS Redirect

HTTP proxy can support protocol modes for HTTP or HTTPS only, both HTTP and HTTPS, mixed HTTP and HTTPS or HTTPS redirect from HTTP. Redirect is a popular configuration. This configuration must be made to the proxy servers.

  • HTTPS redirect from HTTP
zmprov ms proxy.server.name zimbraReverseProxyMailMode redirect
  • HTTP and HTTPS (support both)
zmprov ms proxy.server.name zimbraReverseProxyMailMode both
  • HTTPS only
zmprov ms proxy.server.name zimbraReverseProxyMailMode https
  • HTTP only
zmprov ms proxy.server.name zimbraReverseProxyMailMode http
  • "mixed" will cause only authentication to be sent over HTTPS
zmprov ms proxy.server.name zimbraReverseProxyMailMode mixed

IMAP/POP3

Preparing Proxy Hosts

  • IMAP
/opt/zimbra/libexec/zmproxyconfig -m -e -i 0:143:0:993 -H `zmhostname`
  • POP3
/opt/zimbra/libexec/zmproxyconfig -m -e -p 0:110:0:995 -H `zmhostname`
  • POP3 and IMAP in a single command
 /opt/zimbra/libexec/zmproxyconfig -m -e -p 110:0:995:0 -i 143:0:993:0 -H `zmhostname`

Preparing Mailstore Hosts

  • IMAP
/opt/zimbra/libexec/zmproxyconfig -m -e -i 7143:143:7993:993 -H `zmhostname`
  • POP3
/opt/zimbra/libexec/zmproxyconfig -m -e -p 7110:110:7995:995 -H `zmhostname`
  • POP3 and IMAP in a single command
/opt/zimbra/libexec/zmproxyconfig -m -e -p 110:0:995:0 -i 143:0:993:0 -H `zmhostname`

Troubleshooting

Proxy Login Slow

A common nginx misconfiguration is to have incorrectly designated non-mailbox servers as routing/zmlookup handlers. Only mailbox servers can perform route handler functions. To view the zmlookup lookup handlers, review the zm_lookup_handlers parameter in /opt/zimbra/conf/nginx/includes/nginx.conf.zmlookup

grep zm_lookup_handlers /opt/zimbra/conf/nginx/includes/nginx.conf.zmlookup

If a non-mailbox server is listed, set the zimbraReverseProxyLookupTarget server configuration attribute to FALSE for that server.

zmprov ms `zmhostname` zimbraReverseProxyLookupTarget FALSE

Additionally, zimbraReverseProxyLookupTarget is a server inherited attribute from the global configuration, so check if zimbraReverseProxyLookupTarget has been incorrectly designated in global config.

zmprov gcf zimbraReverseProxyLookupTarget
Verified Against: Date Created: 6/05/2014
Article ID: http://wiki.zimbra.com/index.php?title=Enabling_Zimbra_Proxy Date Modified: 06/5/2014
Personal tools