The /etc/cups/cups-files.conf file contains configuration directives that control the files, directories. users. and groups that are used by the CUPS scheduler, cupsd(8). Each directive is listed on a line by itself followed by its value. Comments are introduced using the number sign ("#") character at the beginning of a line.
The AccessLog directive sets the name of the
access log file. If the filename is not absolute then it is
assumed to be relative to the ServerRoot directory. The
access log file is stored in "common log format" and can be used
by any web access reporting tool to generate a report on CUPS
server activity.
The server name can be included in the filename by using
%s in the name.
The special name "syslog" can be used to send the access
information to the system log instead of a plain file.
The default access log file is
/var/log/cups/access_log.
The ConfigFilePerm directive specifies the permissions to use when the scheduler writes configuration and cache files, typically in response to IPP or HTTP requests. The default is 640.
Note:
The permissions for the printers.conf file are always masked to only allow access from the scheduler user (typically root). This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system. There is no way to disable this security feature.
The DocumentRoot directive specifies the location
of web content for the HTTP server in CUPS. If an absolute path
is not specified then it is assumed to be relative to the ServerRoot directory. The
default directory is /usr/share/cups/doc-root.
Documents are first looked up in a sub-directory for the
primary language requested by the client (e.g.
/usr/share/cups/doc-root/fr/...) and then directly under
the DocumentRoot directory (e.g.
/usr/share/cups/doc-root/...), so it is possible to
localize the web content by providing subdirectories for each
language needed.
The ErrorLog directive sets the name of the error
log file. If the filename is not absolute then it is assumed to
be relative to the ServerRoot directory. The
default error log file is /var/log/cups/error_log.
The server name can be included in the filename by using
%s in the name.
The special name "syslog" can be used to send the error
information to the system log instead of a plain file.
The FileDevice directive determines whether the
scheduler allows new printers to be added using device URIs of
the form file:/filename. File devices are most often
used to test new printer drivers and do not support raw file
printing.
The default setting is No.
Note:
File devices are managed by the scheduler. Since the
scheduler normally runs as the root user, file devices
can be used to overwrite system files and potentially
gain unauthorized access to the system. If you must
create printers using file devices, we recommend that
you set the FileDevice directive to
Yes for only as long as you need to add the
printers to the system, and then reset the directive to
No.
The PageLog directive sets the name of the page
log file. If the filename is not absolute then it is assumed to
be relative to the ServerRoot directory. The
default page log file is /var/log/cups/page_log.
The server name can be included in the filename by using
%s in the name.
The special name "syslog" can be used to send the page
information to the system log instead of a plain file.
The Printcap directive controls whether or not a
printcap file is automatically generated and updated with a list
of available printers. If specified with no value, then no
printcap file will be generated. The default is to generate a
file named /var/run/cups/printcap.
When a filename is specified (e.g. /var/run/cups/printcap),
the printcap file is written whenever a printer is added or
removed. The printcap file can then be used by applications that
are hardcoded to look at the printcap file for the available
printers.
PrintcapFormat BSD
PrintcapFormat Solaris
PrintcapFormat plist
Description
The PrintcapFormat directive controls the output format of the
printcap file. The default is to generate the plist format on OS X, the
Solaris format on Solaris, and the BSD format on other operating systems.
The RemoteRoot directive sets the username for
unauthenticated root requests from remote hosts. The default
username is remroot. Setting RemoteRoot
to root effectively disables this security
mechanism.
The RequestRoot directive sets the directory for
incoming IPP requests and HTML forms. If an absolute path is not
provided then it is assumed to be relative to the ServerRoot directory. The
default request directory is /var/spool/cups.
The ServerBin directive sets the directory for
server-run executables. If an absolute path is not provided then
it is assumed to be relative to the ServerRoot directory. The
default executable directory is /usr/lib/cups,
/usr/lib32/cups, or /usr/libexec/cups
depending on the operating system.
The ServerCertificate directive specifies the
location of the SSL certificate file used by the server when
negotiating encrypted connections. The certificate must not be
encrypted (password protected) since the scheduler normally runs
in the background and will be unable to ask for a password.
The default certificate file is
/etc/cups/ssl/server.crt.
The ServerRoot directive specifies the absolute
path to the server configuration and state files. It is also used
to resolve relative paths in the cupsd.conf file. The
default server directory is /etc/cups.
The SystemGroup directive specifies the system
administration group for System authentication.
Multiple groups can be listed, separated with spaces. The default
group list is lpadmin.
The TempDir directive specifies an absolute path
for the directory to use for temporary files. The default
directory is /var/spool/cups/tmp.
Temporary directories must be world-writable and should have
the "sticky" permission bit enabled so that other users cannot
delete filter temporary files. The following commands will create
an appropriate temporary directory called
/foo/bar/tmp:
The User directive specifies the UNIX user that
filter and CGI programs run as. The default user is
lp.
Note:
You may not use user root, as that would expose
the system to unacceptable security risks. The scheduler will
automatically choose user nobody if you specify a
user whose ID is 0.