work on documentation.

docs/docs/guide/msgs/ftn/binkd.md

@@ -0,0 +1,164 @@
+# Installing and configuring BinkD
+
+## Installation
+
+Magicka does not include binkd, you have to get it and install it yourself. You could use a package, but packages aren't available on all platforms, so this is how to install it from source.
+
+First clone the repo:
+
+    git clone https://github.com/pgul/binkd
+
+Next configure binkd:
+
+    cd binkd
+    cp -r mkfls/unix/* .
+    ./configure
+
+Then build
+
+    make
+
+And install into /usr/local/sbin
+
+    sudo make install
+
+## Configuration
+
+First, make the following subdirectories in the MagickaBBS directory:
+
+    mkdir -p ftn/out
+    mkdir -p ftn/in_sec
+    mkdir -p ftn/in
+    mkdir -p ftn/in_temp
+
+
+Next you need to create a configuration file which will be used when running the program.
+
+I place mine in `MagickaBBS/ftn/binkd.conf`
+
+The following sample configuration is an example of a single network setup, feel free to copy it and substitute your details.
+
+### Sample Configuration
+
+    # Number @ end is the root zone
+    domain happynet /path/to/MagickaBBS/ftn/out 637
+
+
+    # Our HappyNet address
+    address 637:1/999@happynet
+
+    sysname "Super BBS"
+    location "Somewhere"
+    sysop "Your Name"
+
+    nodeinfo 115200,TCP,BINKP
+    try 10
+    hold 600
+    send-if-pwd
+
+    log /path/to/MagickaBBS/logs/binkd.log
+    loglevel 4
+    conlog 4
+    percents
+    printq
+    backresolv
+
+    inbound /path/to/MagickaBBS/ftn/in_sec
+    inbound-nonsecure /path/to/MagickaBBS/ftn/in
+    temp-inbound /path/to/MagickaBBS/ftn/in_temp
+
+    minfree 2048
+    minfree-nonsecure 2048
+
+    kill-dup-partial-files
+    kill-old-partial-files 86400
+
+    prescan
+
+    # Happynet HUB
+    node 637:1/100@happynet -md hnet.magickabbs.com:24554 SECRET c
+
+    # our listening port (default=24554)
+    iport 24554
+
+    pid-file /path/to/MagickaBBS/ftn/binkd.pid
+
+    # touch a watch file when files are received to kick of toss
+    exec "/path/to/MagickaBBS/ftn/magitoss.sh"  *.[mwtfs][oehrau][0-9a-zA-Z] *.pkt
+    exec "/path/to/MagickaBBS/ftn/ticproc.sh" *.tic *.TIC
+
+    # nuke old .bsy/.csy files after 24 hours
+    kill-old-bsy 43200
+
+NOTE: `magitoss.sh` and `ticproc.sh` will be detailed in the magimail setup guide and the tic file processing setup guide.
+
+## Configuring for multiple networks
+
+If you want to be a member of multiple networks, you need additional domain, address and node lines. See the following example for HappyNet and FSXNet
+
+### Sample Configuration
+
+    # Number @ end is the root zone
+    domain happynet /path/to/MagickaBBS/ftn/out 637
+    domain fsxnet /path/to/MagickaBBS/ftn/fsxnet 637
+
+    # Our HappyNet address
+    address 637:1/999@happynet
+    # Our FSXNet Address
+    address 21:1/999@fsxnet
+
+    sysname "Super BBS"
+    location "Somewhere"
+    sysop "Your Name"
+
+    nodeinfo 115200,TCP,BINKP
+    try 10
+    hold 600
+    send-if-pwd
+
+    log /path/to/MagickaBBS/logs/binkd.log
+    loglevel 4
+    conlog 4
+    percents
+    printq
+    backresolv
+
+    inbound /path/to/MagickaBBS/ftn/in_sec
+    inbound-nonsecure /path/to/MagickaBBS/ftn/in
+    temp-inbound /path/to/MagickaBBS/ftn/in_temp
+
+    minfree 2048
+    minfree-nonsecure 2048
+
+    kill-dup-partial-files
+    kill-old-partial-files 86400
+
+    prescan
+
+    # Happynet HUB
+    node 637:1/100@happynet -md hnet.magickabbs.com:24554 SECRET c
+
+    # FSXNet HUB
+    node 21:1/100@fsxnet -md ipv4.agency.bbs.geek.nz:24556 LETMEIN c
+
+    # our listening port (default=24554)
+    iport 24554
+
+    pid-file /path/to/MagickaBBS/ftn/binkd.pid
+
+    # touch a watch file when files are received to kick of toss
+    exec "/path/to/MagickaBBS/ftn/magitoss.sh"  *.[mwtfs][oehrau][0-9a-zA-Z] *.pkt
+    exec "/path/to/MagickaBBS/ftn/ticproc.sh" *.tic *.TIC
+
+    # nuke old .bsy/.csy files after 24 hours
+    kill-old-bsy 43200
+
+NOTE: `magitoss.sh` and `ticproc.sh` will be detailed in the magimail setup guide and the tic file processing setup guide.
+
+## Running Binkd
+
+To run binkd, simply execute:
+
+    /usr/local/sbin/binkd /path/to/MagickaBBS/ftn/binkd.conf
+
+You could run this in screen, or setup a service for your OS.

docs/docs/guide/msgs/ftn/config.md

@@ -0,0 +1,43 @@
+# Configuring FTN Message Bases
+
+FTN Message base configuration is similar to Local bases, except they include an extra network section, and networked = true in the main section.
+
+Here is an example included in the default install.
+
+    [main]
+    Visible Sec Level = 10
+    Networked = true
+    Real Names = false
+
+    [network]
+    type = fido
+    fido node = 637:1/999
+    domain = happynet
+
+    [General]
+    Read Sec Level = 10
+    Write Sec Level = 10
+    Path = /home/andrew/MagickaBBS/msgs/hnet_general
+    Type = Echo 
+    QWK Name = HN_GEN
+
+    [Netmail]
+    Read Sec Level = 10
+    Write Sec Level = 10
+    Path = /home/andrew/MagickaBBS/msgs/hnet_netmail
+    Type = Netmail
+    QWK Name = HN_NET
+
+The network block contains the following:
+
+**Type** This equals fido for fidonet style networks. It is currently the only option.
+
+**Fido Node** This is your fidonet style network's node number (May or may not include a point.)
+
+**Domain** This is the domain of the fidonet network, currently used to distinguish which node numbers belong to which network in the nodelists.sq3 database.
+
+**Tagline** This is optional and can be used to set network specific taglines.
+
+The area sections are identical to local mail, with the exception that Type should equal "Echo" or "Netmail" depending on the area type.
+
+This is all for setting up networked bases in magicka, however you will still need to configure magimail and binkd.

docs/docs/guide/msgs/local.md

@@ -0,0 +1,51 @@
+# Local Message Bases
+
+Local message bases are the easiest to set up, as they do not require any other utilities to work.
+
+First you need a conference for your local bases, there is an example conference set up with to areas defined in the default install.
+
+The conference which contains the areas is defined in it's own ini file which is linked to in the bbs.ini file.
+
+Here the example for local bases:
+
+    [main]
+    Visible Sec Level = 10
+    Networked = false
+    Real Names = false
+
+    [General]
+    Read Sec Level = 10
+    Write Sec Level = 10
+    Path = /home/andrew/MagickaBBS/msgs/general
+    Type = Local
+    QWK Name = GENERAL
+
+    [Testing]
+    Read Sec Level = 10
+    Write Sec Level = 10
+    Path = /home/andrew/MagickaBBS/msgs/testing
+    Type = Local
+    QWK Name = TEST
+
+Here you can see there is a main section which contains information about the conference itself, then sections that defines the areas.
+
+## The Main Section
+
+**Visible Sec Level** This is the security level required to view the conference. You should also ensure that the first defined area is able to be read by this security level, as it is the area that the user is dumped in when switching to the conference.
+
+**Networked** Set this to false for local bases.
+
+**Real Names** Set to true if you want to messages to be from a users "real name".
+
+## The Area Sections
+
+The section name is the name of the area.
+
+**Read Sec Level** The security level required for the user to read the area.
+
+**Write Sec Level** The security level required for the user to be able to post in the area.
+
+**Path** The path to the JAM message base files, not including extension.
+
+**QWK Name** This is a short name used to define an area in QWK/BlueWave offline mail. It must be unique. (This is presently just used for bluewave, as QWK is not yet implemented).
+