← Back to branch summary

~ubuntu-branches/ubuntu/trusty/swift/trusty-updates

« back to all changes in this revision

Viewing changes to doc/manpages/proxy-server.conf.5

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2013-01-28 09:40:30 UTC
  • mfrom: (1.2.16)
  • Revision ID: package-import@ubuntu.com-20130128094030-aetz57x2qz9ye2d4
Tags: 1.7.6-0ubuntu1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manpages/proxy-server.conf.5
91
91
 
92
92
.IP "\fBpipeline\fR"
93
93
It is used when you need apply a number of filters. It is a list of filters
94
 
ended by an application. The default should be \fB"catch_errors healthcheck
95
 
cache ratelimit tempauth proxy-server"\fR
 
94
ended by an application. The normal pipeline is "catch_errors healthcheck
 
95
cache ratelimit tempauth proxy-logging proxy-server".
96
96
.RE
97
97
.PD
98
98
 
109
109
.RS 3
110
110
.IP "\fBuse\fR"
111
111
Entry point for paste.deploy for the healthcheck middleware. This is the reference to the installed python egg.
112
 
The default is \fBegg:swift#healthcheck\fR.
 
112
This is normally \fBegg:swift#healthcheck\fR.
 
113
.IP "\fBdisable_path\fR"
 
114
An optional filesystem path which, if present, will cause the healthcheck
 
115
URL to return "503 Service Unavailable" with a body of "DISABLED BY FILE".
113
116
.RE
114
117
 
115
118
 
119
122
.RS 3
120
123
.IP \fBuse\fR
121
124
Entry point for paste.deploy for the tempauth middleware. This is the reference to the installed python egg.
122
 
The default is \fBegg:swift#tempauth\fR.
 
125
This is normally \fBegg:swift#tempauth\fR.
123
126
.IP "\fBset log_name\fR"
124
127
Label used when logging. The default is tempauth.
125
128
.IP "\fBset log_facility\fR"
171
174
.PD
172
175
 
173
176
.RS 0
174
 
.IP "\fB[filter:healthcheck]\fR"
175
 
.RE
176
 
.RS 3
177
 
.IP \fBuse\fR
178
 
Entry point for paste.deploy for the healthcheck middleware. This is the reference to the installed python egg.
179
 
The default is \fBegg:swift#healthcheck\fR.
180
 
.IP "\fBset log_name\fR"
181
 
Label used when logging. The default is healthcheck.
182
 
.IP "\fBset log_facility\fR"
183
 
Syslog log facility. The default is LOG_LOCAL0.
184
 
.IP "\fBset log_level\fR "
185
 
Logging level. The default is INFO.
186
 
.IP "\fBset log_address\fR"
187
 
Logging address. The default is /dev/log.
188
 
.IP "\fBset log_headers\fR "
189
 
Enables the ability to log request headers. The default is False.
190
 
.RE
191
 
 
192
 
 
193
 
 
194
 
.RS 0
195
177
.IP "\fB[filter:cache]\fR"
196
178
.RE
197
179
 
200
182
.RS 3
201
183
.IP \fBuse\fR
202
184
Entry point for paste.deploy for the memcache middleware. This is the reference to the installed python egg.
203
 
The default is \fBegg:swift#memcache\fR.
 
185
This is normally \fBegg:swift#memcache\fR.
204
186
.IP "\fBset log_name\fR"
205
187
Label used when logging. The default is memcache.
206
188
.IP "\fBset log_facility\fR"
241
223
.RS 3
242
224
.IP \fBuse\fR
243
225
Entry point for paste.deploy for the ratelimit middleware. This is the reference to the installed python egg.
244
 
The default is \fBegg:swift#ratelimit\fR.
 
226
This is normally \fBegg:swift#ratelimit\fR.
245
227
.IP "\fBset log_name\fR"
246
228
Label used when logging. The default is ratelimit.
247
229
.IP "\fBset log_facility\fR"
289
271
.RS 3
290
272
.IP \fBuse\fR
291
273
Entry point for paste.deploy for the domain_remap middleware. This is the reference to the installed python egg.
292
 
The default is \fBegg:swift#domain_remap\fR.
 
274
This is normally \fBegg:swift#domain_remap\fR.
293
275
.IP "\fBset log_name\fR"
294
276
Label used when logging. The default is domain_remap.
295
277
.IP "\fBset log_address\fR"
318
300
.RS 3
319
301
.IP \fBuse\fR
320
302
Entry point for paste.deploy for the catch_errors middleware. This is the reference to the installed python egg.
321
 
The default is \fBegg:swift#catch_errors\fR.
 
303
This is normally \fBegg:swift#catch_errors\fR.
322
304
.IP "\fBset log_name\fR"
323
305
Label used when logging. The default is catch_errors.
324
306
.IP "\fBset log_facility\fR"
342
324
.RS 3
343
325
.IP \fBuse\fR
344
326
Entry point for paste.deploy for the cname_lookup middleware. This is the reference to the installed python egg.
345
 
The default is \fBegg:swift#cname_lookup\fR.
 
327
This is normally \fBegg:swift#cname_lookup\fR.
346
328
.IP "\fBset log_name\fR"
347
329
Label used when logging. The default is cname_lookup.
348
330
.IP "\fBset log_facility\fR"
371
353
.RS 3
372
354
.IP \fBuse\fR
373
355
Entry point for paste.deploy for the staticweb middleware. This is the reference to the installed python egg.
374
 
The default is \fBegg:swift#staticweb\fR.
 
