Nginx unknown directive etag [#2738987]

This happened with 3.4 as well, but now also in 3.5 after upgrading (using the Ubuntu repository)

We get this error in the log when trying to reload or restart nginx:

[warning]
nginx on manu.herkserver.com could not be restarted.
Changes might not be available until this has been done. (error: Reloading nginx configuration: nginx: [emerg]
unknown directive "etag" in
/var/aegir/config/includes/nginx_vhost_common.conf:78
nginx: configuration file /etc/nginx/nginx.conf test failed)

etag is used in the following two blocks in /var/aegir/config/includes/nginx_vhost_common.conf

location ^~ /cdn/farfuture/
location ~* files/advagg_(?:css|js)/

Commenting out the etag lines allows nginx to start.

We're using nginx version 1.2.1 on Debian 7.10 (Wheezy)

It looks like the etag directive was added in nginx 1.3.3
http://nginx.org/en/docs/http/ngx_http_core_module.html#etag

I'm unsure if we can upgrade to 1.3.3. on our current platform, but there seems no reason to have the etag directive there if it breaks an otherwise functional nginx configuration.

Comment	File	Size	Author
#17	provision-nginx-has-etag-2738987-17-D7.patch	7.85 KB	millenniumtree
#11	provision-nginx-has-etag-2738987-7-D7.patch	7.85 KB	millenniumtree
#5	0001-Issue-2738987-by-millenniumtree-memtkmcc-Nginx-unkno.patch	1.54 KB	memtkmcc

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

1 June 2016 at 19:39

millenniumtree created an issue. See original summary.

Comment #2

millenniumtree

he/him

Holualoa, HI

CreditAttribution: millenniumtree commented 1 June 2016 at 19:39

Issue summary:

View changes

Comment #3

millenniumtree

he/him

Holualoa, HI

CreditAttribution: millenniumtree commented 11 July 2016 at 15:41

Project:	Aegir Hosting CiviCRM	» Provision
Version:	7.x-3.5	» 7.x-3.6

Had this in the wrong Project.

Comment #4

memtkmcc CreditAttribution: memtkmcc commented 11 July 2016 at 19:16

Assigned:

Unassigned

» memtkmcc

It seems that the problem here is that one occurrence of the etag directive (in the /cdn/farfuture/ location) is not enclosed within the if/else check.

It should look like this:

<?php if ($nginx_is_modern): ?>
    etag       off;
<?php else: ?>
    add_header ETag "";
<?php endif; ?>

Comment #5

memtkmcc CreditAttribution: memtkmcc at Omega8.cc commented 11 July 2016 at 19:24

Version:	7.x-3.6	» 7.x-3.x-dev
Status:	Active	» Needs review

File	Size
0001-Issue-2738987-by-millenniumtree-memtkmcc-Nginx-unkno.patch	1.54 KB

Attached patch should fix this.

Comment #6

memtkmcc CreditAttribution: memtkmcc at Omega8.cc commented 11 July 2016 at 19:33

Component:

Code

» HTTP Service

Comment #7

millenniumtree

he/him

Holualoa, HI

CreditAttribution: millenniumtree commented 11 July 2016 at 19:37

Wrapping it with the if would theoretically fix it, except nginx_is_modern is TRUE for versions 1.1.8+, and etag is only supported in 1.3.3+

Every time I've run an aegir upgrade, I have had to comment out TWO instances of the etag (including the 2nd one that is already if'ed)

I think another property (nginx_has_etag) should be added to provision/http/Provision/Service/http/nginx.php for nginx 1.3.3+ and used in the vhost templates instead of nginx_is_modern.

Comment #8

millenniumtree

he/him

Holualoa, HI

CreditAttribution: millenniumtree commented 11 July 2016 at 19:46

Here's a new regex that should match anything 1.3.3 or above.
nginx\/1\.([12][0-9]|[3]\.([12][0-9]|[3-9]))

Comment #9

memtkmcc CreditAttribution: memtkmcc at Omega8.cc commented 11 July 2016 at 20:33

Hmm.. This gets a bit complicated, because we can't modify the regex for $nginx_is_modern since it is mainly related to limit_zone deprecated in Nginx 1.1.8, and replaced by limit_conn_zone.

I don't like the idea of introducing more versions checks and more properties to accommodate old Debian releases. After all, Jessie comes with Nginx 1.6.2 and is a current Debian stable for over a year (since April 26th, 2015).

Also, you can always get rid of all those config issues by disabling the "extended" config, if it breaks things for you. Just `touch /etc/nginx/basic_nginx.conf` and re-verify the server.

Comment #10

memtkmcc CreditAttribution: memtkmcc at Omega8.cc commented 11 July 2016 at 20:40

Status:

Needs review

» Needs work

At any rate, my patch doesn't fix the problem here.

Comment #11

millenniumtree

he/him

Holualoa, HI

CreditAttribution: millenniumtree commented 15 July 2016 at 14:34

File	Size
provision-nginx-has-etag-2738987-7-D7.patch	7.85 KB

So nginx 1.6.2 is supported...
$nginx_is_modern is there specifically to support nginx before 1.1.8...
But versions between 1.1.8 and 1.3.3 will fail due to the etag lines...
Because that makes little sense to me, I made this patch to fix it. :)

Comment #12

millenniumtree

he/him

Holualoa, HI

CreditAttribution: millenniumtree commented 15 July 2016 at 14:03

Status:

Needs work

» Needs review

Comment #13

millenniumtree

he/him

Holualoa, HI

CreditAttribution: millenniumtree commented 15 July 2016 at 14:33

One of the hunks failed on 7.x-3.6, but applies on the current git 7.x-3.x. Had to manually apply it in 3.6 (but that may have been from your previous patch being applied...)

Successfully tested on the following two platforms, both with provision 7.x-3.6:
Ubuntu 14.04.4 LTS with nginx 1.4.6
Debian 7.6 "wheezy" with nginx 1.2.1