1cupsd.conf(5) Apple Inc. cupsd.conf(5)
2
6 cupsd.conf - server configuration file for cups
7
9 The cupsd.conf file configures the CUPS scheduler, cupsd(8). It is
10 normally located in the /etc/cups directory. Note: File, directory, and
11 user configuration directives that used to be allowed in the cupsd.conf
12 file are now stored in the cups-files.conf(5) instead in order to pre‐
13 vent certain types of privilege escalation attacks.
14 Each line in the file can be a configuration directive, a blank line,
16 or a comment. Comment lines start with the # character. The configura‐
17 tion directives are intentionally similar to those used by the popular
18 Apache web server software and are described below.
19
21 The following directives are understood by cupsd(8). Consult the on-
22 line help for detailed descriptions:
23 AccessLogLevel config
25 AccessLogLevel actions
27 AccessLogLevel all
29 Specifies the logging level for the AccessLog file.
30 Allow all
32 Allow none
34 Allow host.domain.com
36 Allow *.domain.com
38 Allow ip-address
40 Allow ip-address/netmask
42 Allow ip-address/mm
44 Allow @IF(name)
46 Allow @LOCAL
48 Allows access from the named hosts or addresses.
49 AuthType None
51 AuthType Basic
53 AuthType BasicDigest
55 AuthType Digest
57 AuthType Negotiate
59 Specifies the authentication type (None, Basic, BasicDigest,
60 Digest, Negotiate)
61 AutoPurgeJobs Yes
63 AutoPurgeJobs No
65 Specifies whether to purge job history data automatically when it
66 is no longer required for quotas.
67 BrowseLocalProtocols [All] [DNSSD]
69 Specifies the protocols to use for local printer sharing.
70 BrowseWebIF Yes
72 BrowseWebIF No
74 Specifies whether the CUPS web interface is advertised via DNS-SD.
75 Browsing Yes
77 Browsing No
79 Specifies whether or not shared printers should be advertised.
80 Classification banner
82 Specifies the security classification of the server.
83 ClassifyOverride Yes
85 ClassifyOverride No
87 Specifies whether to allow users to override the classification of
88 individual print jobs.
89 DefaultAuthType Basic
91 DefaultAuthType BasicDigest
93 DefaultAuthType Digest
95 DefaultAuthType Negotiate
97 Specifies the default type of authentication to use.
98 DefaultEncryption Never
100 DefaultEncryption IfRequested
102 DefaultEncryption Required
104 Specifies the type of encryption to use for authenticated
105 requests.
106 DefaultLanguage locale
108 Specifies the default language to use for text and web content.
109 DefaultPaperSize Auto
111 DefaultPaperSize None
113 DefaultPaperSize sizename
115 Specifies the default paper size for new print queues. "Auto" uses
116 a locale- specific default, while "None" specifies there is no
117 default paper size.
118 DefaultPolicy policy-name
120 Specifies the default access policy to use.
121 DefaultShared Yes
123 DefaultShared No
125 Specifies whether local printers are shared by default.
126 Deny all
128 Deny none
130 Deny host.domain.com
132 Deny *.domain.com
134 Deny ip-address
136 Deny ip-address/netmask
138 Deny ip-address/mm
140 Deny @IF(name)
142 Deny @LOCAL
144 Denies access to the named host or address.
145 DirtyCleanInterval seconds
147 Specifies the delay for updating of configuration and state files.
148 A value of 0 causes the update to happen as soon as possible, typ‐
149 ically within a few milliseconds.
150 Encryption IfRequested
152 Encryption Never
154 Encryption Required
156 Specifies the level of encryption that is required for a particu‐
157 lar location.
158 ErrorPolicy abort-job
160 Specifies that a failed print job should be aborted (discarded)
161 unless otherwise specified for the printer.
162 ErrorPolicy retry-job
164 Specifies that a failed print job should be retried at a later
165 time unless otherwise specified for the printer.
166 ErrorPolicy retry-this-job
168 Specifies that a failed print job should be retried immediately
169 unless otherwise specified for the printer.
170 ErrorPolicy stop-printer
172 Specifies that a failed print job should stop the printer unless
173 otherwise specified for the printer. The 'stop-printer' error pol‐
174 icy is the default.
175 FilterLimit limit
177 Specifies the maximum cost of filters that are run concurrently.
178 FilterNice nice-value
180 Specifies the scheduling priority ("nice" value) of filters that
181 are run to print a job.
182 GSSServiceName name
184 Specifies the service name when using Kerberos authentication. The
185 default service name is "host".
186 HostNameLookups On
188 HostNameLookups Off
190 HostNameLookups Double
192 Specifies whether or not to do reverse lookups on client
193 addresses.
194 Include filename
196 Includes the named file.
197 JobKillDelay seconds
199 Specifies the number of seconds to wait before killing the filters
200 and backend associated with a canceled or held job.
201 JobPrivateAccess all
203 JobPrivateAccess default
205 JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
207 Specifies an access list for a job's private values. The "default"
208 access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's
209 requesting-user-name-allowed or requesting-user-name-denied val‐
210 ues.
211 JobPrivateValues all
213 JobPrivateValues default
215 JobPrivateValues none
217 JobPrivateValues attribute-name-1 [ ... attribute-name-N ]
219 Specifies the list of job values to make private. The "default"
220 values are "job-name", "job-originating-host-name", and "job-orig‐
221 inating-user-name".
222 JobRetryInterval seconds
224 Specifies the interval between retries of jobs in seconds.
225 JobRetryLimit count
227 Specifies the number of retries that are done for jobs.
228 KeepAlive Yes
230 KeepAlive No
232 Specifies whether to support HTTP keep-alive connections.
233 KeepAliveTimeout seconds
235 Specifies the amount of time that connections are kept alive.
236 <Limit operations> ... </Limit>
238 Specifies the IPP operations that are being limited inside a pol‐
239 icy.
240 <Limit methods> ... </Limit>
242 <LimitExcept methods> ... </LimitExcept>
244 Specifies the HTTP methods that are being limited inside a loca‐
245 tion.
246 LimitRequestBody
248 Specifies the maximum size of any print job request.
249 Listen ip-address:port
251 Listen *:port
253 Listen /path/to/domain/socket
255 Listens to the specified address and port or domain socket path.
256 <Location /path> ... </Location>
258 Specifies access control for the named location.
259 LogDebugHistory #-messages
261 Specifies the number of debugging messages that are logged when an
262 error occurs in a print job.
263 LogLevel alert
265 LogLevel crit
267 LogLevel debug2
269 LogLevel debug
271 LogLevel emerg
273 LogLevel error
275 LogLevel info
277 LogLevel none
279 LogLevel notice
281 LogLevel warn
283 Specifies the logging level for the ErrorLog file.
284 LogTimeFormat standard
286 LogTimeFormat usecs
288 Specifies the format of the date and time in the log files.
289 MaxClients number
291 Specifies the maximum number of simultaneous clients to support.
292 MaxClientsPerHost number
294 Specifies the maximum number of simultaneous clients to support
295 from a single address.
296 MaxCopies number
298 Specifies the maximum number of copies that a user can print of
299 each job.
300 MaxHoldTime seconds
302 Specifies the maximum time a job may remain in the "indefinite"
303 hold state before it is canceled. Set to 0 to disable cancellation
304 of held jobs.
305 MaxJobs number
307 Specifies the maximum number of simultaneous jobs to support.
308 MaxJobsPerPrinter number
310 Specifies the maximum number of simultaneous jobs per printer to
311 support.
312 MaxJobsPerUser number
314 Specifies the maximum number of simultaneous jobs per user to sup‐
315 port.
316 MaxJobTime seconds
318 Specifies the maximum time a job may take to print before it is
319 canceled. The default is 10800 seconds (3 hours). Set to 0 to dis‐
320 able cancellation of "stuck" jobs.
321 MaxLogSize number-bytes
323 Specifies the maximum size of the log files before they are
324 rotated (0 to disable rotation)
325 MaxRequestSize number-bytes
327 Specifies the maximum request/file size in bytes (0 for no limit)
328 MultipleOperationTimeout seconds
330 Specifies the maximum amount of time to allow between files in a
331 multiple file print job.
332 Order allow,deny
334 Order deny,allow
336 Specifies the order of HTTP access control (allow,deny or
337 deny,allow)
338 PageLogFormat format string
340 Specifies the format of page log lines.
341 PassEnv variable [... variable]
343 Passes the specified environment variable(s) to child processes.
344 <Policy name> ... </Policy>
346 Specifies access control for the named policy.
347 Port number
349 Specifies a port number to listen to for HTTP requests.
350 PreserveJobFiles Yes
352 PreserveJobFiles No
354 Specifies whether or not to preserve job files after they are
355 printed.
356 PreserveJobHistory Yes
358 PreserveJobHistory No
360 Specifies whether or not to preserve the job history after they
361 are printed.
362 PrintcapFormat bsd
364 PrintcapFormat plist
366 PrintcapFormat solaris
368 Specifies the format of the printcap file.
369 ReloadTimeout seconds
371 Specifies the amount of time to wait for job completion before
372 restarting the scheduler.
373 Require group group-name-list
375 Require user user-name-list
377 Require valid-user
379 Specifies that user or group authentication is required.
380 RIPCache bytes
382 Specifies the maximum amount of memory to use when converting
383 images and PostScript files to bitmaps for a printer.
384 Satisfy all
386 Satisfy any
388 Specifies whether all or any limits set for a Location must be
389 satisfied to allow access.
390 ServerAdmin user@domain.com
392 Specifies the email address of the server administrator.
393 ServerAlias hostname [... hostname]
395 ServerAlias *
397 Specifies an alternate name that the server is known by. The spe‐
398 cial name "*" allows any name to be used.
399 ServerName hostname-or-ip-address
401 Specifies the fully-qualified hostname of the server.
402 ServerTokens Full
404 ServerTokens Major
406 ServerTokens Minimal
408 ServerTokens Minor
410 ServerTokens None
412 ServerTokens OS
414 ServerTokens ProductOnly
416 Specifies what information is included in the Server header of
417 HTTP responses.
418 SetEnv variable value
420 Set the specified environment variable to be passed to child pro‐
421 cesses.
422 SSLListen
424 Listens on the specified address and port for encrypted connec‐
425 tions.
426 SSLOptions None
428 SSLOptions [NoEmptyFragments] [AllowRC4] [Allow SSL3] [MinTLS1.2]
430 Sets SSL/TLS protocol options for encrypted connections. By
431 default, CUPS only supports encryption using TLS v1.0 or higher
432 using known secure cipher suites. The NoEmptyFragments option
433 allows CUPS to work with Microsoft Windows with the FIPS confor‐
434 mance mode enabled. The AllowRC4 option enables the 128-bit RC4
435 cipher suites, which are required for some older clients that do
436 not implement newer ones. The AllowSSL3 option enables SSL v3.0,
437 which is required for some older clients that do not support TLS
438 v1.0. The MinTLS1.2 option enforces CUPS to use TLS v1.2 and
439 higher.
440 SSLPort
442 Listens on the specified port for encrypted connections.
443 StrictConformance Yes
445 StrictConformance No
447 Specifies whether the scheduler requires clients to strictly
448 adhere to the IPP specifications. The default is No.
449 SubscriptionPrivateAccess all
451 SubscriptionPrivateAccess default
453 SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+
455 Specifies an access list for a subscription's private values. The
456 "default" access list is "@OWNER @SYSTEM". "@ACL" maps to the
457 printer's requesting-user-name-allowed or requesting-user-name-
458 denied values.
459 SubscriptionPrivateValues all
461 SubscriptionPrivateValues default
463 SubscriptionPrivateValues none
465 SubscriptionPrivateValues attribute-name-1 [ ... attribute-name-N ]
467 Specifies the list of job values to make private. The "default"
468 values are "notify-events", "notify-pull-method", "notify-recipi‐
469 ent-uri", "notify-subscriber-user-name", and "notify-user-data".
470 Timeout seconds
472 Specifies the HTTP request timeout in seconds.
473 WebInterface yes
475 WebInterface no
477 Specifies whether the web interface is enabled.
478
480 classes.conf(5), cups-files.conf(5), cupsd(8), mime.convs(5),
481 mime.types(5), printers.conf(5), subscriptions.conf(5),
482 http://localhost:631/help
483
485 Copyright 2007-2013 by Apple Inc.
48619 November 2012 CUPS cupsd.conf(5)