356
This is normally \fBegg:swift#staticweb\fR.
375
357
.IP \fBcache_timeout\fR
376
358
Seconds to cache container x-container-meta-web-* header values. The default is 300 seconds.
377
359
.IP "\fBset log_name\fR"
423
405
.RS 3
424
406
.IP \fBuse\fR
425
407
Entry point for paste.deploy for the formpost middleware. This is the reference to the installed python egg.
426
 
The default is \fBegg:swift#formpost\fR.
 
408
This is normally \fBegg:swift#formpost\fR.
427
409
.RE
428
410
 
429
411
 
437
419
.RS 3
438
420
.IP \fBuse\fR
439
421
Entry point for paste.deploy for the name_check middleware. This is the reference to the installed python egg.
440
 
The default is \fBegg:swift#name_check\fR.
 
422
This is normally \fBegg:swift#name_check\fR.
441
423
.IP \fBforbidden_chars\fR
442
424
Characters that will not be allowed in a name.
443
425
.IP \fBmaximum_length\fR
447
429
.RE
448
430
 
449
431
 
 
432
.RS 0
 
433
.IP "\fB[filter:proxy_logging]\fR"
 
434
.RE
 
435
 
 
436
Logging for the proxy server now lives in this middleware.
 
437
If the access_* variables are not set, logging directives from [DEFAULT]
 
438
without "access_" will be used.
 
439
 
 
440
.RS 3
 
441
.IP \fBuse\fR
 
442
Entry point for paste.deploy for the proxy_logging middleware. This is the reference to the installed python egg.
 
443
This is normally \fBegg:swift#proxy_logging\fR.
 
444
.IP "\fBaccess_log_name\fR"
 
445
Label used when logging. The default is proxy-server.
 
446
.IP "\fBaccess_log_facility\fR"
 
447
Syslog log facility. The default is LOG_LOCAL0.
 
448
.IP "\fBaccess_log_level\fR "
 
449
Logging level. The default is INFO.
 
450
.IP \fBaccess_log_address\fR
 
451
Default is /dev/log.
 
452
.IP \fBaccess_log_udp_host\fR
 
453
If set, access_log_udp_host will override access_log_address.  Default is
 
454
unset.
 
455
.IP \fBaccess_log_udp_port\fR
 
456
Default is 514.
 
457
.IP \fBaccess_log_statsd_host\fR
 
458
You can use log_statsd_* from [DEFAULT], or override them here.
 
459
Default is localhost.
 
460
.IP \fBaccess_log_statsd_port\fR
 
461
Default is 8125.
 
462
.IP \fBaccess_log_statsd_default_sample_rate\fR
 
463
Default is 1.
 
464
.IP \fBaccess_log_statsd_metric_prefix =
 
465
Default is "" (empty-string)
 
466
.IP \fBaccess_log_headers\fR
 
467
Default is False.
 
468
.IP \fBlog_statsd_valid_http_methods\fR
 
469
What HTTP methods are allowed for StatsD logging (comma-sep); request methods
 
470
not in this list will have "BAD_METHOD" for the <verb> portion of the metric.
 
471
Default is "GET,HEAD,POST,PUT,DELETE,COPY,OPTIONS".
 
472
.RE
 
473
 
 
474
 
450
475
.PD
451
476
 
452
477
 
459
484
that are acceptable within this section.
460
485
.IP \fBuse\fR
461
486
Entry point for paste.deploy for the proxy server. This is the reference to the installed python egg.
462
 
The default is \fBegg:swift#proxy\fR.
463
 
.IP "\fBset log_name\fR
 
487
This is normally \fBegg:swift#proxy\fR.
 
488
.IP \fBset log_name\fR
464
489
Label used when logging. The default is proxy-server.
465
 
.IP "\fBset log_facility\fR
 
490
.IP \fBset log_facility\fR
466
491
Syslog log facility. The default is LOG_LOCAL0.
467
 
.IP "\fB set log_level\fR
 
492
.IP \fB set log_level\fR
468
493
Logging level. The default is INFO.
469
 
.IP "\fB set log_address\fR
 
494
.IP \fB set log_address\fR
470
495
Logging address. The default is /dev/log.
471
 
.IP "\fBset access_log_name\fR"
472
 
Label used when logging. The default is proxy-server.
473
 
.IP "\fBset access_log_facility\fR"
474
 
Syslog log facility. The default is LOG_LOCAL0.
475
 
.IP "\fBset access_log_level\fR "
476
 
Logging level. The default is INFO.
477
 
.IP "\fB set log_requests\fR
478
 
Enables request logging. The default is False.
 
496
.IP \fBlog_handoffs\fR
 
497
Log when handoff locations are used.  Default is True.
479
498
.IP \fBrecheck_account_existence\fR
480
499
Cache timeout in seconds to send memcached for account existence. The default is 60 seconds.
481
500
.IP \fBrecheck_container_existence\fR
508
527
If set to 'true' authorized accounts that do not yet exist within the Swift cluster
509
528
will be automatically created. The default is set to false.
510
529
.IP \fBrate_limit_after_segment\fR
511
 
Rate limit the download of large object segments after this segment is
512
 
downloaded. The default is 10 segments.
 
530
Start rate-limiting object segments after the Nth segment of a segmented
 
531
object.  The default is 10 segments.
513
532
.IP \fBrate_limit_segments_per_sec\fR
514
 
Rate limit large object downlods at this rate.  The default is 1.
 
533
Once segment rate-limiting kicks in for an object, limit segments served to N
 
534
per second.  The default is 1.
515
535
.RE
516
536
.PD
517
537