
This package contains the support files for XRouter version 504k.

It does not contain the executables, because there are too many variations.


EXISTING SYSOPS
###############

If you are upgrading an existing XRouter system, all you NEED to do is replace the existing xrpi /xrlin / xrwin executable with the one from
this package. But please retain the existing one in case there are any issues with v504i.

Don't forget to chmod -x {progname} to make it executable.

It is also strongly recommended that you read the attached release notes, because there are a few new directives that should be added to XROUTER.CFG.

Finally, please replace the contents of your MAN and HELP folders with the updated files in this package.

NEW SYSOPS
##########

You can install and run XRouter anywhere you like, even on a USB stick. The choice of where to install it is completely up to you. If you change your mind, you can easily move it.

The installation process does not make any changes to your Linus or Windows configuration.


XRouter "Root" Directory
========================

All files and directories required by XRouter are located within a single directory, termed its "root" or "working" directory.

The name of this directory is not important, nor its its location.

All other directories used by XRouter are sub-directories of the XRouter "root" directory. See below for more details.


Installing The Files
====================

"Installation" is simply a matter of copying files from the downloaded archive into your chosen "root" directory.

Exactly how you do this depends on whether you are using CLI or desktop, and which file and archive managers you use. So we can only give you a rough guide.

Assuming you are using the Raspberry Pi desktop, locate the downloaded .zip archive and click it. The archiver window should open, showing the files in the archive.

Click Action->Extract, or click on the "Extract Files" icon. Enter a temporary destination directory in the "Extract to:" box.

Select the "All files" and "Extract files with full path" options, then click the "Extract" button.

If using a file manager, navigate to the temporary directory, then drag the "xrouter" directory to your chosen position. Rename the "xrouter" directory if you wish.

Alternatively, use the mv command in a terminal to move and rename the directory, e.g.

  sudo mv /home/pi/tmp/xrouter /home/pi/packet/xrpi 

The XRouter "root" directory should now have the tree structure shown below. Note some of the directories (e.g. LOG and CHAT) won't be created until XRouter runs. All directory names must be UPPER CASE.

XRouter Directory Tree
======================

          /             - XRouter "root", e.g. /home/pi/xrouter
          /CHAT/        - Chat server data files
          /FINGER/      - FINGER files
          /HELP         - HELP files
          /HELP/AMSG/   - Help for APRS messaging
          /HELP/CHAT/   - Help for chat server
          /HELP/FTP/    - Help for FTP server
          /HTTP/        - Root for HTTP server (see below)
          /INFO/        - INFO files
          /LOG/         - Activity log files
          /MAN/         - Sysop manual files
          /MISC/        - Miscellaneous files (see below)
          /PMS/         - Personal Message System data files

The HTTP directory is the only directory that may be relocated (using the HTTPROOT= keyword in XROUTER.CFG). This allows the HTML files to be located somewhere more convenient, e.g. an external drive.

The MISC directory is not used by XRouter. It contains assorted optional files which you may find useful.

Files in XRPi "root" Directory (* = mandatory)
==============================

    *.SCR	 	Dialler scripts.
    ACCESS.SYS	 	TCP/IP access control.
    BOOTCMDS.SYS	 	Boot up config commands.
    CRONTAB.SYS	 	Event control.
    DOMAIN.SYS	 	TCP/IP hostname resolution.
    DYNDNS.CFG	 	Dynamic DNS Configuration.
    ENCAP.TXT	 	IPENCAP routes.
    EXEC.HTM	 	Command template for HTTP server
    HTTP.ACL	 	HTTP Proxy Egress Control.
    HTTP.SYS	 	HTTP Rewrite / Proxy Control.
    HTTPBAN.SYS	 	HTTP URL block list.
    IGATE.CFG	 	APRS IGATE configuration.
    IPROUTE.SYS	 	IP routes / configuration.
    PASSWORD.SYS	 	Sysop passwords.
    PPPHOST.n	 	PPP configuration files.
    PPPLOG.TXT	 	PPP activity log.
    SOCKS.ACL	 	SOCKS proxy egress control.
    TELGUEST.ACL	 	Telnet "guest" mode egress control.
    TELPROXY.ACL	 	Telnet proxy egress control.
    TELPROXY.MSG	 	Telnet proxy welcome message.
    USERPASS.SYS	 	User passwords.
    XENCAP.TXT	 	Amprnet Encapsulated Routing File.
    xrpi	(*)	XRPi executable program.
    XRNODES	 	NetRom nodes / routes recovery file.
    XROUTER.CFG	(*)	XRPi Main Configuration File. 

The working directory should contain at least "xrpi" and XROUTER.CFG. All other files are optional and the system will run without them, albeit in a resricted mode.

Initial Testing
===============

This package contains a dummy configuration (XROUTER.CFG) which should allow you to start it up and get the feel of it.

But first you will need to make the XRouter file executable. Open a terminal window, navigate to the directory containing XRouter and use the chmod command as follows:

	chmod +x xrpi (substitute xrpi with yuor program name)

Ensure your terminal window is AT LEAST 80 characters wide by 25 rows, and adjust as necessary. Then start the program as follows:

	sudo ./xrpi (substitute xrpi with yuor program name)

Once you've got it running you can refine the config file. There's a fully anotated one in the MISC folder.

Note:
=====

THIS DOCUMENT IS A RUSH JOB! I will try to make it better. In the meantime, please see the website at https://ohiopacket.org/xrpi/docs which is out of date, but largely correct.

Please report any issues via the OARC Discord or Xrouter io groups.


