-*- Indented-Text -*-
-:ts=8----------------------------------------------------------------
$Id: README,v 3.0 1993/08/12 10:48:56 mj Exp mj $
----------------------------------------------------------------------

			F  I  D  O  G  A  T  E
				 ----
		    Gateway Software UNIX <-> FIDO
				   
		      Installation Instructions

			     Version 3.0

----------------------------------------------------------------------

1. Edit `src/config.h'

	FIDONET addresses

	 o Your system:
	    REAL_ZONE, REAL_NET, REAL_NODE, REAL_POINT
		Your _real_ FIDO address (4D address for point systems)
	    MY_ZONE,   MY_NET,   MY_NODE,   MY_POINT
		Your fakenet FIDO address, if any. This is used for point
		systems, e.g. 2:242/6.1's fakenet address is 2:6000/1.
		Same as REAL_* for real FIDO nodes and 4D points.
	    PACKET_2PLUS
	    	Generate FIDO packet type 2+.
	    PACKET_PASSWD
	    	Passwort for FIDO packets. Must be exactly 8
		characters long, padded with \0 bytes.
	    PRODUCT_CODE
	    	Product code for FIDOGATE packets. Leave this as is.
	    ORIGIN
		Text inserted in origin line of FIDO EchoMail messages.

	 o Other systems:
	    REM_ZONE,  REM_NET,  REM_NODE,  REM_POINT
		FIDO address of your uplink (node system) or boss node
		(point system). This is also the address of your
		EchoMail feed.

	UNIX addresses

	 o Your system:
	    MY_HOSTNAME
		Internet address, hostname part.
	    MY_DOMAIN
		Internet address, domain part. Use ".uucp" if you don't have
		a domain address.

	 o FIDO domain:
	    FIDODOMAIN
		Standard domain for FIDONET addresses. ".fidonet.org" is
		the standard, so better leave this alone.
	    EXTRA_DOMAIN_1, EXTRA_DOMAIN_2
		More domains for FIDO addresses.


	Configuration:
	    LOCAL_FROM
		Uncomment this define if you want "local" From: lines 
		in your messages. This enables direct reply to someone on
		FIDONET via your gateway. Sample header:
		    From: martin_junius%f6.n242.z2@sungate.fido.de
		See file fido2rfc.c for details.
	    ERRORS_TO
		Uncomment this define if you want bounced mail send to
		someone other than the sender of the message. This
		generates an Errors-To: header in the output RFC
		message. Not all MTAs support this header (sendmail does).
	    ADD_DOMAIN
		Adds local domain to local addresses, e.g.
		  To: mj
		will be rewritten as
		  To: mj@sungate.fido.de
	    POSTMASTER
		Admin address, normally "postmaster".
	    MAUS_DE, MAUS_DOMAIN, MAUS_STRING,
	    MAUS_ZONE, MAUS_NET, MAUS_NODE, MAUS_POINT
		Enable special conversions of the addresses generated by
		the FIDONET<->MAUSNET gateway(s) in Germany. If you're not
		located in Germany you probably don't want to know about it.
	    FIDO_DE, FIDO_DE_DOMAIN, FIDO_DE_RESTRICTED
	        More special stuff. This enables code for the processing
	        of mail from nodes registered in the domain .fido.de,
		or any other internet domain. This features also
		includes conversion of hostnames to FIDO addresses via
		the hosts config file.
		FIDO_DE_RESTRICTED causes mail from/to FIDO nodes,
		which are not registered in hosts, to be bounced.
		
	Files (you probably do not want to change the names):
	    HOSTS
		Host name file for .fido.de.
	    ALIASES
		User name alias file.
	    AREAS
		Areas <-> newsgroups conversion file.
	    DOMAINS
		FTN zone <-> Internet domain config file.
	    LOG
		Log file.
	    SEQ_MAIL, SEQ_NEWS, SEQ_MSGID, SEQ_PKT
		ID sequencer files.

	Directories (you do not want to change them, either):
	    INBOUND
		Inbound directory for FTN packets.
	    INBOUND_MAIL, INBOUND_NEWS, INBOUND_BAD
		Subdirs of INBOUND for processed mail, news, and bad
		messages.
	    UNSECURE
		Unsecure inbound directory.
	    OUTBOUND
		Outbound directory for rfc2fido.

	The following lines in config.h should NOT be changed.

	Nevertheless, if your system requires some special setting for
	the file locking functions, have a look at the lines setting
	LOCK_LOCKF at the end of config.h.



2. Edit `src/Makefile'

	Directories:
	    LIBDIR
		Lib directory for FIDOGATE software.
	    SPOOLDIR
		Spool directory for FIDOGATE software.

	    SPOOLDIRS
		Subdirectories of SPOOLDIR, must be the same as in
		config.h.
	    LIBBINS
		Programs to be installed.
	    SETUIDBINS
		Programs to be installed with setuid OWNER.

	Owner/Group:
	    OWNER
	    GROUP
		Owner and group name for user/group id of the installed
		FIDOGATE software. rfc2fido is installed setuid OWNER.

	System:
	    SYSFLAGS
		-DUSG for System V, -DBSD for BSD Unix. (SUNOS needs
		-DBSD, LINUX -DUSG)

	Compiler:
	   CC
	   CFLAGS
	   LDFLAGS
	   LIBS
		As usual, your C compiler (e.g. cc or gcc), C compile
		options, link option and additional libraries (XENIX needs
		-lx).



