more work on documentation

This commit is contained in:
Andrew Pamment 2018-02-06 18:05:46 +10:00
parent 37a00b7d1f
commit 622b4804f4
3 changed files with 113 additions and 0 deletions

View File

@ -0,0 +1,31 @@
# Native Doors
Native doors for Linux/UN\*X are easy to set up. Magicka can run doors in two modes, *STDIO* mode and *Socket Inheritance* Mode. STDIO mode is the best as it will work on SSH as well as telnet.
## Script Files
To run a door, you should generally use a script file, as the BBS passes 2 options in specific order first, the node, and second in case of socket inheritance the socket number.
A typical script for running a door might look like this:
#!/bin/sh
NODE=$1
SOCKET=$2
cd /path/to/door
./somedoor -D /path/to/BBS/node${NODE}/door.sys
In addition to native doors, you can also run native programs as doors. You need to be careful with this though, as an incorrectly set up program could allow the user access to your file system.
The following script will telnet the user to exotica BBS
#!/bin/sh
telnet -E exoticabbs.com 2023
The -E switch causes telnet to have no "Escape" key, ie, the user cant break out of the connection and connect to arbitary systems.
## BBS Configuration
To actually run the door from the BBS, you will need to create an entry in your doors.ini, and add a menu item for that entry in the menu you want to launch it from. See doors.ini under INI files, and Menu Editing for more details.

View File

@ -0,0 +1,69 @@
# Magimail configuration
TODO.
## Example magimail.prefs file
SYSOP "Your Name"
BBSNAME "Some BBS"
BROADCAST 192.168.1.255 2025
LOGFILE "/path/to/MagickaBBS/logs/magimail.log"
LOGLEVEL 3
DUPEFILE "/path/to/MagickaBBS/ftn/dupes.log" 200
DUPEMODE BAD
LOOPMODE LOG+BAD
MAXPKTSIZE 50
MAXBUNDLESIZE 100
DEFAULTZONE 637
INBOUND "/path/to/MagickaBBS/ftn/in_sec"
OUTBOUND "/path/to/MagickaBBS/ftn/out"
TEMPDIR "/path/to/MagickaBBS/ftn/cm_temp"
CREATEPKTDIR "/path/to/MagickaBBS/ftn/cm_temp"
PACKETDIR "/path/to/MagickaBBS/ftn/cm_packets"
STATSFILE "/path/to/MagickaBBS/ftn/magimail.stats"
FORCEINTL
ANSWERRECEIPT
ANSWERAUDIT
CHECKSEENBY
PATH3D
IMPORTAREAFIX
IMPORTSEENBY
AREAFIXREMOVE
WEEKDAYNAMING
ADDTID
ALLOWRESCAN
INCLUDEFORWARD
ALLOWKILLSENT
GROUPNAME A "happynet"
PACKER "ZIP" "zip -j %a %f" "unzip -j %a" "PK"
AKA 637:1/999
DOMAIN happynet
NODE 637:1/100 "ZIP" "" AUTOADD PACKNETMAIL
DEFAULTGROUP A
ROUTE "637:*/*.*" "637:1/100.0" 637:1/999
JAM_HIGHWATER
JAM_LINK
JAM_QUICKLINK
JAM_MAXOPEN 5
NETMAIL "NETMAIL" 637:1/999 JAM "/path/to/MagickaBBS/msgs/hpy_netmail"
AREA "BAD" 637:1/999 JAM "/path/to/MagickaBBS/msgs/bad"
AREA "DEFAULT_A" 637:1/999 JAM "/path/to/MagickaBBS/msgs/%l"
AREA "HPY_GEN" 637:1/999.0 JAM "/path/to/MagickaBBS/msgs/hpy_gen"
EXPORT %637:1/100.0
GROUP A

View File

@ -0,0 +1,13 @@
# Nodelists and Magicka
To use nodelist functionality in Magicka, you need to import your nodelists into the **nodelists.sq3** database which lives in your main BBS directory.
You can import nodelists using the nodelistp.pl script in the utils folder.
For example:
./utils/nodelistp/nodelistp.pl nodelists/FSXNET.033 nodelists.sq3 fsxnet
The first argument is the nodelist you want to import, the second argument is the nodelists.sq3 database (and path if you're running it from another directory), the third argument is the domain you set up for the network in the conference INI file.
Importing two nodelists of the same domain will cause the first one to be wiped out and replaced by the second.