packet:xrpi:manpages:section8
Differences
This shows you the differences between two versions of the page.
packet:xrpi:manpages:section8 [2025/04/19 11:54] – created m0mzf | packet:xrpi:manpages:section8 [2025/04/19 18:00] (current) – removed m0mzf | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | =======Section 8 - Configuration and System Files======= | ||
- | =====ACCESS.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | ACCESS.SYS -- Telnet Access Control File. | ||
- | </ | ||
- | This optional file is read only at bootup. It specifies | ||
- | TCP/IP access requirements according to the caller' | ||
- | address. | ||
- | logins to require a valid callsign only. | ||
- | |||
- | </ | ||
- | The entries in ACCESS.SYS are of the form: | ||
- | |||
- | < | ||
- | |||
- | e.g. " | ||
- | |||
- | The < | ||
- | addresses from whom Telnet connects will be accepted, and | ||
- | < | ||
- | subnet. | ||
- | |||
- | The [bits] parameter specifies how many bits, from left to | ||
- | right, of the source address should be matched against the | ||
- | corresponding < | ||
- | will test the source IP address against the left-most 16 | ||
- | bits of 44.131.0.0, i.e. it will match any source address | ||
- | beginning with 44.131. And 0.0.0.0/0 will match any IP | ||
- | address, which is useful for specifying the default. The | ||
- | chosen match will be the one with the highest [bits] value. | ||
- | If [bits] is not specified, it defaults to 32, i.e. an exact | ||
- | match is required. | ||
- | |||
- | The < | ||
- | |||
- | 1 Valid callsigns only | ||
- | 2 | ||
- | 4 Guest access allowed | ||
- | 8 This IP address [range] is trusted | ||
- | |||
- | Typical combinations are as follows: | ||
- | |||
- | 0 - Any " | ||
- | no password is required. | ||
- | could be a user name. This is a zero security option, | ||
- | for use only for the sysop' | ||
- | secure subnets. | ||
- | |||
- | 1 - The user is required to enter a valid amateur radio | ||
- | callsign, i.e. a string containing alphanumeric | ||
- | characters in the correct format, but no password is | ||
- | required. | ||
- | minimal inconvenience, | ||
- | amateur radio subnets which are not connected to the | ||
- | | ||
- | who have 44.x.x.x source address, as they are presumed | ||
- | to have entered the network via radio, or via a | ||
- | password-protected gateway. | ||
- | |||
- | 2 - XRouter will accept any " | ||
- | character, providing a valid password is given. | ||
- | a medium security configuration, | ||
- | private wire subnets where amateur radio callsigns are | ||
- | not used. | ||
- | |||
- | 3 - Both a valid amateur radio callsign and a matching | ||
- | password must be supplied. This configuration is | ||
- | recommended for use at the Internet-to-Amprnet interface, | ||
- | i.e. for all source IP addresses other than 44.x.x.x | ||
- | |||
- | 4 - Any " | ||
- | no password is requested or required. All users have | ||
- | guest access, ie they cannot downlink. | ||
- | |||
- | 5 - The user is required to enter a valid amateur radio | ||
- | callsign, but no password is requested or required. All | ||
- | users have guest access, ie they cannot downlink. | ||
- | |||
- | 6 - Any " | ||
- | User is challenged to enter a password, but the option | ||
- | to use the password " | ||
- | gives a valid password he gets full access, but if he | ||
- | answers with " | ||
- | |||
- | 7 - The user is required to enter a valid amateur radio | ||
- | callsign, and he is challenged to enter a password, but | ||
- | the option to use the password " | ||
- | the user gives a valid password he gets full access, but | ||
- | if he answers with " | ||
- | This setting is recommended for source addresses which | ||
- | aren't either private LAN or 44.x.x.x. | ||
- | |||
- | 8 - The specified address [range] is to be treated in the same | ||
- | way as a " | ||
- | AGWHOST etc from requiring authorisation when used via a | ||
- | VPN. This flag DOES NOT affect Telnet and FTP logins. | ||
- | |||
- | </ | ||
- | # Subnet[/ | ||
- | # ============================== | ||
- | # | ||
- | # HTTP/RHP from this VPN subnet do not require authorisation | ||
- | 207.221.31.0/ | ||
- | # | ||
- | # Amprnet users need only supply a callsign | ||
- | 44.0.0.0/ | ||
- | # | ||
- | # LAN users need only supply a callsign | ||
- | 192.168.0.0/ | ||
- | # | ||
- | # Everyone else must supply callsign and password, but | ||
- | # " | ||
- | 0.0.0.0/ | ||
- | |||
- | |||
- | </ | ||
- | Guest access is intented to let people look around, but not | ||
- | to do anything that would cause a transmission to be made. | ||
- | |||
- | | ||
- | | ||
- | | ||
- | by the rules in the file TELGUEST.ACL. If that file is not | ||
- | | ||
- | |||
- | | ||
- | be hams who don't yet have a password for your system. | ||
- | |||
- | </ | ||
- | If passwords are required for user access, they should be | ||
- | located in file USERPASS.SYS, | ||
- | telnet (port 23) logins. | ||
- | |||
- | Do not confuse this with PASSWORD.SYS, | ||
- | sysop logins via AX25, Rlogin and FTP. | ||
- | |||
- | </ | ||
- | PASSWORD.SYS(8) -- Sysop passwords file | ||
- | TELGUEST.ACL(8) -- Telnet egress control file | ||
- | USERPASS.SYS(8) -- User passwords file | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====BADWORDS.SYS.MAN===== | ||
- | < | ||
- | |||
- | </ | ||
- | BADWORDS.SYS -- Bad Words File for Mailbox. | ||
- | |||
- | </ | ||
- | BADWORDS.SYS is an optional file, used by the mailbox to | ||
- | check new mail for inapproriate content. If present, it is | ||
- | located in the PMS subdirectory. | ||
- | |||
- | It contains a list of words or part-words, one per line, | ||
- | which are deemed unacceptable in Packet mail. If any of the | ||
- | words are matched in the text of a new message, the message | ||
- | is held for review. Held messages are not forwarded, and are | ||
- | only visible to sysops. | ||
- | |||
- | Wildcards are allowed, but " | ||
- | a word. | ||
- | |||
- | Only single words are allowed at present, no phrases. Words | ||
- | are not case-sensitive. | ||
- | |||
- | Comment lines must begin with hash (#) or semicolon (;) in | ||
- | the leftmost column. | ||
- | |||
- | The supplied file dates from the 1990s, and will probably | ||
- | need updating or replacing with words appropriate to your own | ||
- | language. | ||
- | |||
- | If the file is not present, mail is not checked. | ||
- | |||
- | </ | ||
- | False matches sometimes occur. For example " | ||
- | the place name Scunthorpe. This issue may be fixed in a future | ||
- | version. | ||
- | |||
- | </ | ||
- | LH(4) -- List Held Mail | ||
- | KH(4) -- Kill Held Mail | ||
- | UH(4) -- Un-hold Mail | ||
- | PMS(9) -- About the Mailbox | ||
- | | ||
- | </ | ||
- | ---- | ||
- | =====BOOTCMDS.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | BOOTCMDS.SYS -- Commands to Execute at Bootup. | ||
- | |||
- | </ | ||
- | This optional file is read by XRouter at boot time, after | ||
- | XROUTER.CFG and IPROUTE.SYS. | ||
- | configuration commands that have no keywords in XROUTER.CFG, | ||
- | such as the GNET and PPP commands. | ||
- | |||
- | </ | ||
- | Format is exactly the same as keyboard-entered commands, | ||
- | with one command per line. Lines beginning with '#' | ||
- | are ignored, and may be used for comments. | ||
- | |||
- | </ | ||
- | Whilst many commands *can* be used in BOOTCMDS.SYS, | ||
- | often no point in doing so, because they duplicate the | ||
- | function of configuration directives. For example there' | ||
- | point including " | ||
- | put PACLEN=120 in the port 3's configuration block. However, | ||
- | most of the commands listed below can also be used in | ||
- | CRONTAB.SYS, | ||
- | |||
- | Commands that can be used in BOOTCMDS.SYS are as follows: | ||
- | |||
- | ACL, APPLMASK, ARP, BCAST, BELL, BLEVEL, CAPTURE, CFLAGS, | ||
- | CTEXT, CTFLAGS, CTRL, DIAL, DHCP, DIGIFLAG, DIGIPORT, DNS, | ||
- | DUN, EXCLUDE, EXIT, FEC, FRACK, FULLDUP, GNET, ID, IDPATH, | ||
- | IDS, IDTEXT, IFACE, IPADDRESS, IPLINK, LOADNODES, LOG, | ||
- | MAXFRAME, MDIR, MFROM, MHCLEAR, MHFLAGS, MHSIZE, MINQUAL, | ||
- | MINTXQUAL, MMASK, MON, MPORT, MQTT, MTO, NAT, NETMASK, | ||
- | NODESINT, NOTIFY, ODN, PACLEN, PCAP, PEERS, PERSIST, PING, | ||
- | PIPE, PIPEFLAG, PORT, PPP, QUALITY, RESPTIME, RESTART, | ||
- | RETRIES, RIP, ROUTE, SAVENODES, SEND, SHELL, SLOTTIME, START, | ||
- | STATS, STOP, TCP, TSYNC, TXDELAY, TXOK, TXPORT, TXTAIL, UDP, | ||
- | UDPLOCAL, UDPREMOTE, UNPROTO, USERS, WAIT, WX. | ||
- | |||
- | </ | ||
- | # This is a comment line | ||
- | GNET ADDR 131.91.1.1 | ||
- | GNET ROUTE ADD 147.38.1.1 zl2aqy | ||
- | |||
- | </ | ||
- | CRONTAB.SYS(8) -- Event Control File. | ||
- | XROUTER.CFG(8) -- Main Configuration File. | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====CRONTAB.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | CRONTAB.SYS -- Event Control File (optional). | ||
- | |||
- | </ | ||
- | This optional file allows XRouter commands to be executed at | ||
- | certain times of the day, week, month or year. | ||
- | |||
- | A few of the possible uses would be: | ||
- | |||
- | - Additional AX25 beacons. | ||
- | - Beaconning APRS objects, status, bulletins and | ||
- | announcements. | ||
- | - Adjusting Netrom / IP routing to account for part-time | ||
- | neighbours. | ||
- | - Enabling / disabling transmitters. | ||
- | - Controlling peripherals via the CTRL port. | ||
- | - Adjusting parameters to cope with diurnal propogation | ||
- | changes. | ||
- | - Loading updated ENCAP.TXT at intervals. | ||
- | - Enabling / disabling IGATE at certain times of day / week. | ||
- | - Automatic reboots / restarts / exits for batch file | ||
- | processing etc. | ||
- | |||
- | When commands are executed, all responses from the command | ||
- | processor are discarded. | ||
- | |||
- | </ | ||
- | Commands that can be used in CRONTAB.SYS are as follows: | ||
- | |||
- | ACL, APPLMASK, ARP, BCAST, BELL, BLEVEL, CAPTURE, CFLAGS, | ||
- | CTEXT, CTFLAGS, CTRL, DIAL, DHCP, DIGIFLAG, DIGIPORT, DNS, | ||
- | DUN, EXCLUDE, EXIT, FEC, FRACK, FULLDUP, GNET, ID, IDPATH, | ||
- | IDS, IDTEXT, IFACE, IPADDRESS, IPLINK, LOADNODES, LOG, | ||
- | MAXFRAME, MDIR, MFROM, MHCLEAR, MHFLAGS, MHSIZE, MINQUAL, | ||
- | MINTXQUAL, MMASK, MON, MPORT, MQTT, MTO, NAT, NETMASK, | ||
- | NODESINT, NOTIFY, ODN, PACLEN, PCAP, PEERS, PERSIST, PING, | ||
- | PIPE, PIPEFLAG, PORT, PPP, QUALITY, RESPTIME, RESTART, | ||
- | RETRIES, RIP, ROUTE, SAVENODES, SEND, SHELL, SLOTTIME, START, | ||
- | STATS, STOP, TCP, TSYNC, TXDELAY, TXOK, TXPORT, TXTAIL, UDP, | ||
- | UDPLOCAL, UDPREMOTE, UNPROTO, USERS, WAIT, WX. | ||
- | |||
- | </ | ||
- | Each entry is specified on a seperate line. Empty lines, | ||
- | and lines beginning with '#' | ||
- | |||
- | Entries have the following format: | ||
- | |||
- | <min> < | ||
- | 0-59 | ||
- | |||
- | Fields must be seperated by one or more spaces or tabs. | ||
- | |||
- | < | ||
- | the current time, and either the < | ||
- | or <day> (of week) match. [args] specifies the command' | ||
- | argument(s). | ||
- | |||
- | Dates / times may be specified as single numbers, multiple | ||
- | numbers, ranges, or a mixture thereof, e.g. " | ||
- | Note there must be no spaces within the string of characters. | ||
- | |||
- | Use ' | ||
- | |||
- | </ | ||
- | ; <min> < | ||
- | ; Every 20 mins, advertise the BBS using an APRS symbol | ||
- | ; on port 13 | ||
- | 0,20,40 * * * * send 13 APZ179 !5224.00N/ | ||
- | |||
- | ; Every Thursday at 03:05 save nodes table to an archive | ||
- | 5 3 * * 4 SAVENODES PZTNODES.ACV | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====DEUTSCHE.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | DEUTSCHE.SYS -- German Language Texts for XRouter. | ||
- | |||
- | </ | ||
- | DEUTSCHE.SYS is an optional file containing german language | ||
- | texts for use within XRouter. | ||
- | |||
- | If present in the same directory as the XRouter executable, | ||
- | the contents of this file are read at bootup only, adding | ||
- | German prompts, headings and responses for those who select | ||
- | the German language option. | ||
- | |||
- | If this file is not present, XRouter defaults to ENGLISH. | ||
- | |||
- | If you can improve on the translation, | ||
- | please share your work. | ||
- | |||
- | Be careful with modifications, | ||
- | used in multiple places, and some of them are column headers | ||
- | which need to follow a strict format. | ||
- | |||
- | Modifications to this file do not affect other languages. | ||
- | |||
- | </ | ||
- | Each text is on a separate line, which begins with a number | ||
- | corresponding to that text. Following the number is some | ||
- | whitespace, then the text itself is enclosed in quotes. | ||
- | example: | ||
- | |||
- | 12 " | ||
- | |||
- | Most texts end with " | ||
- | all of them do. " | ||
- | |||
- | Blank lines, and lines which begin with '#' | ||
- | column are ignored. The latter can be used for comments. | ||
- | |||
- | Some texts contain one or more placeholders such as " | ||
- | " | ||
- | you change them, you will cause XRouter to crash. | ||
- | |||
- | For example, you could safely re-word the following: | ||
- | |||
- | 73 " | ||
- | |||
- | to the following: | ||
- | |||
- | 73 "No puedo encontrar la sesión %d\r" | ||
- | |||
- | " | ||
- | " | ||
- | |||
- | Changes don't take effect unless XRouter is restarted. | ||
- | |||
- | Text numbers fall into the following ranges: | ||
- | |||
- | 1-999 General texts | ||
- | 1000 PZTDOS texts | ||
- | 2000 AX25/NetRom texts | ||
- | 3000 Chat server texts | ||
- | 4000 APRS Messaging System Texts | ||
- | 5000 FTP Client texts | ||
- | 6000 PMS Texts | ||
- | 7000 IDS (Intrusion Detection System) texts | ||
- | |||
- | If a required text is not found in the file (e.g. it has | ||
- | been deleted or commented out), the inbuilt English text is | ||
- | used instead. | ||
- | |||
- | </ | ||
- | CONSOLELANG(7) | ||
- | DEFAULTLANG(7) | ||
- | ENGLISH.SYS(8) | ||
- | ESPANOL.SYS(8) | ||
- | FRANCAIS.SYS(8) -- French Language Texts | ||
- | LANGS.SYS(8) | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====DISTRIB.SYS.MAN===== | ||
- | < | ||
- | |||
- | </ | ||
- | DISTRIB.SYS -- Mail Distribution File. | ||
- | |||
- | </ | ||
- | Optional file DISTRIB.SYS controls queuing of mail for | ||
- | delivery to neighbouring mailboxes. | ||
- | |||
- | If present, it is located in XRouter' | ||
- | the file is absent, mail is not delivered to other mailboxes. | ||
- | |||
- | The file is read " | ||
- | " | ||
- | with modificatiions taking immediate effect. | ||
- | |||
- | </ | ||
- | Lines must not exceed 127 characters. Comment lines are | ||
- | allowed. These must start with '#' | ||
- | |||
- | DISTRIB.SYS contains " | ||
- | are no rules, there can be no mail forwarding | ||
- | |||
- | Each " | ||
- | fields on a single line. The fields, which may be separated | ||
- | by spaces or tabs, are as follows: | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | If the <to> field starts with a caret ' | ||
- | the message if it matches. e.g. " | ||
- | distribution of EQUAKE messages. | ||
- | |||
- | < | ||
- | This is a " | ||
- | GBR matches .# | ||
- | alllowed in this field except for " | ||
- | meaning "match any". | ||
- | |||
- | < | ||
- | which the item of mail should be sent. | ||
- | |||
- | [max_size] is optional. If present, it specifies the maximum | ||
- | | ||
- | this value are not queued. | ||
- | |||
- | </ | ||
- | Each new message is tested against the rules, looking for a | ||
- | matching rule. If < | ||
- | of the message, the latter is placed on the queue for the | ||
- | mailbox specified by < | ||
- | according to the rules in FWD.SYS. | ||
- | |||
- | Rules are processed in the sequence in which they are | ||
- | declared. Therefore " | ||
- | " | ||
- | |||
- | Private mail is queued for the FIRST match only. | ||
- | Bulletins are distributed to ALL matching entries. | ||
- | |||
- | </ | ||
- | The organisation of this file is up to you, but the following | ||
- | method is recommended. | ||
- | |||
- | Firstly, route any private mail addressed TO nearby sysops | ||
- | and users. This ensures delivery even if the hierarchical | ||
- | address is wrong: | ||
- | |||
- | # < | ||
- | # -------------------------------------------------- | ||
- | P VA2OM | ||
- | P VE2PKT | ||
- | P MW0NXT | ||
- | |||
- | Next, handle mail explicitly addressed AT neighbour BBS's. | ||
- | Again, this guards against incorrect hierarchical addresses. | ||
- | |||
- | # < | ||
- | # -------------------------------------------------- | ||
- | * * | ||
- | * * | ||
- | * * | ||
- | |||
- | Finally, handle bulletin distribution. In this case, all | ||
- | EQUAKE bulletins are ignored. All remaining bulls go to | ||
- | VE2PKT, but only GBR, EU and WW are sent to GB7NXT. | ||
- | |||
- | # < | ||
- | # -------------------------------------------------- | ||
- | B ^EQUAKE * * | ||
- | B * | ||
- | B * | ||
- | B * | ||
- | B * | ||
- | |||
- | </ | ||
- | FWD.SYS(8) -- Mailbox Forwarding Control File | ||
- | PMS(9) | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====DOMAIN.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | DOMAIN.SYS -- Hostname Resolution File. | ||
- | |||
- | </ | ||
- | This optional file is used to " | ||
- | " | ||
- | corresponding IP addresses. | ||
- | |||
- | It is the first place XRouter looks when resolving a hostname. | ||
- | If the file is not present, or the hostname is not found in | ||
- | in the file, XRouter queries a DNS (Domain Name Server) to | ||
- | obtain the information (in order for this to work, either | ||
- | Windows/ | ||
- | external DNS). | ||
- | |||
- | If no DNS is available, and the hostname is not found in | ||
- | DOMAIN.SYS, you will have to enter the full IP address of | ||
- | the target host when using the PING, TELNET, TTY, and FINGER | ||
- | commands. | ||
- | |||
- | Name resolution using a radio-based DNS is quite slow, so if | ||
- | you are using this mode you should add entries to this file | ||
- | for frequently contacted hosts whose addresses are stable. | ||
- | |||
- | Externally resolved names are added automatically to | ||
- | DOMAIN.SYS at regular intervals, and expired entries are | ||
- | purged. | ||
- | |||
- | </ | ||
- | Each host is listed on a separate line. Each field must be | ||
- | separated by one or more spaces or tabs. Comments, spaces, | ||
- | tabs and blank lines are permissible to aid clarity. | ||
- | records are case-insensitive, | ||
- | for hostnames. | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | The first form maps a hostname to an IP address, and the | ||
- | second and third forms map alternative hostnames to a host | ||
- | that is already defined. | ||
- | |||
- | For example, the IP address for the GB7PZT mailbox is | ||
- | 44.131.91.2 so it would have an Internet Address (IN A) | ||
- | record like so: | ||
- | |||
- | | ||
- | |||
- | But gb7pzt is also known locally as " | ||
- | There is nothing to stop you adding further "IN A" records | ||
- | for gb7pzt, one for each alias, but you could instead use | ||
- | the second form shown above, the CNAME or " | ||
- | record like so: | ||
- | |||
- | | ||
- | | ||
- | |||
- | Thus if the user types "TEL pztbbs" | ||
- | gb7pzt record is used. This removes the need to keep | ||
- | repeating the IP address in multiple " | ||
- | it easier if the IP address is changed. | ||
- | |||
- | The MX or "Mail Exchange" | ||
- | defining alternate names for mail servers, but as XRouter is | ||
- | not concerned with mail you can use them in the same way as | ||
- | CNAME entries, although there would be no point in doing so. | ||
- | The format of the additional records would be: | ||
- | |||
- | | ||
- | | ||
- | |||
- | The optional " | ||
- | | ||
- | The optional [ttl] field in all types of entry is the | ||
- | "time to live" of the entry in seconds, used to expire | ||
- | records whose addresses are liable to change. | ||
- | set to zero, the record has an unlimited lifetime. | ||
- | |||
- | In order to simplify the file, the " | ||
- | omitted from the records, and appended automatically when | ||
- | the file is read. However, hostnames which contain or end | ||
- | with a dot will not be extended in this manner. | ||
- | " | ||
- | " | ||
- | |||
- | </ | ||
- | Although DOMAIN.SYS was originally designed to be simpler | ||
- | than the more standard DOMAIN.TXT format, Xrouter is capable | ||
- | of understanding both formats, so you may use an existing | ||
- | DOMAIN.TXT simply by renaming it to DOMAIN.SYS. | ||
- | |||
- | </ | ||
- | DOMAIN.SYS is located in the same directory as XRouter.EXE. | ||
- | |||
- | </ | ||
- | XRouter' | ||
- | queries. | ||
- | |||
- | </ | ||
- | DNS(1) -- DNS Configuration Commands. | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====DYNDNS.CFG.MAN===== | ||
- | < | ||
- | </ | ||
- | DYNDNS.CFG -- Dynamic DNS Update Client Configuration File. | ||
- | |||
- | </ | ||
- | This optional file is used by the Dynamic DNS Update Client, | ||
- | and contains information about your account, the address(es) | ||
- | you wish to update, and the method of update. | ||
- | |||
- | If you are not using the client, you do not need this file. | ||
- | |||
- | </ | ||
- | The following is an example DYNDNS.CFG file: | ||
- | |||
- | ; DYNDNS.CFG: | ||
- | ; Configuration file for XRouter Dynamic DNS update client | ||
- | ; Do not delete or change the order of entries. | ||
- | ; | ||
- | ; Update server name | ||
- | members.dyndns.org | ||
- | ; | ||
- | ; IP detection server | ||
- | checkip.dyndns.org | ||
- | ; | ||
- | ; Account Name (put your own account name here) | ||
- | test | ||
- | ; | ||
- | ; Account Password (Put your password here) | ||
- | test | ||
- | ; | ||
- | ; System (dyndns, statdns or custom) | ||
- | ; (The latter two are only available on subscription.) | ||
- | dyndns | ||
- | ; | ||
- | ; Use external IP detection? (yes / no) | ||
- | ; This should be set to NO if Xrouter is directly connected | ||
- | ; to the Internet or YES if the Internet connection is via | ||
- | ; another router. | ||
- | NO | ||
- | ; | ||
- | ; Wildcard (ON / OFF) | ||
- | ; If this is set to ON, *.host.domain will be aliased to | ||
- | ; host.domain | ||
- | ON | ||
- | ; | ||
- | ; Hostname(s) to be updated, separated by commas. No spaces. | ||
- | ; (put your own hostname(s) here) | ||
- | test.ath.cx, | ||
- | ; | ||
- | |||
- | </ | ||
- | DYNDNS(9) -- Dynamic DNS Update Client | ||
- | |||
- | </ | ||
- | </ | ||
- | ---- | ||
- | =====ENCAP.TXT.MAN===== | ||
- | < | ||
- | </ | ||
- | ENCAP.TXT -- Amprnet Encapsulated Routing File (optional). | ||
- | |||
- | </ | ||
- | This is *not* an XRouter configuration file, but XRouter | ||
- | is capable of reading it. | ||
- | |||
- | ENCAP.TXT is simply a text file which contains a huge list | ||
- | of amateur IP routes and the Internet addresses of IPEncap | ||
- | gateways which handle them. | ||
- | |||
- | If this file is present when XRouter boots up, it will read | ||
- | the routes into its IP routing table. | ||
- | |||
- | If you are not running an amprnet " | ||
- | your own encap routes in IPROUTE.SYS, | ||
- | file. | ||
- | |||
- | </ | ||
- | The format of routing entries in ENCAP.TXT is as follows: | ||
- | |||
- | route addprivate 44.131.91.0/ | ||
- | |||
- | The " | ||
- | from users, i.e. not displayed by the IPROUTES command. | ||
- | |||
- | The " | ||
- | this entry applies to. | ||
- | |||
- | The " | ||
- | i.e. it is the same as using routing mode " | ||
- | |||
- | The final field is the Internet IP address of the gateway | ||
- | which handles the specified amprnet route(s). | ||
- | |||
- | </ | ||
- | If required. ENCAP.TXT should be located in same directory | ||
- | as the XRouter executable. | ||
- | |||
- | </ | ||
- | ENCAP.TXT is subject to frequent modification, | ||
- | need to obtain updated copies from time to time, and use | ||
- | IP ROUTE LOAD (or restart XRouter) to load them. A batch | ||
- | file to obtain and edit the ENCAP.TXT can be run by the | ||
- | Windows / Linux task scheduler, and IP ROUTE LOAD can then | ||
- | be called afterwards by a suitable entry in CRONTAB.SYS. | ||
- | |||
- | </ | ||
- | On Windows, it is NOT possible to use " | ||
- | without using the NDISXPKT driver. Without the driver, XR32 | ||
- | is forced to use the Windows IP stack, instead of its own, | ||
- | for accessing the Internet. The problem is, Windows no longer | ||
- | allow IPEncap to pass via it's IP stack. The protocol was | ||
- | blocked for " | ||
- | service pack 2. It should work on Windows 2000 and early | ||
- | versions of XP however. There are no such restrictions on | ||
- | Linux. | ||
- | |||
- | If you are a gateway, you must remove your own entry from | ||
- | ENCAP.TXT before loading it, otherwise catastrophic | ||
- | looping will occur (this may have been fixed in later | ||
- | versions). | ||
- | |||
- | ENCAP.TXT contains over 500 entries, and may make your IP | ||
- | routing slower, because all those routes must be searched | ||
- | recursively for every single datagram routed by your | ||
- | system. | ||
- | probably wouldn' | ||
- | |||
- | </ | ||
- | IPEncap (usually called " | ||
- | called IPIP) " | ||
- | public (Internet) IP datagrams. Thus it is sometimes called | ||
- | IP-over-IP or IP-within-IP, | ||
- | because that is an older version of the protocol. Encap is | ||
- | assigned IP protocol number 4, and IPIP is protocol 94. | ||
- | |||
- | Encapsulation allows amateur IP (44.x.x.x addresses) to be | ||
- | " | ||
- | amprnet gateways. In order to do this, each gateway needs to | ||
- | know the Internet addresses of the other gateways, and which | ||
- | amprnet datagrams shoule be sent to which gateway. | ||
- | information is located in ENCAP.TXT. | ||
- | |||
- | In order to keep the amprnet secure, the gateway owners need | ||
- | to prevent their IP addresses from becoming public knowledge. | ||
- | Thus the contents of ENCAP.TXT are a closely guarded secret. | ||
- | The file is obtained from an FTP server whose address is | ||
- | known only to the gateway sysops. | ||
- | |||
- | </ | ||
- | IPENCAP(9) | ||
- | IPROUTE.SYS(8) -- IP Routing and Configuration File | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====ENGLISH.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | ENGLISH.SYS -- English Language Texts for XRouter. | ||
- | |||
- | </ | ||
- | ENGLISH.SYS is an optional file containing English Language | ||
- | Texts which are used within XRouter. | ||
- | |||
- | If present, the contents of this file are read at bootup | ||
- | only, replacing XRouter' | ||
- | responses. | ||
- | |||
- | XRouter' | ||
- | change the layout and/or wording of most XRouter responses by | ||
- | installing ENGLISH.SYS in the same directory as XRouter. | ||
- | XRouter will then use the texts from that file, which you may | ||
- | modify, instead of the inbuilt ones. | ||
- | |||
- | Be careful with modifications, | ||
- | used in multiple places, and some of them are column headers | ||
- | which need to follow a strict format. Installing and | ||
- | modifying this file is NOT recommended, | ||
- | |||
- | Modifications to this file do not affect other languages. | ||
- | |||
- | </ | ||
- | Each text is on a separate line, which begins with a number | ||
- | corresponding to that text. Following the number is some | ||
- | whitespace, then the text itself is enclosed in quotes. | ||
- | example: | ||
- | |||
- | 12 " | ||
- | |||
- | Most texts end with " | ||
- | all of them do. " | ||
- | |||
- | Blank lines, and lines which begin with '#' | ||
- | column are ignored. The latter can be used for comments. | ||
- | |||
- | Some texts contain one or more placeholders such as " | ||
- | " | ||
- | you change them, you will cause XRouter to crash. | ||
- | |||
- | For example, you could safely re-word the following: | ||
- | |||
- | 73 " | ||
- | |||
- | to the following: | ||
- | |||
- | 73 " | ||
- | |||
- | " | ||
- | " | ||
- | |||
- | Changes don't take effect unless XRouter is restarted. | ||
- | |||
- | Text numbers fall into the following ranges: | ||
- | |||
- | 1-999 General texts | ||
- | 1000 PZTDOS texts | ||
- | 2000 AX25/NetRom texts | ||
- | 3000 Chat server texts | ||
- | 4000 APRS Messaging System Texts | ||
- | 5000 FTP Client texts | ||
- | 6000 PMS Texts | ||
- | 7000 IDS (Intrusion Detection System) texts | ||
- | |||
- | If a required text is not found in the file (e.g. it has | ||
- | been deleted or commented out), the inbuilt text is used | ||
- | instead. | ||
- | |||
- | </ | ||
- | CONSOLELANG(7) | ||
- | DEFAULTLANG(7) | ||
- | DEUTSCHE.SYS(8) -- German Language Texts. | ||
- | ESPANOL.SYS(8) | ||
- | FRANCAIS.SYS(8) -- French Language Texts. | ||
- | LANGS.SYS(8) | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====ESPANOL.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | ESPANOL.SYS -- Spanish Language Texts for XRouter. | ||
- | |||
- | </ | ||
- | ESPANOL.SYS is an optional file containing Spanish language | ||
- | texts for use within XRouter. | ||
- | |||
- | If present in the same directory as the XRouter executable, | ||
- | the contents of this file are read at bootup only, adding | ||
- | Spanish prompts, headings and responses for those who select | ||
- | the Spanish language option. | ||
- | |||
- | If this file is not present, XRouter defaults to ENGLISH. | ||
- | |||
- | If you can improve on the translation, | ||
- | please share your work. | ||
- | |||
- | Be careful with modifications, | ||
- | used in multiple places, and some of them are column headers | ||
- | which need to follow a strict format. | ||
- | |||
- | Modifications to this file do not affect other languages. | ||
- | |||
- | </ | ||
- | Each text is on a separate line, which begins with a number | ||
- | corresponding to that text. Following the number is some | ||
- | whitespace, then the text itself is enclosed in quotes. | ||
- | example: | ||
- | |||
- | 12 " | ||
- | |||
- | Most texts end with " | ||
- | all of them do. " | ||
- | |||
- | Blank lines, and lines which begin with '#' | ||
- | column are ignored. The latter can be used for comments. | ||
- | |||
- | Some texts contain one or more placeholders such as " | ||
- | " | ||
- | you change them, you will cause XRouter to crash. | ||
- | |||
- | For example, you could safely re-word the following: | ||
- | |||
- | 73 " | ||
- | |||
- | to the following: | ||
- | |||
- | 73 " | ||
- | |||
- | " | ||
- | " | ||
- | |||
- | Changes don't take effect unless XRouter is restarted. | ||
- | |||
- | Text numbers fall into the following ranges: | ||
- | |||
- | 1-999 General texts | ||
- | 1000 PZTDOS texts | ||
- | 2000 AX25/NetRom texts | ||
- | 3000 Chat server texts | ||
- | 4000 APRS Messaging System Texts | ||
- | 5000 FTP Client texts | ||
- | 6000 PMS Texts | ||
- | 7000 IDS (Intrusion Detection System) texts | ||
- | |||
- | If a required text is not found in the file (e.g. it has | ||
- | been deleted or commented out), the inbuilt English text is | ||
- | used instead. | ||
- | |||
- | </ | ||
- | CONSOLELANG(7) | ||
- | DEFAULTLANG(7) | ||
- | DEUTSCHE.SYS(8) -- German Language Texts. | ||
- | ENGLISH.SYS(8) | ||
- | FRANCAIS.SYS(8) -- French Language Texts. | ||
- | LANGS.SYS(8) | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====EXEC.HTM.MAN===== | ||
- | < | ||
- | </ | ||
- | EXEC.HTM -- Command Template for HTTP Server. | ||
- | |||
- | </ | ||
- | This optional file is a " | ||
- | server. | ||
- | |||
- | When the server receives a request whose URL begins with | ||
- | "/ | ||
- | execution, and serves a " | ||
- | response to the command. | ||
- | for the text. | ||
- | |||
- | If you wish to override XRouter' | ||
- | the file EXEC.HTM, which was supplied with the installation | ||
- | package, and put it in the XRouter working directory. This | ||
- | file is not placed within the HTTP directory tree because it | ||
- | is not intended to be served in the normal way. | ||
- | |||
- | If EXEC.HTM exists, the server will serve it in place of the | ||
- | inbuilt template, replacing the < | ||
- | the executed command. | ||
- | Server Side Includes. | ||
- | |||
- | </ | ||
- | HTTP-SRV(9) -- HTTP Server. | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====EXPORT.SYS.MAN===== | ||
- | < | ||
- | |||
- | </ | ||
- | EXPORT.SYS -- Mail Export Control File. | ||
- | |||
- | </ | ||
- | The optional file EXPORT.SYS, which resides in the PMS | ||
- | subdirectory, | ||
- | |||
- | It is read " | ||
- | be edited on the fly, and any edits take effect immediately. | ||
- | |||
- | Exporting can be used to archive selected messages, or to | ||
- | create files that can be imported into other mail systems. | ||
- | |||
- | </ | ||
- | Comment lines are allowed. These must begin with a semicolon | ||
- | or hash in the first column. | ||
- | |||
- | Lines beginning with ' | ||
- | messages are to be exported, and the file opening mode to use. | ||
- | |||
- | The mode is specified by a single (optional) character, which | ||
- | follows the filename, after a gap of one or more spaces: | ||
- | |||
- | O = overwrite | ||
- | |||
- | Overwrite mode would typically be used when only the most | ||
- | recent copy of a regular message, e.g. a weather report, was | ||
- | required | ||
- | |||
- | For all other lines, the fields are: | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | | ||
- | (F = as a file, M = MBL). | ||
- | |||
- | The optional second character determines routing | ||
- | | ||
- | |||
- | | ||
- | | ||
- | None = Don't include any R: lines | ||
- | |||
- | < | ||
- | |||
- | B = Bulletin, P = Private, A = Ack, 7 = 7plus, * = Any | ||
- | |||
- | The remaining fields specify which messages are to be | ||
- | exported, depending on any combination of TO, FROM, AT, MID | ||
- | or subject. | ||
- | |||
- | All fields are case-independent, | ||
- | However, the < | ||
- | the others. The supplied < | ||
- | than one word, is tested against all parts of the message | ||
- | subject, in a " | ||
- | both "RSGB Main News" and "DX News". The only wildcard allowed | ||
- | in the subject field is a single " | ||
- | |||
- | </ | ||
- | The following example exports TECH bulletins sent by G8MNY, | ||
- | to the file PMS/ | ||
- | and omitting all R: lines except the one generated by the | ||
- | original sender' | ||
- | |||
- | @PMS/ | ||
- | # < | ||
- | # | ||
- | | ||
- | |||
- | |||
- | The next example appends retro computing bulletins to the | ||
- | file " | ||
- | |||
- | @/ | ||
- | # < | ||
- | # | ||
- | | ||
- | | ||
- | | ||
- | |||
- | |||
- | The final example shows the use of " | ||
- | a copy of the latest DX News in the BBS files area as a file | ||
- | without any MBL headers or R: lines: | ||
- | |||
- | @FILES/ | ||
- | # < | ||
- | # | ||
- | | ||
- | |||
- | </ | ||
- | EXPORT(4) -- Export Message to File. | ||
- | IMPORT(4) -- Import Message(s) From File. | ||
- | PMS(9) | ||
- | | ||
- | </ | ||
- | ---- | ||
- | =====FILES.8.MAN===== | ||
- | < | ||
- | </ | ||
- | FILES -- Files And Directories Used By XRouter. | ||
- | |||
- | </ | ||
- | All files and directories required by the system are located | ||
- | within a single directory which can be located anywhere and | ||
- | have any name. For the purposes of this document it will be | ||
- | called the " | ||
- | directories used by XRouter are sub-directories of the | ||
- | working directory. | ||
- | |||
- | The working directory should contain at least the XRouter | ||
- | program and XROUTER.CFG. | ||
- | the system will run without them. | ||
- | |||
- | If you want to grant access to remote sysops you will need to | ||
- | add a suitably configured PASSWORD.SYS. | ||
- | IP, you will need IPROUTE.SYS. | ||
- | access, add ACCESS.SYS and USERPASS.SYS. | ||
- | specify hostnames for fast domain lookup, add DOMAIN.SYS. | ||
- | |||
- | If you add any of the above, you must edit them to suit your | ||
- | requirements. | ||
- | also a MAN file for each one. | ||
- | |||
- | If you want the full HELP system (recommended), | ||
- | sub-directory called HELP and place all the .HLP files into | ||
- | it. Note that the help for the CHAT server goes in | ||
- | sub-directory HELP/CHAT, FTP server help goes in HELP/FTP and | ||
- | the APRS messaging help goes in HELP/AMSG. | ||
- | |||
- | If you want an INFO system, create the INFO directory and | ||
- | populate it with .INF files. | ||
- | files included in the distribution package to give you some | ||
- | ideas. | ||
- | |||
- | If you want the online manual (recommended), | ||
- | directory and put the *.MAN files into it. | ||
- | |||
- | |||
- | Directory Tree | ||
- | ~~~~~~~~~~~~~~ | ||
- | |||
- | / - XRouter " | ||
- | / | ||
- | /HELP - English HELP files | ||
- | / | ||
- | / | ||
- | / | ||
- | / | ||
- | / | ||
- | / | ||
- | / | ||
- | /LOG/ - Activity log files | ||
- | /MAN/ - Sysop manual files | ||
- | |||
- | The LOG directory is created automatically when XRouter runs. | ||
- | |||
- | If logging is enabled, daily log files are created within the | ||
- | LOG directory. | ||
- | are also written to thr LOG directory. | ||
- | |||
- | The HTTP root directory may be relocated (using the HTTPROOT | ||
- | directive in XROUTER.CFG). | ||
- | located somewhere more convenient, even on another drive if | ||
- | required. | ||
- | |||
- | |||
- | Files in XRouter " | ||
- | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
- | |||
- | ACCESS.SYS | ||
- | BOOTCMDS.SYS | ||
- | CRONTAB.SYS | ||
- | DEUTSCH.SYS | ||
- | DOMAIN.SYS | ||
- | ENCAP.TXT | ||
- | ESPANOL.SYS | ||
- | FRANCAIS.SYS | ||
- | HTTP.ACL | ||
- | HTTP.SYS | ||
- | HTTPBAN.SYS | ||
- | IGATE.CFG | ||
- | IPROUTE.SYS | ||
- | LANGS.SYS | ||
- | NEDERLANDS.SYS - Dutch language file. | ||
- | PASSWORD.SYS | ||
- | PPPHOST.n | ||
- | PPPLOG.TXT | ||
- | SOCKS.ACL | ||
- | TELGUEST.ACL | ||
- | TELPROXY.ACL | ||
- | TELPROXY.MSG | ||
- | USERPASS.SYS | ||
- | * (XRouter) | ||
- | XRNODES | ||
- | * XROUTER.CFG | ||
- | |||
- | There are detailed MAN pages for each of the above files in | ||
- | section 8 of the manual. | ||
- | |||
- | </ | ||
- | XROUTER.CFG(8) -- Main Configuration File. | ||
- | IPROUTE.SYS(8) -- IP routes / configuration File. | ||
- | BOOTCMDS.SYS(8) -- Boot up configuraion Commands. | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====FRANCAIS.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | FRANCAIS.SYS -- French Language Texts for XRouter. | ||
- | |||
- | </ | ||
- | FRANCAIS.SYS is an optional file containing French language | ||
- | texts for use within XRouter. | ||
- | |||
- | If present in the same directory as the XRouter executable, | ||
- | the contents of this file are read at bootup only, adding | ||
- | French prompts, headings and responses for those who select | ||
- | the French language option. | ||
- | |||
- | If this file is not present, XRouter defaults to ENGLISH. | ||
- | |||
- | If you can improve on the translation, | ||
- | please share your work. | ||
- | |||
- | Be careful with modifications, | ||
- | used in multiple places, and some of them are column headers | ||
- | which need to follow a strict format. | ||
- | |||
- | Modifications to this file do not affect other languages. | ||
- | |||
- | </ | ||
- | Each text is on a separate line, which begins with a number | ||
- | corresponding to that text. Following the number is some | ||
- | whitespace, then the text itself is enclosed in quotes. | ||
- | example: | ||
- | |||
- | 12 " | ||
- | |||
- | Most texts end with " | ||
- | all of them do. " | ||
- | |||
- | Blank lines, and lines which begin with '#' | ||
- | column are ignored. The latter can be used for comments. | ||
- | |||
- | Some texts contain one or more placeholders such as " | ||
- | " | ||
- | you change them, you will cause XRouter to crash. | ||
- | |||
- | For example, you could safely re-word the following: | ||
- | |||
- | 73 " | ||
- | |||
- | to the following: | ||
- | |||
- | 73 "Je ne trouve pas la session %d\r" | ||
- | |||
- | " | ||
- | " | ||
- | |||
- | Changes don't take effect unless XRouter is restarted. | ||
- | |||
- | Text numbers fall into the following ranges: | ||
- | |||
- | 1-999 General texts | ||
- | 1000 PZTDOS texts | ||
- | 2000 AX25/NetRom texts | ||
- | 3000 Chat server texts | ||
- | 4000 APRS Messaging System Texts | ||
- | 5000 FTP Client texts | ||
- | 6000 PMS Texts | ||
- | 7000 IDS (Intrusion Detection System) texts | ||
- | |||
- | If a required text is not found in the file (e.g. it has | ||
- | been deleted or commented out), the inbuilt English text is | ||
- | used instead. | ||
- | |||
- | </ | ||
- | CONSOLELANG(7) | ||
- | DEFAULTLANG(7) | ||
- | DEUTSCHE.SYS(8) -- German Language Texts. | ||
- | ENGLISH.SYS(8) | ||
- | ESPANOL.SYS(8) | ||
- | LANGS.SYS(8) | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====FTPCLI.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | FTPCLI.SYS -- FTP Client Account File. | ||
- | |||
- | </ | ||
- | The FTPCLI.SYS file contains account and connection info | ||
- | used for automating logins to FTP servers. | ||
- | |||
- | </ | ||
- | The entries in ACCESS.SYS are of the form: | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | [port] is the TCP port number of the server. Default 21. | ||
- | |||
- | [username] is the the one required by the server. If not | ||
- | | ||
- | |||
- | [passwd] is the password associated with [username]. If | ||
- | not specified, the server will ask for it. | ||
- | |||
- | [account] may be required by some servers. | ||
- | |||
- | [timeout] is the maximum number of seconds to wait for a | ||
- | response to a command. Default is 20. | ||
- | |||
- | Use asterisk (*) as a placeholder for empty fields | ||
- | |||
- | </ | ||
- | stest speedtest.tele2.net anonymous anon | ||
- | gb3kc gb3kc.dyndns.org | ||
- | xrpi | ||
- | |||
- | </ | ||
- | FTP(1) -- Invoke Fie Transfer Protocol Client. | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====FWD.SYS.MAN===== | ||
- | < | ||
- | |||
- | </ | ||
- | FWD.SYS -- Mailbox Forwarding Control File. | ||
- | |||
- | </ | ||
- | The optional file FWD.SYS, which resides in the PMS folder, | ||
- | controls when & how queued mail is delivered to neighbours. | ||
- | |||
- | It is read " | ||
- | edited on the fly, and any edits take effect immediately. | ||
- | |||
- | </ | ||
- | Comment lines are allowed. They must begin with hash (#) or | ||
- | semicolon (;) in the leftmost column. | ||
- | |||
- | There is one " | ||
- | each neighbour BBS. | ||
- | |||
- | Each block starts with: " | ||
- | |||
- | < | ||
- | | ||
- | in DISTRIB.SYS. | ||
- | |||
- | < | ||
- | |||
- | F = Forward mail, if we have any to send | ||
- | P = Poll for mail even if we have none to send | ||
- | |||
- | The second line of each block specifies the days of the week | ||
- | (0=Sunday) on which forwarding to this neighbour is allowed. | ||
- | |||
- | For example: " | ||
- | |||
- | The third line of each block specifies the hours of the day | ||
- | during which forwarding to this neighbour is allowed | ||
- | |||
- | For example: " | ||
- | |||
- | Subsequent lines in the block are the " | ||
- | follows: | ||
- | |||
- | T < | ||
- | C < | ||
- | S < | ||
- | W < | ||
- | |||
- | Each " | ||
- | |||
- | </ | ||
- | # Forward and poll VE2PKT midnight to 8am, weekends only: | ||
- | # | ||
- | @VE2PKT FP | ||
- | 0,6 | ||
- | 0-8 | ||
- | C KIDDER | ||
- | C PKTXRP | ||
- | C VE2PKT | ||
- | ---------- | ||
- | |||
- | # Forward to GB7NXT any day, any time, but don't poll | ||
- | |||
- | @GB7NXT F | ||
- | 0-6 | ||
- | 0-23 | ||
- | C KIDDER | ||
- | C GB7NXT | ||
- | W NXTNOD: | ||
- | S BBS | ||
- | ------ | ||
- | ; Forward and poll VA2OM any day, mornings & evenings only: | ||
- | ; | ||
- | @VA2OM FP | ||
- | 0-6 | ||
- | 8-11,17-20 | ||
- | C KIDDER | ||
- | C VA2OM-14 | ||
- | S PMS | ||
- | ---------- | ||
- | |||
- | </ | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====HOLD.SYS.MAN===== | ||
- | < | ||
- | |||
- | </ | ||
- | HOLD.SYS -- Control File for Mail Holding. | ||
- | |||
- | </ | ||
- | The optional file HOLD.SYS, which resides in the PMS | ||
- | subdirectory, | ||
- | |||
- | It is read " | ||
- | be edited on the fly, and any edits take effect immediately. | ||
- | |||
- | Entries in this file allow messages to be automatically held | ||
- | for review depending on the contents of its TO, FROM, or AT | ||
- | fields, and whether or not it was entered locally. | ||
- | |||
- | Held messages are not forwarded, and are only visible to | ||
- | sysops. | ||
- | |||
- | </ | ||
- | Comment lines are allowed. They must begin with a hash (#) or | ||
- | a semicolon (;) in the leftmost column. | ||
- | |||
- | Each " | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | " | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | mail and " | ||
- | area for a bulletin, e.g. " | ||
- | |||
- | </ | ||
- | Rules are processed in the sequence in which they are | ||
- | declared in the file. | ||
- | |||
- | If all 5 fields of any rule match characteristics of a | ||
- | message, that message is held. | ||
- | |||
- | </ | ||
- | The first example holds all bulletins addressed to PORN, and | ||
- | all locally-entered mail of any type: | ||
- | |||
- | # Source Type To From At | ||
- | # ========================== | ||
- | * B PORN * * | ||
- | L * * | ||
- | |||
- | The next example holds locally entered bulletins, except those | ||
- | with a blank AT field. This allows users to post bulletins | ||
- | which stay on this bbs with no interference: | ||
- | |||
- | # Source Type To From At | ||
- | # ========================== | ||
- | | ||
- | |||
- | The next example holds all bulls from LU9DCE, and demomstrates | ||
- | the use of semicolons instead of hashes for comment lines: | ||
- | |||
- | ; Source | ||
- | ; ================================== | ||
- | | ||
- | |||
- | Finally, hold all private mail addresed to " | ||
- | |||
- | ; Source | ||
- | ; ================================== | ||
- | | ||
- | |||
- | </ | ||
- | HOLD(4) -- Hold a Message. | ||
- | KH(4) -- Kill Held Mail. | ||
- | LH(4) -- List Held Mail. | ||
- | UH(4) -- Un-hold Messages. | ||
- | PMS(9) | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====HTTP.ACL.MAN===== | ||
- | < | ||
- | </ | ||
- | HTTP.ACL -- HTTP Proxy Egress Control File (Optional). | ||
- | |||
- | </ | ||
- | The HTTP.ACL file contains " | ||
- | destinations are allowed to be accessed via the HTTP | ||
- | proxy/ | ||
- | |||
- | The rules allow you to specify which destination IP | ||
- | addresses and TCP ports may be accessed by specified | ||
- | source IP ranges. | ||
- | |||
- | If the file is not present, or contains no valid rules, | ||
- | all destinations are blocked, and the "403 Forbidden" | ||
- | error page is returned to anyone who tries to use the | ||
- | proxy or tunnel. | ||
- | |||
- | Egress control is vital to prevent miscreants using your | ||
- | HTTP server as a proxy to hide their IP address. | ||
- | |||
- | </ | ||
- | The format of the entries in HTTP.ACL is the same as | ||
- | other .ACL (Access Control List) files. | ||
- | |||
- | Each " | ||
- | or lines beginning with ';' | ||
- | maximum line length is 255 characters. | ||
- | |||
- | Within each rule, fields must be separated by one or | ||
- | more spaces or tabs. The fields are as follows: | ||
- | |||
- | < | ||
- | |||
- | The fields have the following meaning: | ||
- | |||
- | < | ||
- | | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | [mask] | ||
- | | ||
- | match from left to right, | ||
- | | ||
- | |||
- | < | ||
- | the target system. | ||
- | " | ||
- | |||
- | |||
- | In the < | ||
- | "all addresses" | ||
- | |||
- | </ | ||
- | Rule testing stops at the *first* matching " | ||
- | " | ||
- | correctly. | ||
- | access all LAN ports except 513 it would be ok to use: | ||
- | |||
- | deny | ||
- | permit | ||
- | |||
- | but if the entries were reversed, the " | ||
- | match every case and the " | ||
- | |||
- | </ | ||
- | ; Allow LAN users to tunnel to anyone: | ||
- | PERMIT 192.168.0.0/ | ||
- | ; | ||
- | ; Allow Internet users to tunnel only to certain | ||
- | ; ports on the node machine: | ||
- | PERMIT 0.0.0.0/ | ||
- | ; | ||
- | ; Allow Internet users to tunnel only to ports 23 | ||
- | ; and 80 on the BBS machine: | ||
- | PERMIT 0.0.0.0/ | ||
- | ; | ||
- | ; Allow Amprnet users to access any Amprnet destination | ||
- | PERMIT 44.0.0.0/ | ||
- | |||
- | </ | ||
- | If required, HTTP.ACL must be located in the same | ||
- | | ||
- | |||
- | </ | ||
- | | ||
- | | ||
- | | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====HTTPBAN.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | HTTPBAN.SYS -- Blocks Malicious HTTP Requests (Optional). | ||
- | |||
- | </ | ||
- | XRouter' | ||
- | vulnerabilites, | ||
- | exploit them are simply a bandwidth-wasting nuisance | ||
- | rather than a real threat. You can frustrate the hackers | ||
- | by deploying this optional file. | ||
- | |||
- | The HTTPBAN.SYS file contains " | ||
- | of typical malicious request URL's. For example a request | ||
- | for " | ||
- | requests for " | ||
- | Windows servers. | ||
- | |||
- | Each template is specified on a seperate line, can be up | ||
- | to 127 characters long, and must start in the leftmost | ||
- | column. The templates are compared in a sliding match with | ||
- | each requested URL. | ||
- | |||
- | If any part of the first 256 bytes of the URL matches a | ||
- | template, the sender' | ||
- | list and all further IP datagrams from that host are | ||
- | ignored until XRouter is restarted. | ||
- | |||
- | Up to 20 hosts can be banned simultaneously. | ||
- | | ||
- | </ | ||
- | The file may contain comments, which must begin with | ||
- | '#' | ||
- | |||
- | If a template is preceded by the word ANYCASE, a case | ||
- | independent match is performed, otherwise the match is | ||
- | case-sensitive. There must be one or more spaces between | ||
- | the word ANYCASE and the template. | ||
- | |||
- | </ | ||
- | default.ida | ||
- | ANYCASE cmd.exe | ||
- | /contac.php | ||
- | |||
- | </ | ||
- | If required, HTTPBAN.SYS must be located in the same | ||
- | | ||
- | |||
- | </ | ||
- | HTTP.ACL(8) -- Egress Control for HTTP Proxy / Tunnel | ||
- | HTTP.SYS(8) -- HTTP Rewrite / Proxy rules | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====HTTP.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | HTTP.SYS -- HTTP Rewrite / Proxy Control File (Optional). | ||
- | |||
- | </ | ||
- | HTTP.SYS is an optional file. If present, it contains | ||
- | REWRITE rules for the HTTP server, and settings for the | ||
- | HTTP proxy server. | ||
- | |||
- | URL rewriting modifies the URL's of incoming requests, | ||
- | according to a set of REWRITE rules. This can be used to | ||
- | organise widely-dispersed resources into a logical | ||
- | directory tree. | ||
- | |||
- | The resources may be located on the same PC or even on | ||
- | different servers, but can be made to look as if they are | ||
- | all in the same tree on your server. | ||
- | replacing parts of the requested URL with alternative | ||
- | strings of characters. | ||
- | |||
- | The PROXY commands configure XRouter' | ||
- | " | ||
- | |||
- | </ | ||
- | Each command or rule must be on a separate line, and may be | ||
- | up to 255 characters long. Lines beginning with ';' | ||
- | are ignored, and may be used for comments. Commands and | ||
- | rules are not case sensitive, and their fields must be | ||
- | separated by one or more spaces or tabs. Blank lines are | ||
- | ignored. | ||
- | |||
- | The commands and rules are as follows: | ||
- | |||
- | REWRITE < | ||
- | PROXY < | ||
- | PROXYTIMEOUT < | ||
- | |||
- | These are discussed in more detail below... | ||
- | |||
- | </ | ||
- | The REWRITE rules have the following syntax: | ||
- | |||
- | REWRITE < | ||
- | |||
- | < | ||
- | | ||
- | | ||
- | The comparison is case-insensitive. | ||
- | |||
- | <new string> is the character sequence which replaces | ||
- | < | ||
- | |||
- | Example: REWRITE /bbs / | ||
- | |||
- | This would replace "/ | ||
- | "/ | ||
- | be rewritten to "/ | ||
- | |||
- | There are no validity checks, so you must be careful not to | ||
- | inadvertently remove / characters from the rewritten string. | ||
- | e.g. the entry " | ||
- | "/ | ||
- | which will clearly fail. | ||
- | |||
- | You can use rewriting to organise your resources into a neat, | ||
- | logical and compact directory tree, regardless of where they | ||
- | are actually located. | ||
- | |||
- | < | ||
- | the HTTP proxy. For example: | ||
- | |||
- | REWRITE | ||
- | |||
- | This would replace "/ | ||
- | " | ||
- | / | ||
- | http:// | ||
- | |||
- | The resulting URL then treated as if it was a proxy request. | ||
- | |||
- | When rewriting to proxy another system, the new URL must | ||
- | begin with " | ||
- | either a hostname or IP address. | ||
- | |||
- | rewrite http:// | ||
- | |||
- | </ | ||
- | The PROXY command allows XRouter' | ||
- | traffic to a downstream proxy. The format of the command is: | ||
- | |||
- | PROXY < | ||
- | |||
- | e.g. "proxy 44.131.91.245 | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | the range of addresses which are on the same | ||
- | subnet as the proxy. | ||
- | bypass the proxy, i.e. XRouter' | ||
- | connect directly to them instead of via the | ||
- | next proxy. | ||
- | |||
- | This kludge allows 44-net systems to use a further proxy to | ||
- | gain a public (Internet) IP address when connecting non-44 | ||
- | websites. This is necessary because 44-net routing is | ||
- | unreliable at best, i.e. if a 44-net browser tries to | ||
- | connect directly to Google, the reply probably won't get | ||
- | routed back. | ||
- | |||
- | For example, imagine a mobile station, consisting of a web | ||
- | browser and XRouter, with an IP/AX25 link to a nearby gateway, | ||
- | but no Internet connection. The IP address used over the | ||
- | radio link is 44.131.91.3. | ||
- | to use XRouter' | ||
- | for all HTTP traffic from this station is 44.131.91.3. | ||
- | |||
- | Via the nearby gateway, whose IP address is 44.131.91.245, | ||
- | the mobile station can happily browse 44-net (amprnet) | ||
- | websites. But when it tries to use Google, the replies | ||
- | aren't routed back. | ||
- | |||
- | However, if the local gateway has been set up with the | ||
- | above PROXY command, the 44.x.x.x sites will be connected | ||
- | directly by the mobile XRouter' | ||
- | sites will be passed to the gateway' | ||
- | will gain a 62.31.206.176 source address, which is reliably | ||
- | routable and doesn' | ||
- | the amprnet. | ||
- | |||
- | The PROXYTIMEOUT command specifies the maximum time in | ||
- | seconds to wait for a proxied connection. | ||
- | takes longer than this to establish, an error is returned. | ||
- | |||
- | The default is 30 secs, but may need to be longer on a | ||
- | slow radio channel. | ||
- | |||
- | </ | ||
- | If required, HTTP.SYS must be located in the same | ||
- | | ||
- | |||
- | </ | ||
- | HTTP.ACL(8) -- HTTP Proxy Egress Control File | ||
- | HTTPBAN.SYS(8) -- Blocks Malicious HTTP Requests | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====IGATE.CFG.MAN===== | ||
- | < | ||
- | </ | ||
- | IGATE.CFG -- IGATE Configuration File. | ||
- | |||
- | </ | ||
- | IGATE.CFG is the configuration file for the APRS IGATE daemon, | ||
- | therefore you do not need it if you are not using IGATE. | ||
- | is a plain text file read each time the daemon is started. | ||
- | |||
- | </ | ||
- | IGATE.CFG is a plain text file. Each configuration keyword | ||
- | is specified on a separate line. Blank lines, or lines | ||
- | beginning with ';' | ||
- | length is 80 characters. | ||
- | |||
- | Within each directive, fields must be separated by one or | ||
- | more spaces or tabs. The fields are as follows: | ||
- | |||
- | The following keywords are accepted: | ||
- | |||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | |||
- | These are fully documented in the section relating to IGATE. | ||
- | |||
- | </ | ||
- | Abbreviated example file: | ||
- | |||
- | ; APRS IGATE Configuration file for XRPi | ||
- | ; | ||
- | ; You can list as many servers as you like. | ||
- | ; They are tried in rotation. | ||
- | SERVER 213.180.75.122: | ||
- | ; | ||
- | ; Wait up to 60 secs for connection before trying next server | ||
- | WAIT 60 | ||
- | ; | ||
- | ; Wait 60 secs between successive attempts to same server | ||
- | PAUSE 60 | ||
- | ; | ||
- | ; Max connect attempts before blacklisting the server | ||
- | MAXTRIES 10 | ||
- | ; | ||
- | ; If blacklisted, | ||
- | SKIP 3600 | ||
- | ; | ||
- | ; IFILTER controls gating from internet to packet: | ||
- | ; | ||
- | ; IFILTER | ||
- | ; ------------------------------------- | ||
- | IFILTER | ||
- | ; | ||
- | ; PFILTER statements control gating from packet to internet: | ||
- | ; | ||
- | ; PFILTER | ||
- | ; ------------------------------------ | ||
- | PFILTER | ||
- | PFILTER | ||
- | ; | ||
- | ; Radius of Interest | ||
- | ; | ||
- | RADIUS 150 | ||
- | ; | ||
- | ; Activity logging | ||
- | ; | ||
- | LOG 255 | ||
- | |||
- | |||
- | </ | ||
- | If required, IGATE.CFG should be located in the same | ||
- | directory as the XRouter executable. | ||
- | |||
- | </ | ||
- | IGATE(9) | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====IPBAN.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | IPBAN.SYS -- Banned IP addresses file. | ||
- | |||
- | </ | ||
- | This optional file is read at bootup. It stores the list of | ||
- | " | ||
- | |||
- | If the file doesn' | ||
- | the "IP BAN SAVE" command, if there are any entries to save. | ||
- | That comand may also be used in CRONTAB.SYS to save the list | ||
- | ar regular intervals. | ||
- | |||
- | The ban and honeypot lists can be viewed and edited during | ||
- | run-time using the "IP BAN" command and its sub-commands. | ||
- | |||
- | IP Banning | ||
- | ~~~~~~~~~~ | ||
- | If XRouter' | ||
- | malicious activity on its own TCP/IP stack, it will " | ||
- | originator' | ||
- | address are be ignored, as long as the ban lasts. | ||
- | |||
- | If malicious activity is detected on any Linux TCP or UDP | ||
- | port that is currently " | ||
- | a ban. In this case, TCP connections are terminated, and any | ||
- | further connections of UDP frames are ignored. | ||
- | |||
- | There is no time limit on IP bans. Up to 200 IP addresses can | ||
- | be banned at once. A larger table would become unwieldy. When | ||
- | a new address is added, the oldest one is dropped. In | ||
- | practice this isn't usually a problem because the oldest | ||
- | aggressor has usually given up long ago, and is unlikely to | ||
- | come back. | ||
- | |||
- | Honeypots | ||
- | ~~~~~~~~~ | ||
- | In this context, a honeypot a sticky trap, set up on popular | ||
- | TCP or UDP ports, for catching internet low-life. | ||
- | |||
- | Hackbots generally start their attacks by probing for open | ||
- | TCP ports, and to save time they often start with the most | ||
- | popular ones - telnet, SSH, HTTP, VNC and so on. If they find | ||
- | an open port, they tend to inform each other, then they all | ||
- | concentrate their attacks on that port. | ||
- | |||
- | Unless you have a particular service port open, the chances | ||
- | are that anyone who tries to connect to it is up to no good. | ||
- | So the honeypot is a mitigation measure. It LOOKS like an | ||
- | attractive open port, but it's not! Anyone who connects to it | ||
- | gets their IP address logged and banned. After that they | ||
- | can't do any more attacking unless they change their IP | ||
- | address. | ||
- | |||
- | It's not foolproof. Nation states and sophisticated hackers | ||
- | have access to virtually unlimited IP addresses. But it slows | ||
- | them down, and the IDS alerts you that there is a problem. | ||
- | |||
- | </ | ||
- | IPBAN.SYS is a text file, so it can be viewed and edited with | ||
- | any text editor, although there should be no need to do so. | ||
- | |||
- | Each " | ||
- | |||
- | There are TWO types of entry in IPBAN.SYS, one for banned IP | ||
- | addresses, and the other for honeypot definitions. The | ||
- | banned IP entries are of the form: | ||
- | |||
- | < | ||
- | |||
- | Where: | ||
- | |||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | |||
- | " | ||
- | when it detects malicious activity. " | ||
- | added by the sysop using the "IP BAN" command. | ||
- | |||
- | Honeypot entries have the form: | ||
- | |||
- | < | ||
- | |||
- | Where: | ||
- | |||
- | < | ||
- | < | ||
- | < | ||
- | (1=TCP, 2=UDP, 3=both) | ||
- | < | ||
- | < | ||
- | |||
- | Date/time is a decimal number representing the number of | ||
- | seconds since 1/1/1970. | ||
- | |||
- | </ | ||
- | ; Manual ban for 22.33.44.55 with 123 hits | ||
- | 22.33.44.55 | ||
- | |||
- | ; Manual ban for 33.22.0.0/ | ||
- | 33.22.33.11 | ||
- | |||
- | ; Automatic ban for 80.193.161.2, | ||
- | 80.193.161.2 255.255.255.255 | ||
- | |||
- | ; Honeypot on UDP port 211, no hits yet | ||
- | 211 211 | ||
- | |||
- | ; Honeypot on VNC ports 5900-5999, both TCP and UDP | ||
- | 5900 5999 3 0 0 | ||
- | |||
- | </ | ||
- | IP(1) -- IP related commands | ||
- | CRONTAB.SYS(8) -- Time dependent comands | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====IPROUTE.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | IPROUTE.SYS -- IP Router Configuration File (optional). | ||
- | |||
- | </ | ||
- | This optional file is only required if you wish to route IP | ||
- | traffic, or use any of XRouter' | ||
- | Ping, Traceroute, HTTP server etc. I.e. it is not required | ||
- | if you are operating a pure AX25 / Netrom system, although | ||
- | you are urged to route amateur IP if possible. | ||
- | |||
- | The file is read only at boot-up, or by an "IP ROUTE LOAD" | ||
- | command so if you make changes to it, they won't take | ||
- | effect until you reboot or use that command. | ||
- | not write to this file. | ||
- | |||
- | If IPROUTE.SYS is present, it saves you having to enter | ||
- | the IP routing manually. | ||
- | configuration files, this file also contains the permanent | ||
- | ARP (Address Resolution Protocol), NAT (Network Address | ||
- | Translation), | ||
- | and IP filtering rules. | ||
- | |||
- | </ | ||
- | IPROUTE.SYS is a text file. Within the file, each entry | ||
- | must be on a separate line, and there must be one or more | ||
- | spaces or tabs between each field. | ||
- | sensitive. | ||
- | line beginning with a semicolon ';' | ||
- | lines are ignored and lines may be up to 255 characters | ||
- | long. | ||
- | |||
- | Commands accepted in this file are as follows: | ||
- | |||
- | ACL <PERMIT | DENY> | ||
- | ARP <ADD | PUBLISH> | ||
- | DUN <ADD | LOG> | ||
- | IP <CMD | ROUTE ADD | ROUTE DEFAULT | QUIET | TTL> | ||
- | NAT <ADD> | ||
- | RIP <ADD | LEARN | REFUSE | TIMEOUT> | ||
- | |||
- | ACL commands control the Access Control List, which | ||
- | specifies the IP addresses which are allowed to access | ||
- | and be accessed by XRouter. | ||
- | |||
- | ARP commands are used to add " | ||
- | table. These are mainly used for slow RF links. | ||
- | |||
- | DUN commands are used to configure " | ||
- | |||
- | IP commands are used to add routes to the IP routing table | ||
- | and to configure the TTL, stealth level, and | ||
- | availability of the IPROUTE command. | ||
- | |||
- | NAT commands add Network Address Translation entries to the | ||
- | NAT table. | ||
- | |||
- | RIP commands control the RIP98 and RIP2 automatic route | ||
- | learning system. | ||
- | |||
- | All of these commands are described in more detail in their | ||
- | own section 1 MAN pages (see below). | ||
- | |||
- | </ | ||
- | If present, IPROUTE.SYS must be located in the same | ||
- | directory as the XRouter executable. | ||
- | |||
- | </ | ||
- | ACL(1) | ||
- | ARP(1) | ||
- | DUN(1) | ||
- | IP(1) -- IP Routing / Configuration Commands. | ||
- | IP-PRIMER(9) -- IP Addressing / Routing Primer. | ||
- | IPROUTE(1) | ||
- | NAT(1) | ||
- | RIP(1) | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====LANGS.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | LANGS.SYS -- Language Control File. | ||
- | |||
- | </ | ||
- | This optional file is read only at bootup. It controls which | ||
- | language is used for a caller' | ||
- | callsign. | ||
- | |||
- | By default, XRouter uses ENGLISH. If you want to support | ||
- | additional languages, install the relevant language file(s) | ||
- | as follows: | ||
- | |||
- | French | ||
- | Spanish | ||
- | German | ||
- | Dutch - NEDERLANDS.SYS | ||
- | |||
- | Language files are read only at bootup. | ||
- | |||
- | All sessions use ENGLISH by default, UNLESS you install | ||
- | LANGS.SYS, which tells XRouter which language to use for a | ||
- | given callsign. | ||
- | |||
- | </ | ||
- | The entries in LANGS.SYS are of the form: | ||
- | |||
- | < | ||
- | |||
- | The < | ||
- | use the < | ||
- | " | ||
- | |||
- | < | ||
- | language to be used. These numbers are fixed, no matter how | ||
- | many language files are installed: English is always number | ||
- | 0, French is always number 1 and so on. | ||
- | |||
- | Comment lines beginning with "#" | ||
- | column are allowed. | ||
- | |||
- | If you refer to a language nuber, you MUST install that | ||
- | language file. | ||
- | |||
- | </ | ||
- | # LANGS.SYS | ||
- | # | ||
- | # Language selection file for XRouter v502 | ||
- | # | ||
- | # Line format: < | ||
- | # | ||
- | # Language numbers: | ||
- | # | ||
- | # 0 | ||
- | # 1 | ||
- | # 2 | ||
- | # 3 | ||
- | # 4 | ||
- | # | ||
- | # The default language for any callsign prefix not in the | ||
- | # list below is set by DEFAULTLANG in XROUTER.CFG. | ||
- | # | ||
- | 2* 0 | ||
- | 3A* 1 | ||
- | EA* 2 | ||
- | F* 1 | ||
- | G* 0 | ||
- | H* 1 | ||
- | M* 0 | ||
- | ON1K* 1 | ||
- | ON4* 1 | ||
- | ON5* 1 | ||
- | ON6* 1 | ||
- | ON7* 1 | ||
- | ON8* 1 | ||
- | ON9* 1 | ||
- | PA* 4 | ||
- | PB* 4 | ||
- | PC* 4 | ||
- | PD* 4 | ||
- | PE* 4 | ||
- | PF* 4 | ||
- | PH* 4 | ||
- | PH* 4 | ||
- | PI* 4 | ||
- | TK* 1 | ||
- | TU* 1 | ||
- | VA2* 1 | ||
- | VE2* 1 | ||
- | |||
- | </ | ||
- | When BBS software is making connections for forwarding, it | ||
- | expects to see the English | ||
- | problem, e.g. the BBS is French you have two options. The first | ||
- | option is to " | ||
- | allowing it to revert to English for that text only. The second | ||
- | option is to add an exception for that BBS into this file, | ||
- | assigning its language to English, e.g. "F1BBS 0". The | ||
- | exception should be added BEFORE any wildcard entries for that | ||
- | group pf caallgigns. | ||
- | |||
- | </ | ||
- | XRouter' | ||
- | change the layout and/or wording of most XRouter responses by | ||
- | installing ENGLISH.SYS in the same directory as XRouter. | ||
- | XRouter will then use the texts from that file, which you may | ||
- | modify, instead of the inbuilt ones. | ||
- | |||
- | Be careful with modifications, | ||
- | used in multiple places, and some of them are column headers | ||
- | which need to follow a strict format. Installing and modifying | ||
- | this file is NOT recommended, | ||
- | |||
- | Similar comments apply to the other language files. If you can | ||
- | improve on them, please do so, and share the results. | ||
- | |||
- | If your language is not (yet) one of the supported ones, and | ||
- | you don't need English, translate ENGLISH.SYS into your own | ||
- | language. That will become the default language. | ||
- | |||
- | </ | ||
- | LANG(1) | ||
- | CONSOLELANG(7) -- Console language | ||
- | DEFAULTLANG(7) -- Specify default language | ||
- | XROUTER.CFG(8) -- Main configuration file | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====PASSWORD.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | PASSWORD.SYS -- Sysop Password File (Optional). | ||
- | |||
- | </ | ||
- | This optional file contains the sysop passwords for AX25 | ||
- | remote access, RLOGIN and FTP. If the file is not present, | ||
- | these forms of access will not be possible. | ||
- | |||
- | These passwords are for SYSOPS only (passwords for users | ||
- | are stored in USERPASS.SYS). | ||
- | |||
- | </ | ||
- | There should be one entry for each sysop, and each entry | ||
- | must be on a separate line, Blank lines, or lines beginning | ||
- | with ';' | ||
- | characters. | ||
- | |||
- | Entries must consist of two fields separated by one or more | ||
- | spaces or tabs as follows: | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | For example: G8PZT | ||
- | G1LOA | ||
- | |||
- | | ||
- | |||
- | </ | ||
- | You should try to choose a password that you can easily | ||
- | | ||
- | | ||
- | | ||
- | grid and your responses. | ||
- | |||
- | The longer you make the password, the more secure it will | ||
- | | ||
- | these are the favourite weapons of attack-bots. If you | ||
- | | ||
- | pets, string them together to make a composite word. | ||
- | |||
- | A random string is the most secure, because even if | ||
- | | ||
- | the remainder. However you must strike a balance between | ||
- | | ||
- | is never sent over the air for AX25 logins, it must be | ||
- | | ||
- | |||
- | You may have a different password for each sysop, or you | ||
- | might choose to give all sysops the same password. | ||
- | | ||
- | | ||
- | |||
- | </ | ||
- | If present, PASSWORD.SYS must be located in the same | ||
- | directory as the XRouter executable. | ||
- | |||
- | </ | ||
- | AXSCTRL(9) | ||
- | USERPASS.SYS(8) -- User Passwords File. | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====PMS.CFG.MAN===== | ||
- | < | ||
- | |||
- | </ | ||
- | PMS.CFG -- PMS / BBS Configuration File. | ||
- | |||
- | </ | ||
- | PMS.CFG is an optional configuration file for the inbuilt | ||
- | mailbox. If present, it is located in the PMS folder. It is | ||
- | read only when the program starts. | ||
- | |||
- | It is a text file containing directives of the general form | ||
- | < | ||
- | not case sensitive, and they may be specified in any order. | ||
- | |||
- | Blank lines and comment lines are allowed. The latter must | ||
- | begin with a semicolon (;) or hash (#) in the leftmost | ||
- | column. | ||
- | |||
- | If PMS.CFG is not present, the mailbox uses default values. | ||
- | |||
- | </ | ||
- | The options currently recognised are as follows: | ||
- | |||
- | SysopCallsign | ||
- | Sysop' | ||
- | | ||
- | HousekeepInterval | ||
- | Hours between " | ||
- | Housekeeping removes old messages, optionally re-numbers | ||
- | the messages to remove gaps, and generates WP updates. | ||
- | |||
- | ForwardInterval | ||
- | Seconds between Forwarding " | ||
- | If set to 0, forwarding is triggered only upon receipt of | ||
- | |||
- | |||
- | FwdKickOnRcv | ||
- | If set to 1 (default) a forwarding " | ||
- | immediately upon receipt of new mail. If set to 0, | ||
- | forwarding is deferred until next " | ||
- | |||
- | AutoRenumber | ||
- | Controls re-numbering of messages at housekeep time. | ||
- | If it is non-zero, messages are renumbered if the highest | ||
- | message number exceeds the specified value. e.g. a value | ||
- | of 5000 means that messages are not renumbered until the | ||
- | highest number is equal to, or greater than 5000. | ||
- | After renumbering, | ||
- | gaps. Default is 0 = no renumbering. | ||
- | |||
- | MaxAgeB | ||
- | Maximum lifefime in days for a bulletin (default 30) | ||
- | |||
- | MaxAgePR | ||
- | Maximum lifetime for private mail that has been read. | ||
- | (default 180) | ||
- | |||
- | MaxAgeMid=30 | ||
- | Maximum lifetime for message identifiers (default 30) | ||
- | |||
- | WpUpdateTo | ||
- | Callsign (without SSID) of neighbour BBS to whom WP | ||
- | updates are to be sent. Can be used multiple times, to | ||
- | specify more than one BBS. The default is none, i.e. | ||
- | don't send WP updates. | ||
- | |||
- | </ | ||
- | ForwardInterval=3600 | ||
- | FwdKickOnRcv=0 | ||
- | WpUpdateTo=GB7PZT | ||
- | |||
- | </ | ||
- | PMS(1) | ||
- | PMS(9) | ||
- | XROUTER.CFG(8) -- Main Configuration File. | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====PPPHOST.n.MAN===== | ||
- | < | ||
- | </ | ||
- | PPPHOST.n -- PPP Configuration File(s) (Optional). | ||
- | |||
- | </ | ||
- | This optional file is required only if a PSTN modem is | ||
- | connected to XRouter and auto-answer is enabled. | ||
- | |||
- | It is read only when a modem caller issues the command | ||
- | "XLINK PPP", and may contain PPP commands to override the | ||
- | default PPP configuration for the duration of the call. It | ||
- | may also contain NAT commands. | ||
- | |||
- | The default configuration is probably OK for most purposes, | ||
- | but you may for example wish to change the inactivity | ||
- | timeout or the IP address. | ||
- | |||
- | There may be several of these files, one for each modem | ||
- | port. The " | ||
- | caller has accessed XRouter. | ||
- | |||
- | </ | ||
- | Each command must be on a separate line, Blank lines, or | ||
- | lines beginning with ';' | ||
- | line length is 127 characters. | ||
- | |||
- | See the PPP MAN page for details of the PPP commands. | ||
- | |||
- | </ | ||
- | If required, this file must be located in the same | ||
- | directory as the XRouter executable. | ||
- | |||
- | </ | ||
- | NAT(1) | ||
- | PPP(1) | ||
- | PSTN(9) -- PSTN Modem Support. | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====REJECT.SYS.MAN===== | ||
- | < | ||
- | |||
- | </ | ||
- | REJECT.SYS -- Mail Rejection Control File. | ||
- | |||
- | </ | ||
- | The optional file REJECT.SYS, which resides in the PMS | ||
- | subdirectory, | ||
- | used to reject unwanted types or categories of mail when they | ||
- | are offered (proposed) by other mailboxes. | ||
- | |||
- | The file is read " | ||
- | can be edited on the fly, and changes take effect immediately. | ||
- | |||
- | </ | ||
- | REJECT.SYS contains " | ||
- | Each rule must occupy a separate line. Blank lines and comment | ||
- | lines are allowed. The latter must begin with '#' | ||
- | the leftmost column. | ||
- | |||
- | Each rule consists of exactly 5 fields as follows: | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | |||
- | Rules are case-independent, | ||
- | |||
- | The exception is the < | ||
- | If < | ||
- | than < | ||
- | fields match. | ||
- | |||
- | Note that only FBB proposals include size, MBL ones don't. | ||
- | |||
- | If the <at> field starts with a caret ' | ||
- | meaning of that field. e.g. " | ||
- | EXCEPT GBR. | ||
- | |||
- | </ | ||
- | Incoming message proposals are tested against each rule in | ||
- | turn. If a rule matches all the message fields, the message is | ||
- | rejected. | ||
- | |||
- | </ | ||
- | # Reject earthquake bulls of any size, from anyone: | ||
- | # type to from | ||
- | # -------------------------------- | ||
- | B | ||
- | |||
- | </ | ||
- | HOLD.SYS(8) -- Message Holding Control File. | ||
- | PMS(9) | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====SOCKS.ACL.MAN===== | ||
- | < | ||
- | </ | ||
- | SOCKS.ACL -- SOCKS Proxy Egress Control File (Optional). | ||
- | |||
- | </ | ||
- | The SOCKS.ACL file contains " | ||
- | destinations are allowed to be accessed via the SOCKS | ||
- | proxy. | ||
- | |||
- | The rules allow you to specify which destination IP | ||
- | addresses and TCP ports may be accessed by specified | ||
- | source IP ranges. | ||
- | |||
- | If the file is not present, or contains no valid rules, | ||
- | all destinations are blocked. Attempting to access | ||
- | a blocked destination causes the proxy to return an | ||
- | " | ||
- | |||
- | </ | ||
- | The format of the entries in SOCKS.ACL is the same as | ||
- | other .ACL (Access Control List) files. | ||
- | |||
- | Each " | ||
- | or lines beginning with ';' | ||
- | maximum line length is 255 characters. | ||
- | |||
- | Within each rule, fields must be separated by one or | ||
- | more spaces or tabs. The fields are as follows: | ||
- | |||
- | < | ||
- | |||
- | The fields have the following meaning: | ||
- | |||
- | < | ||
- | | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | [mask] | ||
- | | ||
- | match from left to right, | ||
- | | ||
- | |||
- | < | ||
- | the target system. | ||
- | " | ||
- | |||
- | |||
- | In the < | ||
- | "all addresses" | ||
- | |||
- | </ | ||
- | Rule testing stops at the *first* matching " | ||
- | " | ||
- | correctly. | ||
- | access all LAN ports except 513 it would be ok to use: | ||
- | |||
- | deny 0.0.0.0/ | ||
- | permit | ||
- | |||
- | but if the entries were reversed, the " | ||
- | match every case and the " | ||
- | |||
- | </ | ||
- | ; Allow LAN users to tunnel to anyone: | ||
- | PERMIT 192.168.0.0/ | ||
- | ; | ||
- | ; Allow Internet users to tunnel only to certain | ||
- | ; ports on the node machine: | ||
- | PERMIT 0.0.0.0/ | ||
- | ; | ||
- | ; Allow Internet users to tunnel only to ports 23 | ||
- | ; and 80 on the BBS machine: | ||
- | PERMIT 0.0.0.0/ | ||
- | ; | ||
- | ; Allow Amprnet users to access any Amprnet destination | ||
- | PERMIT 44.0.0.0/ | ||
- | |||
- | </ | ||
- | If required, SOCKS.ACL must be located in the same | ||
- | | ||
- | |||
- | </ | ||
- | | ||
- | | ||
- | | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====TELGUEST.ACL.MAN===== | ||
- | < | ||
- | </ | ||
- | TELGUEST.ACL -- TELNET Guest Egress Control File (Optional). | ||
- | |||
- | </ | ||
- | The TELGUEST.ACL file contains " | ||
- | destinations are allowed to be accessed by " | ||
- | using the TELNET command. | ||
- | |||
- | The rules allow you to specify which destination IP | ||
- | addresses and TCP ports may be accessed by specified | ||
- | source IP ranges. | ||
- | |||
- | If the file is not present, or contains no valid rules, | ||
- | all destinations are blocked. Attempting to access | ||
- | a blocked destination causes the " | ||
- | |||
- | If the facility is enabled by suitable entries in | ||
- | ACCESS.SYS, " | ||
- | Telnet, using the password " | ||
- | they are genuine Radio Hams, they are prevented from | ||
- | downlinking to any AX25 or NetRom destination, | ||
- | sysop may choose to allow them to access certain other | ||
- | destinations using this file. | ||
- | |||
- | </ | ||
- | The format of the entries in TELGUEST.ACL is the same as | ||
- | other .ACL (Access Control List) files. | ||
- | |||
- | Each " | ||
- | or lines beginning with ';' | ||
- | maximum line length is 255 characters. | ||
- | |||
- | Within each rule, fields must be separated by one or | ||
- | more spaces or tabs. The fields are as follows: | ||
- | |||
- | < | ||
- | |||
- | The fields have the following meaning: | ||
- | |||
- | < | ||
- | | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | [mask] | ||
- | | ||
- | match from left to right, | ||
- | | ||
- | |||
- | < | ||
- | the target system. | ||
- | " | ||
- | |||
- | |||
- | In the < | ||
- | "all addresses" | ||
- | |||
- | </ | ||
- | Rule testing stops at the *first* matching " | ||
- | " | ||
- | correctly. | ||
- | access all LAN ports except 513 it would be ok to use: | ||
- | |||
- | deny 0.0.0.0/ | ||
- | permit | ||
- | |||
- | but if the entries were reversed, the " | ||
- | match every case and the " | ||
- | |||
- | </ | ||
- | ; Allow LAN users to telnet to anyone: | ||
- | PERMIT 192.168.0.0/ | ||
- | ; | ||
- | ; Allow Internet users to telnet only to ports 23 | ||
- | ; and 80 on the BBS machine: | ||
- | PERMIT 0.0.0.0/ | ||
- | ; | ||
- | ; Allow Amprnet users to access any Amprnet destination | ||
- | PERMIT 44.0.0.0/ | ||
- | |||
- | </ | ||
- | If required, TELGUEST.ACL must be located in the same | ||
- | | ||
- | |||
- | </ | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====TELPROXY.ACL.MAN===== | ||
- | < | ||
- | </ | ||
- | TELPROXY.ACL -- TELNET Proxy Egress Control File (Optional). | ||
- | |||
- | </ | ||
- | The TELPROXY.ACL file contains " | ||
- | destinations are allowed to be accessed via the Telnet | ||
- | proxy. | ||
- | |||
- | The rules allow you to specify which destination IP | ||
- | addresses and TCP ports may be accessed by specified | ||
- | source IP ranges. | ||
- | |||
- | If the file is not present, or contains no valid rules, | ||
- | all destinations are blocked. Attempting to access | ||
- | a blocked destination causes the proxy session to | ||
- | disconnect. | ||
- | |||
- | If the rules in ACCESS.SYS are such that your Telnet proxy | ||
- | is accessible without password, then egress control is vital, | ||
- | to prevent miscreants using your telnet proxy to access other | ||
- | systems while hiding their IP address. | ||
- | |||
- | </ | ||
- | The format of the entries in TELPROXY.ACL is the same as | ||
- | other .ACL (Access Control List) files. | ||
- | |||
- | Each " | ||
- | or lines beginning with ';' | ||
- | maximum line length is 255 characters. | ||
- | |||
- | Within each rule, fields must be separated by one or | ||
- | more spaces or tabs. The fields are as follows: | ||
- | |||
- | < | ||
- | |||
- | The fields have the following meaning: | ||
- | |||
- | < | ||
- | | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | [mask] | ||
- | | ||
- | match from left to right, | ||
- | | ||
- | |||
- | < | ||
- | the target system. | ||
- | " | ||
- | |||
- | |||
- | In the < | ||
- | "all addresses" | ||
- | |||
- | </ | ||
- | Rule testing stops at the *first* matching " | ||
- | " | ||
- | correctly. | ||
- | access all LAN ports except 513 it would be ok to use: | ||
- | |||
- | deny 0.0.0.0/ | ||
- | permit | ||
- | |||
- | but if the entries were reversed, the " | ||
- | match every case and the " | ||
- | |||
- | </ | ||
- | ; Allow LAN users to tunnel to anyone: | ||
- | PERMIT 192.168.0.0/ | ||
- | ; | ||
- | ; Allow Internet users to tunnel only to certain | ||
- | ; ports on the node machine: | ||
- | PERMIT 0.0.0.0/ | ||
- | ; | ||
- | ; Allow Internet users to tunnel only to ports 23 | ||
- | ; and 80 on the BBS machine: | ||
- | PERMIT 0.0.0.0/ | ||
- | ; | ||
- | ; Allow Amprnet users to access any Amprnet destination | ||
- | PERMIT 44.0.0.0/ | ||
- | |||
- | </ | ||
- | If required, TELPROXY.ACL must be located in the same | ||
- | | ||
- | |||
- | </ | ||
- | | ||
- | | ||
- | | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====TELPROXY.MSG.MAN===== | ||
- | < | ||
- | </ | ||
- | TELPROXY.MSG -- Telnet Proxy Logon Message File (Optional). | ||
- | |||
- | </ | ||
- | This optional file is only required if you are using the | ||
- | Telnet Proxy feature. | ||
- | the user upon uplink connection to the proxy. | ||
- | |||
- | If the file is NOT present, the following default text is | ||
- | displayed: | ||
- | |||
- | Use: Tel[net] < | ||
- | Ready | ||
- | > | ||
- | |||
- | If the TELPROXY.MSG file is present, its contents are sent | ||
- | to the user in place of the default text. Therefore you may | ||
- | customise the logon text to suit your clientele. | ||
- | |||
- | </ | ||
- | This is an example of what the TELPROXY.MSG file might | ||
- | contain: | ||
- | |||
- | --------------------- example starts -------------- | ||
- | |||
- | To connect to another system, use " | ||
- | |||
- | e.g. Tel 44.131.91.2 7777 | ||
- | |||
- | Type HELP for any other help | ||
- | |||
- | ---------------------- example ends ----------------- | ||
- | |||
- | </ | ||
- | By default, the telnet proxy listens on TCP port 2323. This | ||
- | may be reassigned or disabled using the TELPROXYPORT | ||
- | directive in XROUTER.CFG. | ||
- | |||
- | </ | ||
- | If present, TELPROXY.MSG must be located in the same | ||
- | directory as the XRouter program. | ||
- | |||
- | The associated TELPROXY.ACL file controls which | ||
- | destinations are available to users, based on their source | ||
- | IP addresses. | ||
- | |||
- | </ | ||
- | TELPROXY.ACL(8) -- Telnet Proxy Egress Control Rules. | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====USERPASS.SYS.MAN===== | ||
- | < | ||
- | </ | ||
- | USERPASS.SYS -- User Passwords File (Optional). | ||
- | |||
- | </ | ||
- | The entries in this optional file are used, if dictated | ||
- | by entries in ACCESS.SYS, to control normal Telnet | ||
- | (port 23) logins, Telnet Proxy (port 2323), and APRS | ||
- | server (port 1448) logins. They are not used for sysop | ||
- | logins, RLOGIN or FTP. | ||
- | |||
- | Passwords are not required for normal AX25 / NetRom access. | ||
- | |||
- | </ | ||
- | There should be one entry for each user, and each entry | ||
- | must be on a separate line, Blank lines, or lines beginning | ||
- | with ';' | ||
- | characters. | ||
- | |||
- | Entries must consist of two fields separated by one or more | ||
- | spaces or tabs as follows: | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | | ||
- | |||
- | </ | ||
- | ; USERPASS.SYS for Xrouter | ||
- | ; | ||
- | ; This file contains passwords for Telnet and Modem logins. | ||
- | ; | ||
- | ; Fields are: < | ||
- | ; Callsigns should not include SSID | ||
- | ; | ||
- | G8PZT amazon | ||
- | G7CXZ drvxcdfre | ||
- | ; | ||
- | |||
- | </ | ||
- | For extra security, it is advisable for sysops to use | ||
- | different passwords for telnet and RLOGIN. | ||
- | |||
- | </ | ||
- | If present, USERPASS.SYS must be located in the same | ||
- | directory as XRouter itself. | ||
- | |||
- | </ | ||
- | PASSWORD.SYS(8) -- Sysop Password File. | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====XENCAP.TXT.MAN===== | ||
- | < | ||
- | </ | ||
- | XENCAP.TXT -- Amprnet Encapsulated Routing File (optional). | ||
- | |||
- | </ | ||
- | This experimental file is similar to ENCAP.TXT, except that it | ||
- | allows encapsulation modes other than " | ||
- | |||
- | It is thus an e(X)tended version of ENCAP.TXT. Its purpose is | ||
- | to allow those XRouter sysops who are unable to handle IPEncap | ||
- | (protocol number 4) to act as amprnet gateways by means of | ||
- | other protocols, such as IPIP (protocol 94) or IPUDP. | ||
- | |||
- | If this file is present when XRouter boots up, it will read | ||
- | the routes into its IP routing table. | ||
- | |||
- | If you are not running an amprnet " | ||
- | your own encap routes in IPROUTE.SYS, | ||
- | file. | ||
- | |||
- | </ | ||
- | The format of routing entries in XENCAP.TXT is almost | ||
- | identical to those in ENCAP.TXT, with the exception that the | ||
- | word " | ||
- | |||
- | route addprivate 44.131.91.0/ | ||
- | |||
- | The " | ||
- | from users, i.e. not displayed by the IPROUTES command. | ||
- | |||
- | The " | ||
- | this entry applies to. | ||
- | |||
- | The "< | ||
- | use as follows: | ||
- | |||
- | encap - IP-over-IP protocol 4 | ||
- | ipip - IP-over IP protocol 94 | ||
- | ipudp - IP-over-UDP | ||
- | |||
- | The final field is the Internet IP address of the gateway | ||
- | which handles the specified amprnet route(s). | ||
- | |||
- | </ | ||
- | If required. XENCAP.TXT should be located in same directory | ||
- | as the XRouter executable. | ||
- | |||
- | </ | ||
- | This file is experimental, | ||
- | to accommodate more features in the future. | ||
- | |||
- | </ | ||
- | ENCAP.TXT(8) | ||
- | IPROUTE.SYS(8) -- IP Routing and Configuration File | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====XRNODES.8.MAN===== | ||
- | < | ||
- | </ | ||
- | XRNODES -- Routes / Nodes Recovery File. | ||
- | |||
- | </ | ||
- | The XRNODES file contains a list of the known NetRom | ||
- | routes and nodes, and is used to populate the nodes table | ||
- | when XRouter boots. | ||
- | restarted without losing the nodes table. Without this | ||
- | file, it would take several hours to rebuild the nodes | ||
- | table from received broadcasts. | ||
- | |||
- | The nodes and routes tables are saved to this file every | ||
- | NODESINTERVAL, | ||
- | command is used (unless a different filename is specified). | ||
- | |||
- | The file is created by XRouter, but may be edited by the | ||
- | sysop. Apart from the lack of .TXT extension, it is an | ||
- | ordinary plain text file. | ||
- | |||
- | </ | ||
- | The ROUTE entries are specified first, and have the | ||
- | following format: | ||
- | |||
- | ROUTE ADD < | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | |||
- | < | ||
- | " | ||
- | |||
- | [!] indicates a locked route (i.e. one which will not expire). | ||
- | |||
- | [VIA] indicates that the neighbour is reached via | ||
- | digipeater(s). Digipeater callsigns are separated by | ||
- | exactly ONE space, with the end of the list marked by | ||
- | exactly TWO spaces. | ||
- | |||
- | [options] are " | ||
- | the port defaults for that route as follows: | ||
- | |||
- | | ||
- | |||
- | For example: | ||
- | |||
- | ROUTE ADD W7XCV 1 100 | ||
- | ROUTE ADD G8UYL 2 240 ! 5 7000 120 | ||
- | ROUTE ADD G7DIG 5 ! VIA M7FRT M3RED 2 | ||
- | |||
- | The first line shows unlocked neighbour W7XCV on port 1 | ||
- | with quality of 100. The second line shows neighbour | ||
- | G8UYL locked in on port 2 with a quality of 240, | ||
- | maxframe of 3, frack of 7000, and paclen 120. The | ||
- | third line shows neighbour G7DIG locked in using a | ||
- | digipeated path via M7FRT and M3RED, with maxframe of 2. | ||
- | |||
- | |||
- | Following the ROUTE entries, the remainder of the file | ||
- | consists of NODE entries, one per line. The format is as | ||
- | follows: | ||
- | |||
- | NODE ADD < | ||
- | |||
- | < | ||
- | |||
- | <r1> is the callsign of the primary route to that node, | ||
- | for which there must exist a ROUTE entry. | ||
- | |||
- | <p1> is the port used to reach the neighbour. | ||
- | |||
- | <q1> is the quality of the route to the node via that | ||
- | neighbour. | ||
- | |||
- | [!] indicates a locked entry. | ||
- | |||
- | There can be up to 3 different routes listed for each node. | ||
- | For example: | ||
- | |||
- | NODE ADD # | ||
- | NODE ADD BRUM:GB7BM G8PZT 1 94 G8UYL 2 92 | ||
- | NODE ADD BUXTON: | ||
- | |||
- | </ | ||
- | XRNODES is located in the same directory as XRouter. | ||
- | |||
- | </ | ||
- | If XRouter is closed down for more than a few hours, the | ||
- | network may change, and the XRNODES file will become out | ||
- | of date. This could re-introduce expired nodes back into | ||
- | the tables when XRouter is started. In this case it would be | ||
- | better to delete XRNODES before booting up, and let XRouter | ||
- | rebuild the tables from broadcasts. | ||
- | |||
- | </ | ||
- | LOADNODES(1) -- Load the nodes and routes tables. | ||
- | SAVENODES(1) -- Save the nodes and routes tables. | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====XROUTER.CFG.MAN===== | ||
- | < | ||
- | </ | ||
- | XROUTER.CFG -- Main Configuration File (Mandatory). | ||
- | |||
- | </ | ||
- | This file is mandatory, and contains most of the | ||
- | configuration info for XRouter. | ||
- | program starts. | ||
- | |||
- | It is a text file containing directives of the general form | ||
- | < | ||
- | not case sensitive, and in general they may be specified | ||
- | in any order, but interfaces MUST be defined before the | ||
- | ports that reference them. | ||
- | | ||
- | Blank lines are allowed, and comment lines must begin with | ||
- | a semicolon (;) or hash (#) in the leftmost column. | ||
- | must not exceed 255 characters. | ||
- | |||
- | The sections of the file outside the INTERFACE, PORT, RADIO, | ||
- | CONSOLE, APPL and ROUTES blocks, are considered " | ||
- | i.e. this is where the keywords with global action can be | ||
- | used. E.g. this is where the node callsign and alias are | ||
- | specified. | ||
- | |||
- | Some of the keywords, e.g. IPADDRESS and PACLEN may be | ||
- | used globally (to set defaults) and within PORT definition | ||
- | blocks (to set port-specific overrides). | ||
- | |||
- | In the following sections, ' | ||
- | parameters. Additional parameters (e.g. IPADDRESS) may need | ||
- | to be specified to enable full operation. Remaining | ||
- | parameters have sensible defaults built into the program. | ||
- | Defaults are indicated in brackets (). | ||
- | |||
- | </ | ||
- | The following keywords are accepted in the GLOBAL section: | ||
- | |||
- | ACTIONCOLOR | ||
- | AGWPORT | ||
- | ALTITUDE | ||
- | APPL | ||
- | APPLQUAL | ||
- | APRSCALL | ||
- | APRSPORT | ||
- | AUDIODEVICE | ||
- | BELL | ||
- | BLEVEL | ||
- | BOOTWIN | ||
- | CHATALIAS | ||
- | CHATCALL | ||
- | CHATLINKS | ||
- | CHATLOG | ||
- | CHATPORT | ||
- | CHATQUAL | ||
- | COMMAND | ||
- | CONSOLE | ||
- | CONTACT | ||
- | CTEXT Text sent to a users upon connection | ||
- | CTFLAGS | ||
- | CTRLADDR | ||
- | DEFAULTLANG | ||
- | DCACHE | ||
- | DISCARDPORT | ||
- | DNS Domain Name Server to use (internal) | ||
- | DOMAIN | ||
- | DXFLAGS | ||
- | ECHOPORT | ||
- | ENABLE_LINKED | ||
- | EXCLUDE | ||
- | FINGERPORT | ||
- | FTPPORT | ||
- | HAAT | ||
- | HAMLIBPORT | ||
- | HIDENODES | ||
- | HOSTNAME | ||
- | HTTPPORT | ||
- | HTTPROOT | ||
- | IDINTERVAL | ||
- | IDLETIME | ||
- | IDTEXT | ||
- | IGATE Controls whether Igate starts at boot up (0) | ||
- | INFOTEXT | ||
- | INPBCINTERVAL | ||
- | INTERFACE | ||
- | IPADDRESS | ||
- | IPENCAP | ||
- | IPIP | ||
- | IPTTL IP Time to live (255) | ||
- | IPUDPPORT | ||
- | KILONFWD | ||
- | L3BUDLEVEL | ||
- | L3EXCLUDE | ||
- | L3RTTINTERVAL | ||
- | L3TTL NetRom layer 3 Time To Live (25) | ||
- | L4DELAY | ||
- | L4RETRIES | ||
- | L4T3 L4 link check interval in secs (840) | ||
- | L4TIMEOUT | ||
- | L4WINDOW | ||
- | LATITUDE | ||
- | LOCATOR | ||
- | LOG Controls activity logging level (0) | ||
- | LONGITUDE | ||
- | MAPCOMMENT | ||
- | MAPSERVADDR | ||
- | MAPSERVPORT | ||
- | MAXARP | ||
- | MAXCIRCUITS | ||
- | MAXHOPS | ||
- | MAXLINKS | ||
- | MAXNODES | ||
- | MAXROUTES | ||
- | MAXSESSIONS | ||
- | MAXTCP | ||
- | MAXTT Maximum Trip Time in secs (500) | ||
- | MINQUAL | ||
- | MQTTSERVADDR | ||
- | MQTTSERVPORT | ||
- | NFTPROOT | ||
- | NODEALIAS | ||
- | NODECALL | ||
- | NODESINTERVAL | ||
- | NUMCONOLES | ||
- | OBSINIT | ||
- | OBSMIN | ||
- | PACLEN | ||
- | PMSALIAS | ||
- | PMSCALL | ||
- | PMSHADDR | ||
- | PMSQUAL | ||
- | PORT * Begins a port definition block | ||
- | PROMPTCOLOR | ||
- | PROXY Defines a NetRom proxy | ||
- | QUALADJUST | ||
- | QTH Location of this node (empty) | ||
- | RADIO Begins a RADIO definition block | ||
- | RHPPORT | ||
- | RIGSRVPORT | ||
- | RLOGINPORT | ||
- | ROUTES | ||
- | ROWS | ||
- | SESSLIMIT | ||
- | SOCKSPORT | ||
- | SORTBYCALL | ||
- | SYNCACHELIFE | ||
- | SYNCACHESIZE | ||
- | T3 AX25 link check timer in secs (180) | ||
- | TELNETPORT | ||
- | TELPROXYPORT | ||
- | TEXTCOLOR | ||
- | TTYLINKPORT | ||
- | UIFLOOD | ||
- | UITRACE | ||
- | WARNCOLOR | ||
- | WXFILE | ||
- | |||
- | |||
- | </ | ||
- | The following keywords are accepted in the APPL blocks: | ||
- | |||
- | APPLALIAS | ||
- | APPLCALL | ||
- | APPLFLAGS | ||
- | APPLNAME | ||
- | APPLQUAL | ||
- | APPLTYPE | ||
- | ENDAPPL | ||
- | |||
- | |||
- | </ | ||
- | The following keywords are accepted in CONSOLE blocks: | ||
- | |||
- | ACTIONCOLOR | ||
- | BOTWINBGCOLOR | ||
- | BOTWINTXTCOLOR | ||
- | CAPTIONCOLOR | ||
- | CMDWINBGCOLOR | ||
- | CMDWINTXTCOLOR | ||
- | CONSOLECALL | ||
- | CONSOLELANG | ||
- | ECHOCOLOR | ||
- | ENDCONSOLE | ||
- | MIDWINBGCOLOR | ||
- | MIDWINTXTCOLOR | ||
- | MMASK Flags specifying protocols to trace (3f8) | ||
- | MPORTS | ||
- | PROMPTCOLOR | ||
- | REVIEW | ||
- | RXCOLOR | ||
- | TOPWINBGCOLOR | ||
- | TOPWINTXTCOLOR | ||
- | TXCOLOR | ||
- | WARNCOLOR | ||
- | |||
- | </ | ||
- | The following keywords are accepted in INTERFACE blocks: | ||
- | |||
- | APPLNUM | ||
- | CHANNEL | ||
- | CHANNELS | ||
- | COM COM number | ||
- | CONFIG | ||
- | ENDINTERFACE | ||
- | ETHADDR | ||
- | FLOW Flow control options (async only) | ||
- | ID Interface identification string | ||
- | INTNUM | ||
- | IOADDR | ||
- | KISSOPTIONS | ||
- | MTU * Maximum Transmission Unit | ||
- | PROTOCOL | ||
- | RADIO Radio number associated with interface | ||
- | SPEED | ||
- | TYPE * Type of hardware | ||
- | |||
- | </ | ||
- | The following keywords are accepted in PORT blocks: | ||
- | |||
- | APPLMASK | ||
- | APRSPATH | ||
- | BCAST List of destinations for " | ||
- | BCFROM | ||
- | CFLAGS | ||
- | CHANNEL | ||
- | CHATALIAS | ||
- | CHATCALL | ||
- | CTEXT Port override for global ctext | ||
- | CTFLAGS | ||
- | CWID Text to send in CW every 30' (SCC only) | ||
- | DHCP Enables / disables DHCP client (0) | ||
- | DIGIFLAG | ||
- | DIGIPORT | ||
- | DYNDNS | ||
- | ENDPORT | ||
- | EXCLUDE | ||
- | FEC | ||
- | FRACK AX25 Frame Acknowledgement time ms (7000) | ||
- | FREQUENCY | ||
- | FULLDUP | ||
- | ID * Text to identify port on ports display | ||
- | IDPATH | ||
- | IDTEXT | ||
- | INITSTR | ||
- | INTERFACENUM | ||
- | INTERLOCK | ||
- | IPADDRESS | ||
- | IPLINK | ||
- | MAXFRAME | ||
- | MAXHOPS | ||
- | MAXTT Port override for global MAXTT | ||
- | MHEARD | ||
- | MHFLAGS | ||
- | MINQUAL | ||
- | MINTXQUAL | ||
- | NETMASK | ||
- | NODESINTERVAL | ||
- | PACLEN | ||
- | PERSIST | ||
- | PIPE Creates a "frame pipe" to another port | ||
- | PIPEFLAG | ||
- | PMSALIAS | ||
- | PMSCALL | ||
- | PORTALIAS | ||
- | PORTALIAS2 | ||
- | PORTCALL | ||
- | PROXY | ||
- | QUALITY | ||
- | RESPTIME | ||
- | RETRIES | ||
- | RFBAUDS | ||
- | SESSLIMIT | ||
- | SLOTTIME | ||
- | SOFTDCD | ||
- | SYSOP If 1, all users on this port are sysops (0) | ||
- | TXDELAY | ||
- | TXPORT | ||
- | TXTAIL | ||
- | UDPLOCAL | ||
- | UDPREMOTE | ||
- | UNPROTO | ||
- | USERS Max simultaneous users on this port (255) | ||
- | VALIDCALLS | ||
- | |||
- | </ | ||
- | The following keywords are accepted in RADIO blocks: | ||
- | |||
- | BAUDS Baud rate for the TTY (not for Hamlib). | ||
- | COM TTY device name / IP address: | ||
- | ENDRADIO | ||
- | FREQUENCY | ||
- | MODE Initial modulation mode. | ||
- | NAME Name / Description for the radio | ||
- | OFFSET | ||
- | PTTMETHOD | ||
- | RXAUDIODEV | ||
- | SQUELCH | ||
- | STOPBITS | ||
- | TXFREQ | ||
- | TYPE Type number of radio | ||
- | VOLUME | ||
- | |||
- | </ | ||
- | XROUTER.CFG must be located in the same directory as the | ||
- | XRouter executable. | ||
- | |||
- | </ | ||
- | APPLS(9) | ||
- | IFACES(6) -- Interfaces in XRouter. | ||
- | PORTS(6) | ||
- | RADIO(7) | ||
- | |||
- | </ | ||
- | ---- | ||
- | =====XWEB.CLASS.MAN===== | ||
- | < | ||
- | </ | ||
- | XWEB.CLASS -- Java Applet. | ||
- | |||
- | </ | ||
- | (The following is also in the HTTP-SRV manual page) | ||
- | |||
- | The Java applet XWEB.CLASS can be used to connect to XRouter | ||
- | with a web browser. | ||
- | |||
- | The distribution archive contains the applet file, plus 3 | ||
- | rudimentary .HTM pages for you to examine or experiment with. | ||
- | |||
- | CONNECT.HTM is the menu page for 3 types of connection, and | ||
- | would typically be accessed via a " | ||
- | page. You may however wish to put the 3 connect options | ||
- | directly on the main page - it's up to you. | ||
- | |||
- | CONN23.HTM uses the Java applet to perform a normal telnet | ||
- | connect to port 23. The port number is configurable (see | ||
- | below), so you could clone the page for use with your chat | ||
- | server. | ||
- | |||
- | CONN80.HTM uses the Java applet to perform a " | ||
- | connection, which can be used via corporate firewalls which | ||
- | block normal Telnet. | ||
- | |||
- | If you wish to the above files and the applet, they must be | ||
- | located within the HTTP tree. | ||
- | |||
- | You can change the applet colours and font, the number of | ||
- | rows and columns displayed, and the connection mode (normal | ||
- | TELNET, or HTTP tunnel), using < | ||
- | For example: <PARAM NAME=" | ||
- | |||
- | The parameters which can be specified are as follows: | ||
- | |||
- | Param name | ||
- | rows | ||
- | cols | ||
- | bgcolour | ||
- | borderColour | ||
- | textBackground Black Background for text/cmd windows. | ||
- | textColour | ||
- | font | ||
- | port | ||
- | mode | ||
- | |||
- | The only mandatory parameter is " | ||
- | be 23 for a normal telnet connect or 80 for an http-tunnelled | ||
- | connect, but you may use other values if you have moved or | ||
- | translated your Telnet or HTTP ports. | ||
- | |||
- | Colours should be specified as a 24 bit hexadecimal number in | ||
- | ' | ||
- | the RED value, the second two digits represent the GREEN | ||
- | value and the last two digits represent the BLUE value. Some | ||
- | browsers can only display 216 discrete colours, so you should | ||
- | preferably use the " | ||
- | formed from combinations of 00, 33, 66, 99, CC and FF. | ||
- | |||
- | The default font is quite small, and the characters are not | ||
- | of a constant width, which means tables sent by XRouter will | ||
- | not line up correctly. | ||
- | override the default. | ||
- | which is slightly larger and uses constant width characters. | ||
- | Note: if the chosen font is not found on the client' | ||
- | their default font will be used, so stick to the common ones. | ||
- | |||
- | You may need to reduce the number of rows or columns | ||
- | displayed by the applet if you find it won't fit on a 640*480 | ||
- | screen. It fits nicely on 800*600, but you may wish to | ||
- | optimise it for another screen size, or even offer users the | ||
- | choice. | ||
- | |||
- | If you change the font, rows or cols, you may need to tweak | ||
- | the WIDTH and HEIGHT attributes in the APPLET tag to prevent | ||
- | parts of the applet from being obscured. | ||
- | |||
- | </ | ||
- | HTTP-SRV(9) -- HTTP Server. | ||
- | |||
- | </ | ||
- | ---- |
packet/xrpi/manpages/section8.1745063656.txt.gz · Last modified: 2025/04/19 11:54 by m0mzf