Difference between revisions of "NGINX Configuration Structure"

(Configuration Files)
Line 99: Line 99:
 
: '''Description:''' This file defines the server block for NGINX HTTP SSL Proxy
 
: '''Description:''' This file defines the server block for NGINX HTTP SSL Proxy
 
: '''Template:''' /opt/zimbra/conf/nginx/templates/nginx.conf.web.https.default.template
 
: '''Template:''' /opt/zimbra/conf/nginx/templates/nginx.conf.web.https.default.template
 +
  
 
* /opt/zimbra/conf/nginx/includes/nginx.conf.web.sso.default
 
* /opt/zimbra/conf/nginx/includes/nginx.conf.web.sso.default

Revision as of 20:26, 5 June 2014

Admin Article

Article Information

This article applies to the following ZCS versions.

ZCS 8.0 Article ZCS 8.0

Zimbra NGINX Proxy has a hierarchical configuration structure. Top level configuration files include other functionality-specific configuration files. The main configuration file is /opt/zimbra/conf/nginx.conf, and this includes other configuration files as per the hierarchy below. Each configuration file usually defines and/or references one or more directives. For a complete list of NGINX Proxy Configuration Directives, please refer to NGINX Configuration Directive Reference

Each NGINX configuration file is generated from a corresponding template file. A template file looks exactly the same as its corresponding configuration file, with the difference that the template file contains keywords which are expanded by the Proxy Config Generator, and the configuration file is produced as a result

Configuration File Hierarchy

/opt/zimbra/conf/nginx.conf

→ /opt/zimbra/conf/nginx/includes/nginx.conf.main
→ /opt/zimbra/conf/nginx/includes/nginx.conf.memcache
→ /opt/zimbra/conf/nginx/includes/nginx.conf.mail
→ /opt/zimbra/conf/nginx/includes/nginx.conf.mail.imap.default
→ /opt/zimbra/conf/nginx/includes/nginx.conf.mail.imaps.default
→ /opt/zimbra/conf/nginx/includes/nginx.conf.mail.pop3.default
→ /opt/zimbra/conf/nginx/includes/nginx.conf.mail.pop3s.default
→ /opt/zimbra/conf/nginx/includes/nginx.conf.web
→ /opt/zimbra/conf/nginx/includes/nginx.conf.web.http.default
→ /opt/zimbra/conf/nginx/includes/nginx.conf.web.https.default
→ /opt/zimbra/conf/nginx/includes/nginx.conf.web.sso.default
→ /opt/zimbra/conf/nginx/includes/nginx.conf.web.admin.default


Configuration Files

  • /opt/zimbra/conf/nginx.conf
Description: This is the main top-level NGINX configuration file. It defines the working directory for NGINX worker processes (/opt/zimbra), and includes the main, memcache, mail, and web configuration files. When NGINX Proxy starts, it reads this configuration file first
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.template


  • /opt/zimbra/conf/nginx/includes/nginx.conf.main
Description: This file contains the directives that control the basic NGINX functionality
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.main.template


  • /opt/zimbra/conf/nginx/includes/nginx.conf.memcache
Description: This file contains the memcache configuration for NGINX. It defines all the memcache servers that are used by NGINX Proxy, and the various cache timeout related settings for cache fetch/store
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.memcache.template


  • /opt/zimbra/conf/nginx/includes/nginx.conf.mail
Description: This file contains the common configuration for NGINX Mail Proxy. The directives referenced here are usually common across both, POP and IMAP. Significantly, this file defines the route lookup handlers used by NGINX to discover the mail routes
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.mail.template


  • /opt/zimbra/conf/nginx/includes/nginx.conf.mail.imap.default
Description: This file defines the server block for NGINX IMAP Proxy
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.mail.imap.default.template


  • /opt/zimbra/conf/nginx/includes/nginx.conf.mail.imaps.default
Description: This file defines the server block for NGINX IMAP SSL Proxy
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.mail.imaps.default.template


  • /opt/zimbra/conf/nginx/includes/nginx.conf.mail.pop3.default
Description: This file defines the server block for NGINX POP3 Proxy
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.template.pop3.default.template


  • /opt/zimbra/conf/nginx/includes/nginx.conf.mail.pop3s.default
Description: This file defines the server block for NGINX POP3 SSL Proxy
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.mail.pop3s.default.template


  • /opt/zimbra/conf/nginx/includes/nginx.conf.web
Description: This file contains the common configuration for NGINX Web Proxy. The directives here apply for both, HTTP, as well as HTTPS. This file also defines the route lookup handlers used by NGINX to discover the web routes
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.web.template


  • /opt/zimbra/conf/nginx/includes/nginx.conf.web.http.default
Description: This file defines the server block for NGINX HTTP Proxy
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.web.http.default.template


  • /opt/zimbra/conf/nginx/includes/nginx.conf.web.https.default
Description: This file defines the server block for NGINX HTTP SSL Proxy
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.web.https.default.template


  • /opt/zimbra/conf/nginx/includes/nginx.conf.web.sso.default
Description: This file defines the server block for NGINX HTTP SSO Proxy
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.web.sso.default.template


  • /opt/zimbra/conf/nginx/includes/nginx.conf.web.admin.default
Description: This file defines the server block for NGINX Admin Proxy
Template: /opt/zimbra/conf/nginx/templates/nginx.conf.web.admin.default.template


Verified Against: ZCS 8.0.x Date Created: 6/5/2014
Article ID: https://wiki.zimbra.com/index.php?title=NGINX_Configuration_Structure Date Modified: 2014-06-05



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search