blob: 2ddf162c5e8ca9b5edf0f9cec3ca7b58866a82a9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
=encoding utf-8
=head1 NAME
ngx_http_slice_module - Module ngx_http_slice_module
=head1
The C<ngx_http_slice_module> module (1.9.8) is a filter
that splits a request into subrequests,
each returning a certain range of response.
The filter provides more effective caching of big responses.
This module is not built by default, it should be enabled with the
C<--with-http_slice_module>
configuration parameter.
=head1 Known Issues
Currently, the module does not work as expected in subrequests such as
L<background cache update|ngx_http_proxy_module>.
In this case, a request is constructed without byte-range support.
=head1 Example Configuration
location / {
<emphasis>slice</emphasis> 1m;
proxy_cache cache;
proxy_cache_key $uri$is_args$args<emphasis>$slice_range</emphasis>;
proxy_set_header Range <emphasis>$slice_range</emphasis>;
proxy_cache_valid 200 206 1h;
proxy_pass http://localhost:8000;
}
In this example,
the response is split into 1-megabyte cacheable slices.
=head1 Directives
=head2 slice
B<syntax:> slice I<I<C<size>>>
B<default:> I<0>
B<context:> I<http>
B<context:> I<server>
B<context:> I<location>
Sets the I<C<size>> of the slice.
The zero value disables splitting responses into slices.
Note that a too low value may result in excessive memory usage
and opening a large number of files.
In order for a subrequest to return the required range,
the C<$slice_range> variable should be
L<passed|ngx_http_proxy_module> to
the proxied server as the C<Range> request header field.
If
L<caching|ngx_http_proxy_module>
is enabled, C<$slice_range> should be added to the
L<cache key|ngx_http_proxy_module>
and caching of responses with 206 status code should be
L<enabled|ngx_http_proxy_module>.
=head1 Embedded Variables
The C<ngx_http_slice_module> module
supports the following embedded variables:
=over
=item C<$slice_range>
the current slice range in
L<HTTP
byte range|https://datatracker.ietf.org/doc/html/rfc7233#section-2.1> format,
for example, C<bytes=0-1048575>.
=back
|
