Initial commit of documentation...

This commit is contained in:
Andrew Pamment 2018-02-03 17:43:49 +10:00
parent 3ec7305cbe
commit 878a461d45
18 changed files with 72 additions and 0 deletions

View File

View File

View File

View File

View File

View File

View File

View File

View File

View File

@ -0,0 +1,41 @@
# Installation
## Install Prerequisites
Ensure you have git, c compiler, libsqlite3-dev, libreadline-dev, libssl-dev, libssh-dev libncurses5-dev, libmicrohttpd-dev, bash and gnu make
sudo apt-get install build-essential libsqlite3-dev libreadline-dev git libssl-dev libssh-dev libncurses5-dev libmicrohttpd-dev
should work on debian and debian derivatives.
## Install Magicka
Clone the repo
git clone https://github.com/MagickaBBS/MagickaBBS
Build the BBS
make www
Run setup.sh and answer the questions to install the initial configurations
./setup.sh
If you are going to run SSH, you will need to create keys. To do this
mkdir keys
ssh-keygen -f keys/ssh_host_rsa_key -N '' -t rsa
ssh-keygen -f keys/ssh_host_dsa_key -N '' -t dsa
## Run Magicka
Run BBS
./magicka config/bbs.ini
The BBS will run by default on telnet only and on port 2023. Magicka must be run on a port over 1024, the port can be configured in bbs.ini. Log on to your new bbs and create your sysop account!

0
docs/docs/guide/menus.md Normal file
View File

View File

View File

View File

View File

View File

5
docs/docs/index.md Normal file
View File

@ -0,0 +1,5 @@
# About MagickaBBS
Magicka BBS is a bulletin board system (BBS) for UN*X like systems. It is known to run on Linux, FreeBSD, NetBSD, OpenBSD, DragonFly BSD, OpenIndiana(Illumos) and macOS.
Magicka is meant to be a modern BBS system, using modern technologies, like Sqlite3, long filenames etc while still retaining the classic BBS feel. ANSI & Telnet, and good old ZModem.

26
docs/mkdocs.yml Normal file
View File

@ -0,0 +1,26 @@
site_name: MagickaBBS - Documentation
pages:
- About: 'index.md'
- Installation: 'guide/installation.md'
- Configuration:
- INI Files:
- bbs.ini: 'guide/ini/bbs.md'
- doors.ini: 'guide/ini/doors.md'
- archivers.ini: 'guide/ini/archivers.md'
- protocols.ini: 'guide/ini/protocols.md'
- s10-99.ini: 'guide/ini/seclevels.md'
- Doors:
- DOS Doors: 'guide/doors/dos.md'
- Native Doors: 'guide/doors/native.md'
- Message Bases:
- Local Bases: 'guide/msgs/local.md'
- FTN Bases:
- Configuration: 'guide/msgs/ftn/config.md'
- Binkd: 'guide/msgs/ftn/binkd.md'
- Magimail: 'guide/msgs/ftn/magimail.md'
- File Bases:
- Configuration: 'guide/files/config.md'
- TIC File Processing: 'guide/files/tic.md'
- Menu Editing: 'guide/menus.md'
- Scripting: 'guide/scripting.md'