Hylafax
services.hylafax.areaCode
Area code for server and all modems.
Type: null or non-empty string
Default
null
Example
"30"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.autostart
Autostart the HylaFAX queue manager at system start.
If this is false, the queue manager
will still be started if there are pending
jobs or if a user tries to connect to it.
Type: boolean
Default
true
Example
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.commonModemConfig
Attribute set of default values for
modem config files {file}etc/config.*.
Values can be either strings or integers
(which will be added to the config file verbatimly)
or lists thereof
(which will be translated to multiple
lines with the same configuration key).
Boolean values are translated to "Yes" or "No".
The default contains some reasonable
configuration to yield an operational system.
Think twice before changing paths of fax-processing scripts.
Type: attribute set of ((list of ((string or signed integer convertible to it) or boolean convertible to it)) or ((string or signed integer convertible to it) or boolean convertible to it) convertible to it)
Example
{InternationalPrefix = "00";LongDistancePrefix = "0";}
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.countryCode
Country code for server and all modems.
Type: null or non-empty string
Default
null
Example
"49"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.enable
Whether to enable HylaFAX server.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.faxcron.enable.frequency
purging old files from the spooling area with
{file}faxcron with the given frequency
(see systemd.time(7))
Type: null or non-empty string
Default
null
Example
"daily"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.faxcron.enable.spoolInit
Whether to enable purging old files from the spooling area withfaxcron
each time the spooling area is initialized
.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.faxcron.infoDays
Set the expiration time for data in the remote machine information directory in days.
Type: positive integer, meaning >0
Default
30
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.faxcron.logDays
Set the expiration time for session trace log files in days.
Type: positive integer, meaning >0
Default
30
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.faxcron.rcvDays
Set the expiration time for files in the received facsimile queue in days.
Type: positive integer, meaning >0
Default
7
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.faxqConfig
Attribute set of lines for the global
faxq config file {file}etc/config.
Values can be either strings or integers
(which will be added to the config file verbatimly)
or lists thereof
(which will be translated to multiple
lines with the same configuration key).
Boolean values are translated to "Yes" or "No".
The default contains some reasonable
configuration to yield an operational system.
Type: attribute set of ((list of ((string or signed integer convertible to it) or boolean convertible to it)) or ((string or signed integer convertible to it) or boolean convertible to it) convertible to it)
Example
{InternationalPrefix = "00";LongDistancePrefix = "0";}
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.faxqclean.archiving
Enable or suppress job archiving:
never disables job archiving,
as-flagged archives jobs that
have been flagged for archiving by sendfax,
always forces archiving of all jobs.
See also sendfax(1) and faxqclean(8).
Type: one of "never", "as-flagged", "always"
Default
"as-flagged"
Example
"always"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.faxqclean.docqMinutes
Set the document age threshold (in minutes) that controls how long unreferenced files may reside in the docq directory.
Type: positive integer, meaning >0
Default
60
Example
24*60
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.faxqclean.doneqMinutes
Set the job age threshold (in minutes) that controls how long jobs may reside in the doneq directory.
Type: positive integer, meaning >0
Default
15
Example
24*60
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.faxqclean.enable.frequency
Purge old files from the spooling area with
{file}faxcron with the given frequency
(see systemd.time(7)).
Type: null or non-empty string
Default
null
Example
"daily"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.faxqclean.enable.spoolInit
Whether to enable purging old files from the spooling area withfaxqclean
each time the spooling area is initialized
.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.hfaxdConfig
Attribute set of lines for the global
hfaxd config file {file}etc/hfaxd.conf.
Values can be either strings or integers
(which will be added to the config file verbatimly)
or lists thereof
(which will be translated to multiple
lines with the same configuration key).
Boolean values are translated to "Yes" or "No".
The default contains some reasonable
configuration to yield an operational system.
Type: attribute set of ((list of ((string or signed integer convertible to it) or boolean convertible to it)) or ((string or signed integer convertible to it) or boolean convertible to it) convertible to it)
Example
{RecvqProtection = "0400";}
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.internationalPrefix
International prefix for server and all modems.
Type: null or string
Default
null
Example
"00"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.longDistancePrefix
Long distance prefix for server and all modems.
Type: null or string
Default
null
Example
"0"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.modems
Description of installed modems. At least on modem must be defined to enable the HylaFAX server.
Type: attribute set of (submodule)
Default
{ }
Example
{ttyS1 = {config = {FAXNumber = "123456";LocalIdentifier = "Smith";};type = "cirrus";};}
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.modems.<name>.config
Attribute set of values for the given modem. Values can be either strings or integers (which will be added to the config file verbatimly) or lists thereof (which will be translated to multiple lines with the same configuration key). Boolean values are translated to "Yes" or "No". The default contains some reasonable configuration to yield an operational system.
Options defined here override options in
{option}commonModemConfig for this modem.
Type: attribute set of ((list of ((string or signed integer convertible to it) or boolean convertible to it)) or ((string or signed integer convertible to it) or boolean convertible to it) convertible to it)
Example
{AreaCode = "49";FAXNumber = "123456";LocalCode = "30";LocalIdentifier = "LostInBerlin";}
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.modems.<name>.name
Name of modem device,
will be searched for in {file}/dev.
Type: non-empty string
Example
"ttyS1"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.modems.<name>.type
Name of modem configuration file,
will be searched for in {file}config
in the spooling area directory.
Type: non-empty string
Example
"cirrus"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.sendmailPath
Path to {file}sendmail program.
The default uses the local sendmail wrapper
(see {option}config.services.mail.sendmailSetuidWrapper),
otherwise the {file}false
binary to cause an error if used.
Type: path
Example
"${pkgs.postfix}/bin/sendmail"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.spoolAreaPath
The spooling area will be created/maintained at the location given here.
Type: path
Default
"/var/spool/fax"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.spoolExtraInit
Additional shell code that is executed within the spooling area directory right after its setup.
Type: strings concatenated with "\n"
Default
""
Example
"chmod 0755 . # everyone may read my faxes"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix
services.hylafax.userAccessFile
The {file}hosts.hfaxd
file entry in the spooling area
will be symlinked to the location given here.
This file must exist and be
readable only by the uucp user.
See hosts.hfaxd(5) for details.
This configuration permits access for all users:
environment.etc."hosts.hfaxd" = {
mode = "0600";
user = "uucp";
text = ".*";
};
config.systemd.sockets.hylafax-hfaxd.listenStreams;
by default, only 127.0.0.1 is permitted to connect.
Type: path
Default
"/etc/hosts.hfaxd"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/hylafax/options.nix