2016-03-22 01:58:52 +00:00
# MagickaBBS
2017-03-17 05:30:14 +00:00
2017-09-17 02:26:36 +00:00
Linux/FreeBSD bulletin board system (Should also work on NetBSD and Mac OS X, if it doesn't it's a bug)
2016-03-22 01:58:52 +00:00
2016-04-09 06:17:07 +00:00
As I lost the code to my initial BBS flea, I've decided to start over from scratch and this time I'm using git hub so I dont
2016-03-22 01:58:52 +00:00
lose it again!
2017-09-22 10:16:08 +00:00
Magicka is meant to be a modern (haha) BBS system, using modern technologies, like Sqlite3, long filenames (gasp!) etc
2016-03-22 01:58:52 +00:00
while still retaining the classic BBS feel. ANSI & Telnet, and good old ZModem.
2016-03-23 08:34:34 +00:00
If you want to install Magicka BBS, follow these steps.
2017-03-23 07:30:33 +00:00
1. Ensure you have git, c compiler, libsqlite3-dev, libreadline-dev, libssl-dev, libssh-dev libncurses5-dev and gnu make
2016-08-04 21:34:32 +00:00
2017-09-17 02:26:36 +00:00
sudo apt-get install build-essential libsqlite3-dev libreadline-dev git libssl-dev libssh-dev libncurses5-dev
2016-08-04 21:34:32 +00:00
2016-04-14 01:30:06 +00:00
should work on debian and debian derivatives.
2016-12-13 07:07:26 +00:00
2. Clone the repo `git clone https://github.com/MagickaBBS/MagickaBBS`
2016-03-23 08:34:34 +00:00
2017-03-18 04:45:39 +00:00
3. Build the BBS (You may have to adjust the Makefile for your system)
2016-08-04 21:34:32 +00:00
2017-09-25 03:43:58 +00:00
`make`
2016-08-04 21:34:32 +00:00
2017-03-18 04:45:39 +00:00
4. Make a directory for logs.
2016-08-04 21:34:32 +00:00
2018-01-18 09:36:45 +00:00
`mkdir logs`
2016-04-14 00:42:22 +00:00
2017-03-18 04:45:39 +00:00
5. Copy the config-default directory to a config directory.
2016-03-23 08:34:34 +00:00
2018-01-18 09:36:45 +00:00
`cp -r dist/config config`
2016-03-23 08:34:34 +00:00
2017-03-18 04:45:39 +00:00
6. Edit the config files and update essential information, like system paths and BBS name etc
7. Copy the ansi-default directory to the one specified in your system path
2016-03-23 08:34:34 +00:00
2017-04-14 04:42:14 +00:00
eg.
2016-08-04 21:34:32 +00:00
2018-01-18 09:36:45 +00:00
`cp -r dist/ansis ansis`
2016-04-14 00:42:22 +00:00
2017-09-17 02:02:45 +00:00
8. Copy the menus-default directory to the one specified in your system path
eg.
2018-01-18 09:36:45 +00:00
`cp -r dist/menus menus`
2017-09-17 02:02:45 +00:00
9. Magicka also include optional lua scripts for menus and login / logoff. If you want to use these, copy
the scripts-examples to the one specified in your system path.
eg.
2018-01-18 09:36:45 +00:00
`cp -r dist/scripts scripts`
2017-09-17 02:02:45 +00:00
2018-01-18 09:34:15 +00:00
10. Make a link to the magicka.strings (or copy it if you want to modify it)
2018-01-18 09:36:45 +00:00
eg.
2018-01-18 09:34:15 +00:00
2018-01-18 09:36:45 +00:00
`ln -s dist/magicka.strings magicka.strings`
2018-01-18 09:34:15 +00:00
11. If you are going to run SSH, you will need to create keys. To do this
2016-04-14 00:42:22 +00:00
2018-01-18 09:36:45 +00:00
`mkdir keys`
2016-08-07 09:48:49 +00:00
2018-01-18 09:36:45 +00:00
`ssh-keygen -f keys/ssh_host_rsa_key -N '' -t rsa`
2016-08-07 09:48:49 +00:00
2018-01-18 09:36:45 +00:00
`ssh-keygen -f keys/ssh_host_dsa_key -N '' -t dsa`
2016-04-14 00:42:22 +00:00
2018-01-18 09:34:15 +00:00
12. Run Magicka BBS on a port over 1024 (Below require root, and we're not ready for that).
2016-03-23 08:34:34 +00:00
2018-01-18 09:36:45 +00:00
`./magicka config/bbs.ini`
2016-08-04 21:34:32 +00:00
2018-01-18 09:34:15 +00:00
13. Your BBS is now running on the port you specified in the config.ini, log in and create yourself an account! (By default there is only one security level, you can add more,
2016-03-23 08:52:31 +00:00
but you will need to use an SQLite Manager to modify users.sq3 and set security levels, as there is no user editor yet.
2016-04-09 06:17:07 +00:00
2016-12-13 07:07:26 +00:00
For information on how to configure your BBS, check the wiki https://github.com/MagickaBBS/MagickaBBS/wiki
2016-08-22 05:12:42 +00:00
# About the webserver
Magicka now includes a built in webserver based on libmicrohttpd. It is not built by default, if you'd like to build it you will
2017-09-25 03:43:58 +00:00
need a recent version of libmicrohttpd. Once you have these prerequisites, you can build magicka with `make www`
be sure to do this from a clean source tree.
2016-08-22 05:12:42 +00:00
The webserver will use templates in the www/ folder to create internal webpages on the fly, anything in www/static/ is served up as is.
2017-09-22 10:16:08 +00:00
# Misc Notes:
* FreeBSD requires libiconv to be installed from ports in addition to other dependencies. It also requires `ipv6_ipv4mapping="YES"` to be set in rc.conf
* macOS makefiles are intended to be built with dependencies provided by macports, homebrew support will require significant changes.
* NetBSD requires libiconv to be installed from pkgsrc in addition to other dependencies. It also requires `net.inet6.ip6.v6only=0` to be set in sysctl.conf
