.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "RAZOR-AGENT.CONF 1" .TH RAZOR-AGENT.CONF 1 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME "razor\-agent.conf" \- Configuration file for Razor Agents .SH DESCRIPTION .IX Header "DESCRIPTION" \&\f(CW\*(C`razor\-agent.conf\*(C'\fR is a configuration file read by the razor agents, which include \fBrazor\-check\fR\|(1), \fBrazor\-admin\fR\|(1), \fBrazor\-report\fR\|(1), and \&\fBrazor\-revoke\fR\|(1). The format is "attribute = value" pairs, one pair per line. Lines that begin with `#' are treated as comments. .SH ATTRIBUTES .IX Header "ATTRIBUTES" Following attributes can be specified: .IP \fBrazorhome\fR 4 .IX Item "razorhome" Directory where Razor Agents look for files. All files in \f(CW\*(C`razor\-agent.conf\*(C'\fR without a full path will be relative to \f(CW\*(C`razorhome\*(C'\fR. The default is \f(CW\*(C`/etc/razor/\*(C'\fR for root, and \f(CW\*(C`~/.razor/\*(C'\fR for every other user. If \f(CW\*(C`razorhome\*(C'\fR does not exist, it will be created. .IP \fBlogfile\fR 4 .IX Item "logfile" Log file for the Razor Agents. The default is \f(CW\*(C`razor\-agent.log\*(C'\fR. .IP \fBdebuglevel\fR 4 .IX Item "debuglevel" Controls the amount of messages written to logfile. It is an integer between 0 and 20. For Example, a value of \f(CW1\fR logs only startup and error messages, \f(CW5\fR includes every transaction with the server, and \f(CW14\fR is extremely verbose information intended for debugging use only. NOTE: \f(CW15\fR and higher create debug files on your filesystem \-\- do not use unless you know what you are doing. The default is \f(CW5\fR. .IP \fBidentity\fR 4 .IX Item "identity" Specify an identify file to use for storing a newly registered identity during \fBrazor\-admin\fR\|(1). For \fBrazor\-report\fR\|(1) and \fBrazor\-revoke\fR\|(1), use this identity when authenticating with Razor Servers. If not specified, \f(CW\*(C`/identity\-\*(C'\fR is used. .IP \fBlistfile_nomination\fR 4 .IX Item "listfile_nomination" File where Razor Nomination Servers are listed, in order of closest TCP ping time. Nomination Servers are used by \fBrazor\-report\fR\|(1) and \fBrazor\-revoke\fR\|(1). This file is created automatically. The default is \f(CW\*(C`servers.nomination.lst\*(C'\fR. .IP \fBlistfile_catalogue\fR 4 .IX Item "listfile_catalogue" File where Razor Catalogue Servers are listed, in order of closest TCP ping time. Catalogue Servers are used by \fBrazor\-check\fR\|(1). This file is created automatically. The default is \f(CW\*(C`servers.catalogue.lst\*(C'\fR. .IP \fBlistfile_discovery\fR 4 .IX Item "listfile_discovery" File where Razor Discovery Servers are listed, in random order. This file is created automatically using DNS. The default is \f(CW\*(C`servers.discovery.lst\*(C'\fR. .IP \fBrediscovery_wait_dns\fR 4 .IX Item "rediscovery_wait_dns" Max time in seconds Razor Agents will wait before computing a new \&\f(CW\*(C`listfile_discovery\*(C'\fR using DNS. The default is \f(CW604800\fR, which is 7 days. .IP \fBrediscovery_wait\fR 4 .IX Item "rediscovery_wait" Max time in seconds Razor Agents will wait before computing a new \&\f(CW\*(C`listfile_nomination\*(C'\fR and a new \f(CW\*(C`listfile_catalogue\*(C'\fR. The default is \f(CW172800\fR, which is 2 days. .IP \fBturn_off_discovery\fR 4 .IX Item "turn_off_discovery" Turns off closest host discovery. When set to 1, \f(CW\*(C`listfile_catalogue\*(C'\fR and \f(CW\*(C`listfile_nomination\*(C'\fR will not be updated and \f(CW\*(C`listfile_discovery\*(C'\fR is not read or updated. The default is \f(CW0\fR. .IP \fBignorelist\fR 4 .IX Item "ignorelist" Automatically ignore mailing list posts. If set to \f(CW0\fR, mailing list posts will be handled like all other mail. The default is \f(CW0\fR. .IP \fBwhitelist\fR 4 .IX Item "whitelist" Name of whitelist file. Razor Agents can consult a whitelist of addresses and SHA1 hashes before checking a mail with Razor Servers. If the address/hash is found on the whitelist, the mail is marked `not spam', without checking against the server. The format of the whitelist can be found in \&\fBrazor\-whitelist\fR\|(5) manpage. The default is \f(CW\*(C`razor\-whitelist\*(C'\fR. .IP \fBmin_cf\fR 4 .IX Item "min_cf" When checking spam, the server optionally returns a spam confidence value ranging from 0 (not confident) to 100 (absolutely or 100% confident). To be considered spam, the server's spam confidence value must be greater than or equal to \f(CW\*(C`min_cf\*(C'\fR. \f(CW\*(C`min_cf\*(C'\fR can be a number or an expression containing ac, the average confidence published by a Razor Server. Examples: 0, 60, 100, ac, ac + 10, ac \- 20. If an expression evaluates to less than 0 it becomes 0, likewise those greater than 100 become 100. The default is \f(CW\*(C`ac\*(C'\fR. .IP \fBreport_headers\fR 4 .IX Item "report_headers" When reporting spam, the entire email (headers and body) is sent to a Razor Nomination Server. When set to \f(CW0\fR, all the headers are removed except headers beginning with \f(CW\*(C`Content\-\*(C'\fR before sending, and a special header beginning with \f(CW\*(C`X\-Razor2\*(C'\fR is added to note this action. The default is \f(CW1\fR. .SH AUTHORS .IX Header "AUTHORS" Vipul Ved Prakash, and Chad Norwood .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBrazor\-agents\fR\|(1), \fBrazor\-check\fR\|(1), \fBrazor\-admin\fR\|(1), \&\fBrazor\-report\fR\|(1), \fBrazor\-revoke\fR\|(1), \fBrazor\-whitelist\fR\|(5)