razor-agents(5) [debian man page]
RAZOR-AGENTS(5) User Contributed Perl Documentation RAZOR-AGENTS(5) NAME
Razor-Agents - Collection of files for checking, reporting, and revoking spam DESCRIPTION
Vipul's Razor is a distributed, collaborative, spam detection, reporting, and filtering network. The primary focus of the system is to identify and remove all email spam from the internet. Visit the website at http://razor.sourceforge.net/. USAGE
First a razorhome directory should be created where log, conf, and cached server information will live. This is done via "-create" option to razor-admin(1). See man page for details. You can immediately check spam using razor-check(1). See man page for details. To report spam, an identity must be registered. This is done via "-register" option to razor-admin(1). After that, razor-report(1) and razor-revoke(1) will work flawlessly. CONFIGURATION
All Razor-Agents share a configuration file. The contents of the configuration file are detailed in the razor-agent.conf(5) manpage. Config file is computed before razorhome, in the following order: -conf=/path/file.conf used if readable, else <home>/.razor/razor-agent.conf used if readable, else /etc/razor/razor-agent.conf used if readable, else all defaults are used. To see configuration defaults, do razor-admin -create -conf=/tmp/razor2-defaults.conf RAZORHOME
All Razor-Agents also share a razorhome directory, where identity, logging, and cached information about servers is stored. Razorhome is computed after configuration file, in the following order. -home=/tmp/razor/ used if readable, else 'razorhome' from configuration file used if readable, else <home>/.razor/ used if readable, else <home>/.razor/ is created. if that fails, no razorhome. NOTE: If there is no razorhome, razor-report and razor-revoke will not work unless you specify -ident=/path/identity razor-check will still work. FILES
Besides those listed at the end with their own manpages, Razor Agents also has the following files. razorhome/identity Usually a symlink to identity file containing user+pass. Used by razor-report(1) and razor-revoke(1). razorhome/razor-agent.log Default log file. To change, edit razor-agent.conf(5). razorhome/servers.*.lst Cached list of Razor Servers. If more than one, they are ordered by closest ping time. razorhome/server.<name>.lst Cached info for <name> server. The "srl" key in this file is compared against the server greeting, and if server's is greater, new cache info is retrieved from the server. EXAMPLES
razor-check -d -debuglevel=9 mbox Checks spam in mbox. prints numbers for those found to be spam. -d logs to stdout, -debuglevel=9 is verbose logging razor-admin -create -home=/home/chad/.razor -d -s Creates razorhome in /home/chad/.razor, log to stdout, does not connect to server (-s simulate). razor-report spam -debuglevel=0 sends spam to server, with no log msgs. AUTHORS
Vipul Ved Prakash, <mail@vipul.net> and Chad Norwood <chad@samo.org> SEE ALSO
razor-agent.conf(5), razor-check(1), razor-admin(1), razor-report(1), razor-revoke(1), razor-whitelist(5) perl v5.14.2 2008-07-21 RAZOR-AGENTS(5)
Check Out this Related Man Page
RAZOR-ADMIN(1p) User Contributed Perl Documentation RAZOR-ADMIN(1p) NAME
"razor-admin" - Razor Registering Agent SYNOPSIS
razor-admin [options] [ -register | -create | -discover ] DESCRIPTION
"razor-admin" is the Razor Agent that performs administrative functions, most notably registering (-register) USAGE
"razor-admin" must have one of the following arguments: "-register" Registers a new identity, used for authenticating with Razor Nomination Servers. Identities are a user + password pair stored in "<razorhome>/identity-<user>". The first time "razor-admin -register" exits successfully, a symlink "identity" is created to point to the active "identity-<user>" file. After that, new identities can be created, but in order to use them the symlink "identity" must be changed to point to them. In general, it should be called once from the command line. Exits 0 for success, exits 1 on failure with a human-readable output message. Both razor-report(1) and razor-revoke(1) require user authentication to work, razor-check(1) does not. This allows the Razor Nomination Server to keep track of how many messages a user reports and revokes. The more messages a user correctly reports and/or correctly revokes, the more trust the user earns. Likewise, when messages are incorrectly reported or revoked, the trust goes down for that user. Highly trusted users will have the most affect on the Razor database. "-discover" Force discovery. This will create "server.*.lst" files in <razorhome>. "-create" Explicitly creates "razor-agent.conf" file in <razorhome>, as well as <razorhome> if it does not exist. Normally loads "/etc/razor/razor-agent.conf" if it exists, using defaults for anything not found. Does not attempt to register with server, but will do discovery, see "-discover". OPTIONS
"razor-admin" takes following optional arguments: "-h" Print a usage message and exit. "-v" Print the version number and exit. "-d | --verbose" Print debugging information. "-debuglevel=n | -dl=n" Set debug level to 'n'. Default is 3 without "-d" option, 9 with. "-s" Simulate a check. Do everything except talk to the server. "-conf=filename" Specifies an alternate configuration file. If not specified, it is computed, see razor-agents(1) manpage for details. See razor-agent.conf(5) manpage for various configuration options. The default is "<razorhome>/razor-agent.conf". "-home=directory" Specify razorhome directory. This is where the configuration file, logfiles, identities, and server files live. If not specified, it is computed, see razor-agents(1) manpage for details. "-logfile=file" Specify file to log to instead of what is in the configuration file. The default is "<razorhome>/razor-agent.log". "-ident=filename" Specify an identify file to use for storing a newly registered identity. If not specified, "<razorhome>/identity-<user>" is used. "-rs=razor.server.com" Use this Razor Nomination Server instead of reading "servers.nomination.lst". "-user=user@domain.com" Request to be known as this username. Must be less than 64 chars and may contain A-Z, a-z, 0-9, as well printable chars [ex: - _ @ . + / ]. If not specified, a username will be assigned. Razor users are encouraged to use their email addresses as their username. "-pass=password" Request this password. Valid chars are the same as for -user. If not specified, it will be assigned. "-l" The identity created during this "razor-admin" becomes the default. Normally, the first identity file created by "razor-admin" is the default one used. EXAMPLES
razor-admin -d -create With no global razorhome defined (default) in /etc/razor/razor-agents.conf, creates .razor directory in user's home directory. With global razorhome defined in /etc/razor/razor-agents.conf, will try to use that one, will fail if it does not have correct permissions. razor-admin -register Registers a new identity, storing it in <lt>razorhome<gt>. User and pass will be server generated. An identity is required for razor-report(1) and razor-revoke(1). razor-admin -register -user me@a.com Attempts to register a new identity using the user name 'me@a.com'. Will fail if user is already taken. razor-admin -d -create -home=/home/me/.razor Creates .razor directory in user's home directory, which will then be the default home unless specified from cmd-line. Sends debugging information to stdout, and does not talk to any Razor Servers. razor-admin -d -create -home=/etc/razor Creates global razorhome, /etc/razor. This is the magic directory that will be consulted if no razorhome is specified on the cmd-line or found in user's home directory. AUTHORS
Vipul Ved Prakash <mail@vipul.net>, and Chad Norwood <chad@samo.org> SEE ALSO
razor-agents(1), razor-agent.conf(5), razor-check(1), razor-report(1), razor-revoke(1), razor-whitelist(5) LICENSE
This is free software, distributed under the Artistic License 2.0. perl v5.14.2 2008-07-21 RAZOR-ADMIN(1p)