Skip to content
This repository was archived by the owner on Apr 25, 2018. It is now read-only.

Commit 25bfaf9

Browse files
committed
Updating the readme with configuration and installation info.
1 parent bf9324d commit 25bfaf9

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

Diff for: README.markdown

+33-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,37 @@ Nginx Static Etags
33

44
Nginx doesn't generate etags for static content. I think it should. If I can remember enough C from college to make it work as a module, I will.
55

6-
This does not work yet.
6+
### Installation
77

8-
It will not work for quite some time, if ever. But it's a fun way to play a bit with C again.
8+
Download the module however you like. I'd recommend pulling it down with Git by simply cloning this repository:
9+
10+
mkdir ~/src
11+
cd ~/src
12+
git clone git://github.com/mikewest/nginx-static-etags.git ./nginx-static-etags
13+
14+
To use the module, you'll have to compile it into Nginx. So, download the Nginx source, configure it with the module path, and compile:
15+
16+
mkdir ~/src
17+
cd ~/src
18+
curl -O http://sysoev.ru/nginx/nginx-0.6.32.tar.gz
19+
tar -zxvf ./nginx-0.6.32.tar.gz
20+
cd ./nginx-0.6.32
21+
./configure --add-module=/Users/mikewest/Repositories/nginx-static-etags
22+
make
23+
sudo make install
24+
25+
And you're done!
26+
27+
### Configuration
28+
29+
Add `FileEtag` to the relevant `location` blocks in your `nginx.conf` file:
30+
31+
location / {
32+
...
33+
FileETag on;
34+
...
35+
}
36+
37+
It's currently an on/off toggle. The plan is to bring it to feature parity with [the Apache configuration option][apache]. It's really not there yet.
38+
39+
[apache]: http://httpd.apache.org/docs/1.3/mod/core.html#fileetag

0 commit comments

Comments
 (0)