3. Compiling and Installing FIDOGATE

	cd to the src/ directory and compile the beast by entering
	    make
	If everything works, you can install it in the configured
	directories:
	    make install.dirs
	creates the necessary directories. (Depending on your
	configuration you may want to create additional directories,
	see also the sample config files in directory install/.)
	    make install
	installs the binaries in LIBDIR and sets owner/group.

	Next cd to the lib/ directory of FIDOGATE, edit Makefile,
	changing the LIBDIR, SPOOLDIR, OWNER, GROUP if necessary.
	This directory contains the config files necessary for running
	FIDOGATE: aliases areas domains hosts. Edit these files to
	suit your needs, then type
	    make install
	to install the files in LIBDIR.



4. Integrating FIDOGATE and the news system

	CNews
	    The best way to integrate FIDOGATE and CNews is via the
	    batches mechanism. See directory install/ for a sample
	    configuration, containing the files from my setup. See
	    also install/README.
	    	    
	INN
	    Volunteers?



5. Integrating FIDOGATE and the mail system

	sendmail
	    Integration of FIDO mail and sendmail is relatively easy:
	    create a FIDO mailer (Mfido) and some rules in rule set R0
	    to send mail addressed to FIDO via this mailer. Again, see
	    directory install for a sample sendmail.cf from my setup
	    (SUNOS 4.1.1 sendmail).



6. Testing

	Copy a FIDO mail packet to the directory SPOOLDIR/in, then
	execute LIBDIR/fido2rfc as user OWNER. You can add some `-v'
	options to fido2rfc for verbose debug messages.

	This should result in one or more files named NNNNNNNN.msg in
	the directories SPOOLDIR/in/mail and SPOOLDIR/in/news. Have a
	look at them. Next execute LIBDIR/fidorun, this will feed
	those NNNNNNNN.msg files to rnews and rmail. After some
	processing you should find the messages in your mail folder
	and/or newsgroups.

	Grab a single news posting in a FIDO linked newsgroup and feed
	it to rfc2fido:
	    LIBDIR/rfc2fido -n <ARTICLE
	This should result in a FIDO mail packet NNNNNNNN.pkt in
	directory SPOOLDIR/out. Adding the option `-v' will generate
	verbose debug output (more -v's increase verbosity). Do the
	same with a mail message addressed to a FIDO recipient:
	    LIBDIR/rfc2fido USER_NAME@FIDO.ADRESS <MESSAGE
	Again you should get a packet NNNNNNNN.pkt in SPOOLDIR/out.

	If this is working and you have integrated FIDOGATE and
	mail/news, you can try posting an article to a FIDO linked
	newsgroups and/or mailing a message to a recipient on FIDONET.
	The resulting packets should be in SPOOLDIR/out.



7. Connecting with FIDO

	FIDOGATE does NOT include a FIDO mailer, so you have to
	transfer FIDO mail to and from the UNIX system by some other
	means.
	
	The solution I'm using is a separate PC running DOS and
	BinkleyTerm as a mailer. Currently the PC is a real FIDO node,
	online 24 hours a day, but in former times I've used it in a
	dual point setup. FIDO mail packets for the UNIX system are
	packed on the PC and transferred via Ethernet LAN and NFS to
	the UNIX machine. It's also possible to use UUCP for FIDO
	mail packet transfer.

	In the subdirectory xfer you'll find some some shell scripts
	and utilities to install such a link.

	Another solution is to get BinkleyTerm for UNIX, a FIDO
	mailer.



8. Additional information

	In the directory install/ you'll find configuration files from
	setup and some hints how to actually install FIDOGATE.

	Directory contrib/ contains some files and patches contributed
	by users of FIDOGATE, including some installation hints and
	patches for 4D point addressing. The patches are against
	previous versions of FIDOGATE (2.4 and 2.9alpha), so it may be
	necessary to apply them manually.

	Directory doc/ contains some additional documentation files.

	Directory fgate-digest/ contains messages from the fgate-users
	mailing list (German).

	Directory xfer/ contains the above mentioned NFS transfer
	utilities.



$Date: 1992/07/06 19:57:02 $, Martin Junius
--
 _____ _____
|     |___  |   Martin Junius            FIDO:      2:242/6.1
| | | |   | |   Republikplatz 3          Internet:  mj@sungate.fido.de
|_|_|_|@home|   D-52072 Aachen, Germany  Phone:     ++49-241-86931 (voice)
