Compilation & Installation of the Freedom Remailer
--------------------------------------------------

 1. Take a look at the Makefile.  Change the values of CC, CFLAGS, and LDFLAGS
    according to your system if you need to.  If you don't want to use regular
    expression blocking, remove "-DUSE_RX" from DEF and "-lrx" from LIBS.

 2. Take a look at freedom.h.  You may want to change DISCLAIMER, the header
    that the remailer adds to each anonymous messages, and SYSLOG_FACILITY,
    the logging facility for log messages sent to syslogd.  There is no need
    to change other variables than DISCLAIMER or SYSLOG_FACILITY.

 3. Type "./Install" to compile and install the remailer.

 4. Take a look at freedom.conf.  You may want to change this file.  Below
    is a description of what each definition means:

USE_SYSLOG
	Define this if you want log messages to be sent to the syslogd
	daemon.  Set to 1 if you want logging, 0 if you do not.

USE_STATS
	This option will enable the statistics-keeping in the remailer.
	If you are running this remailer as the type-1 remailer under
	Mixmaster, mail with subject "remailer-stats" returns the Mixmaster
	statistics.  The detailed type-1 statistics are accessible by sending
	mail with subject "freedom-stats".  Set to 1 if you want it, 0 if
	you do not.

USE_MIX
	Define this if you already have a Mixmaster remailer and want your
	Freedom remailer to use the Mixmaster reordering pool.  You must
	also set MIX_DIR to the path of the Mixmaster reordering pool.
	If USE_MIX is set to 1, the remailer moves the anonymous messages
	to the Mixmaster pool.  If set to 2, the remailer calls Mixmaster
	to encrypt intermediate hops to Mixmaster remailers.
	Set USE_MIX to 0 if there is no Mixmaster on your system.

ALLOW_PGP
	Define this if you want PGP support.  This will allow decryption of
	messages encrypted with the remailer's PGP key and will enable the
	"Encrypt-Key:" header.  Set to 1 if you want to allow PGP encrypted
	messages, 0 if you do not.  Set to 2 if you don't want to remail
	plaintext messages, except from a co-located nymserver.
	You must also set PGP to the path of your PGP program, PGP_DIR
	to the remailer's PGP keyring directory, and PASS_FILE to the
	remailer's secret key passphrase file.

ALLOW_GPG
	Define this if you want GPG support.  This will allow decryption of
	messages encrypted with the remailer's GPG key.  Set to 1 if you
	want it, 0 if you do not.  You must also set GPG to the path of
	your GPG program, GPG_DIR to the remailer's GPG keyring directory,
	and PASS_FILE to the remailer's secret key passphrase file.

ALLOW_POST
	Define this if you want your remailer to be able to post anonymously
	to Usenet using "Anon-Post-To:".  Set to 1 if you want to post
	through inews or Mixmaster.  You must also set INEWS to the path
	of your inews program, or MIX_DIR if you post through Mixmaster.
	If you set ALLOW_POST to 2, your remailer will send news articles to
	a mail-to-news gateway for posting.  You must set MAIL2NEWS to the
	e-mail address of the mail-to-news gateway.  Setting ALLOW_POST to
	0 disables posting with "Anon-Post-To:".

ALLOW_WWW
	Set this to 1 if you have the GNU Wget utility installed and want
	to support the "Get-URL:" header.  This feature is useful only if
	you have a permanent Internet connection.  You must also set WGET
	to the path of your Wget program.

ALLOW_LTIME
	Set this to 1 if you want your remailer to queue messages using
	"Latent-Time:" for delayed delivery.  In case of denial-of-service
	attacks you can set ALLOW_LTIME to 0 to enforce immediate remailing.

SIZE_LIMIT
	Incoming messages larger than SIZE_LIMIT bytes are deleted.
	Set to 0 if you don't want a size limit for your remailer.

REMAILER_DIR	The working directory of your remailer installation.
		It may be overridden by the FREEDOM environment variable.
MIX_DIR		The directory of the Mixmaster message reordering pool.
QUEUE_DIR	The directory to use to hold queued latent messages.
PGP_DIR		The directory where your remailer's PGP keyrings are stored
GPG_DIR		The directory where your remailer's GPG keyrings are stored.
MAIL_SPOOL	The mail spool or log file where you want non-anonymous mail
		to be dumped.
SENDMAIL	The path to your sendmail program, and an option to read the
		message headers for recipient addresses (usually "-t").
INEWS		The path to your inews program, and an option to recognize
		message headers (usually "-h").
MIXMASTER	The path to your Mixmaster remailer program.
TYPE2_LIST	The path to your Mixmaster's type2.list file.
PGP		The path to your PGP encryption program.
GPG		The path to your GPG encryption program.
WGET		The path to your Wget WWW client.
HELP_FILE	The name of the helpfile that resides in REMAILER_DIR that
		describes the use of this remailer.
STATS_FILE	The name of the statistics file that resides in REMAILER_DIR
KEY_FILE	The file containing your remailer's public keys.
PASS_FILE	The file containing your remailer's secret key passphrase.
REPGP_KEYS	Public keys of type-1 remailers for repgp'ing.
SOURCE_BLOCK	The name of the file containing addresses from whom
		anonymous mail should not be accepted.
DEST_BLOCK	The name of the file containing addresses to whom
		anonymous mail should not be sent.
GROUP_BLOCK	The name of the file containing Usenet news groups
		that you want to block.
URL_BLOCK	The name of the file containing URLs that you want to block.
HDRFILTER	The name of the file containing headers that you don't want
		in outgoing messages.
REMAILER_NAME	The long name of your remailer (as in its PGP key).
ANON_NAME	The long name to be used in remailed messages.
ORGANIZATION	What to put in the "Organization:" header of anonymous posts.
MAIL2NEWS	The e-mail address of a mail-to-news gateway for posting
		to Usenet.  Only header-parsing gateways are allowed; see
		http://students.cs.byu.edu/~don/mail2news.html for a list.
REMAILER_ADDR	The real e-mail address of your remailer.
ANON_ADDR	The e-mail address in the "From:" header of remailed messages.
COMPLAINTS	The e-mail address you want complaints about your remailer
		to be sent to.

 5. Get the current repgp keyring from repgp-keys@squirrel.owl.de and pipe
    it through "pgp -kaf repgp-keys.pgp" to update your repgp-keys.pgp file.

 6. Modify the help file as you see fit, add addresses/groups/URLs to the
    block files, etc.

 7. Run some tests with different configurations.

 8. Hopefully it passed the tests.  Yahoo!  You have a remailer.

 9. Subscribe to remailer-operators@anon.lcs.mit.edu (by sending mail to
    remailer-operators-request@anon.lcs.mit.edu with the word "subscribe"
    in the first body line) to be fully informed about new developments.

10. Announce your remailer to remailer-operators and alt.privacy.anon-server.

If you encounter any problems in installation or operation or you have any
other comments or questions on this piece of software, please send them to
the maintainer via e-mail at hanne@squirrel.owl.de.
