Skip to content

Printing

services.printing.allowFrom

From which hosts to allow unconditional access.

Type: list of string

Default

["localhost"]

Example

["all"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.browsedConf

The contents of the configuration. file of the CUPS Browsed daemon ({file}cups-browsed.conf)

Type: strings concatenated with "\n"

Default

""

Example

'' BrowsePoll cups.example.com''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.browsing

Specifies whether shared printers are advertised.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.clientConf

The contents of the client configuration. ({file}client.conf)

Type: strings concatenated with "\n"

Default

""

Example

'' ServerName server.example.com Encryption Never''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.cups-pdf.enable

Whether to enable the cups-pdf virtual pdf printer backend. By default, this will install a single printer pdf. but this can be changed/extended with {option}services.printing.cups-pdf.instances . Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cups-pdf.nix

services.printing.cups-pdf.instances

Permits to raise one or more cups-pdf instances. Each instance is named by an attribute name, and the attribute's values control the instance' configuration.

Type: attribute set of (submodule)

Default

{pdf = { };}

Example

{pdf = {settings = {Out = "\${HOME}/cups-pdf";UserUMask = "0033";};};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cups-pdf.nix

services.printing.cups-pdf.instances.<name>.confFileText

This will contain the contents of {file}cups-pdf.conf for this instance, derived from {option}settings. You can use this option to append text to the file.

Type: strings concatenated with "\n"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cups-pdf.nix

services.printing.cups-pdf.instances.<name>.enable

Whether to enable this cups-pdf instance. Type: boolean

Default

true

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cups-pdf.nix

services.printing.cups-pdf.instances.<name>.installPrinter

Whether to enable a CUPS printer queue for this instance. The queue will be named after the instance and will use the {file}CUPS-PDF_opt.ppd ppd file. If this is disabled, you need to add the queue yourself to use the instance . Type: boolean

Default

true

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cups-pdf.nix

services.printing.cups-pdf.instances.<name>.settings

Settings for a cups-pdf instance, see the descriptions in the template config file in the cups-pdf package. The key value pairs declared here will be translated into proper key value pairs for {file}cups-pdf.conf. Setting a value to null disables the option and removes it from the file.

Type: null or signed integer or string or path or package

Default

{ }

Example

{Out = "\${HOME}/cups-pdf";UserUMask = "0033";}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cups-pdf.nix

services.printing.cups-pdf.instances.<name>.settings.AnonDirName

path for anonymously created PDF files Type: null or (optionally newline-terminated) single-line string

Default

"/var/spool/cups-pdf-{instance-name}/anonymous"

Example

"/var/lib/cups-pdf"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cups-pdf.nix

services.printing.cups-pdf.instances.<name>.settings.Anonuser

User for anonymous PDF creation. An empty string disables this feature.

Type: (optionally newline-terminated) single-line string

Default

"root"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cups-pdf.nix

services.printing.cups-pdf.instances.<name>.settings.GhostScript

location of GhostScript binary Type: null or path

Default

lib.getExe pkgs.ghostscript

Example

${pkgs.ghostscript}/bin/ps2pdf

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cups-pdf.nix

services.printing.cups-pdf.instances.<name>.settings.Out

output directory; ${HOME} will be expanded to the user's home directory, ${USER} will be expanded to the user name.

Type: null or (optionally newline-terminated) single-line string

Default

"/var/spool/cups-pdf-{instance-name}/users/\${USER}"

Example

"\${HOME}/cups-pdf"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cups-pdf.nix

services.printing.cups-pdf.instances.<name>.settings.Spool

spool directory Type: null or (optionally newline-terminated) single-line string

Default

"/var/spool/cups-pdf-{instance-name}/spool"

Example

"/var/lib/cups-pdf"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cups-pdf.nix

services.printing.defaultShared

Specifies whether local printers are shared by default.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.drivers

CUPS drivers to use. Drivers provided by CUPS, cups-filters, Ghostscript and Samba are added unconditionally. If this list contains Gutenprint (i.e. a derivation with meta.isGutenprint = true) the PPD files in {file}/var/lib/cups/ppd will be updated automatically to avoid errors due to incompatible versions.

Type: list of path

Default

[ ]

Example

with pkgs; [ gutenprint hplip splix ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.enable

Whether to enable printing support through the CUPS daemon.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.extraConf

Extra contents of the configuration file of the CUPS daemon ({file}cupsd.conf).

Type: strings concatenated with "\n"

Default

""

Example

'' BrowsePoll cups.example.com MaxCopies 42''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.extraFilesConf

Extra contents of the configuration file of the CUPS daemon ({file}cups-files.conf).

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.listenAddresses

A list of addresses and ports on which to listen.

Type: list of string

Default

["localhost:631"]

Example

["*:631"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.logLevel

Specifies the cupsd logging verbosity.

Type: string

Default

"info"

Example

"debug"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.openFirewall

Whether to open the firewall for TCP/UDP ports specified in listenAdrresses option.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.package

The cups package to use. Type: package

Default

pkgs.cups

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.snmpConf

The contents of {file}/etc/cups/snmp.conf. See "man cups-snmp.conf" for a complete description.

Type: strings concatenated with "\n"

Default

'' Address @LOCAL''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.startWhenNeeded

If set, CUPS is socket-activated; that is, instead of having it permanently running as a daemon, systemd will start it on the first incoming connection.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.stateless

If set, all state directories relating to CUPS will be removed on startup of the service.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.tempDir

CUPSd temporary directory.

Type: path

Default

"/tmp"

Example

"/tmp/cups"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix

services.printing.webInterface

Specifies whether the web interface is enabled.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/printing/cupsd.nix