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

1. Take a look at the Makefile.  Change the values of CC, STRIP, CFLAGS,
   and LFLAGS according to your system if you need to.  If you are planning
   to use regular expression blocking, put the object or library filename
   for GNU regex.o or librx.a in RXOBJ.

2. Take a look at config.h.  You *will* have to change this file.  Below
   is a description of what each definition means:

USE_STATS
	This option will enable the statistics-keeping in the remailer.
	If you are running this remailer as the Type I remailer under
	Mixmaster, this is unnecessary since Mixmaster keeps its own stats.
	Set to YES if you want it, NO if you do not.
ALLOW_POST
	Define this if you want your remailer to be able to post anonymously
	to Usenet using inews.  Set to YES if you want it, NO if you do not.
	This option has no effect if MAIL2NEWS is defined.
USE_PGP
	Define this if you have PGP support.  This will enable messages
	encrypted for the remailer to be decrypted and will enable
	the Encrypt-Key header.  Set to YES if you want it, NO if you do not.
ALLOW_WWW
	Define this if you have the CERN line mode WWW browser or Lynx and
	you want to support the Get-URL: and Get-HTML-Source: headers.
DEBUG
	Define this if you want the remailer to spit comments about what it
	is doing to stdout.  I used this to watch it as it ran; you probably
	want to set it to NO.

CERN, LYNX
	Define one of this if you set ALLOW_WWW to yes.  Define CERN if
	you want to use the CERN line mode browser and LYNX if you want
	to use Lynx.  ONLY DEFINE ONE OF THESE.  Comment out or delete
	the one that you do not want to use!

REG_EXP_BLOCKING
	Define this if you want regular expression blocking.  The GNU Rx
	library is recommended, but you will have to change util2.c to
	#include <rxposix.h> instead of <rx.h> if you use Rx.  If you do
	NOT want regular expression blocking, comment this out or #undef
	it.  This is not a YES/NO option like the above three.  See also
	README.blocking.

SIZE_LIMIT
	Define this if you want a size limit for incoming remailer messages.

DEFAULT_LATENCY
	Define this if you want to queue incoming messages if more than one
	remailer process is running at the same time.  If you don't define
	it, a default latency "+0:00" will be used.  Without queuing, the
	remailer would lose messages under high load, when several PGP
	processes try to write PGP_DIR/randseed.bin simultaneously and fail.

REMAILER_DIR	The base directory of your remailer installation
QUEUE_DIR	The directory to use to hold queued latent messages
PGP_DIR		The directory where your remailer's PGP 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
PGP		The path to your PGP program
INEWS		The path to your inews program
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.
WWW_BROWSE	The path to the CERN line-mode WWW browser or Lynx.  Only
		necessary if you defined ALLOW_WWW to YES.  Make sure the
		browser this points to corresponds with whether you
		defined CERN or LYNX above.
PASS_PHRASE	The PGP pass phrase for your remailer's secret key
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
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
SUBJ_BLOCK	The name of the file containing subjects/partial
		subjects you want to block
GROUP_BLOCK	The name of the file containing Usenet news groups
		that you want to block
URL_BLOCK	The name of the file containing URL's that you want to block
HDRFILTER	The name of the file containing headers that
		you don't want in outgoing messages
PGP_KEY_FILE	The file containing your remailer's PGP public key
REMAILER_NAME	The long name of your remailer (as in its PGP key)
REMAILER_ADDR	The real e-mail address of your remailer
ANON_NAME	The long name to be used in remailed messages
ANON_ADDR	The e-mail address in the `From:' header of remailed messages
COMPLAINTS_TO	The e-mail address you want complaints about your remailer to
		be sent to
DISCLAIMER	The disclaimer header to be added to each anonymous message
ORGANIZATION	What to put in the Organization: line on anonymous Usenet
		posts

3. Type 'make'.  This should build a program called "remailer".

4. Make sure that all the files and paths you defined in config.h exist and
   are where you said they would be.  If you listed any directories that
   do not exist, create them.

5. Create a file called ".forward" in your home directory that contains a line
   like:
"|/users/me/freedom/remailer"
   where, obviously, you substitute the full path to the remailer program you
   just built.

   You can direct output of remailer to a file if you want.  There
   shouldn't be any output except possibly from PGP unless you defined
   DEBUG to YES, in which case the remailer will print some stuff.  
   To do this, you can put something like:
"|/users/me/freedom/remailer >> /users/me/remailer.messages"
   in your .forward file.

6. Create a PGP key for your remailer (pgp -kg) if you have not done so
   already.  Be sure to use the same pass phrase you compiled into the
   remailer.  Extract the key into an ascii file with whatever name you
   put in PGP_KEY_FILE so it can be mailed to those who request it.

7. Modify the help file as you see fit, add addresses/subjects to the block 
   files, etc.

8. The remailer doesn't run the latent message queue automatically.  To just
   run the latent message queue, you invoke "remailer" with the "-q" option.
   A sample crontab entry to run the latent message queue every 10 minutes
   looks like:
	*/10 * * * *        /your/directory/remailer -q

9. Run some tests.

10. Hopefully it passed the tests.  Yahoo.  You have a remailer.

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. 

- 1995 jfleming@indiana.edu
- 1997 hanne@squirrel.owl.de 
