This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
magicka/README.md

80 lines
2.5 KiB
Markdown
Raw Normal View History

2016-08-04 21:34:32 +00:00
# README!!
2016-08-05 09:55:14 +00:00
If you are upgrading from a version prior to https://github.com/apamment/MagickaBBS/commit/73aa146b8470727f036f732d2c9c267048ee455b You will need to make and run the update_pass utility on your
2016-08-04 21:34:32 +00:00
user database. This will convert all plain text passwords to sha256 hashed and salted passwords.
eg.
cd utils/update_pass
make
./update_pass ../../users.sq3
Although you probably should make a backup of your database first in case things go wrong...
2016-03-22 01:58:52 +00:00
# MagickaBBS
2016-04-09 06:17:07 +00:00
Linux/FreeBSD bulletin board system (Should also work on NetBSD and OpenBSD, 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!
Magicka is meant to be a modern (haha) BBS system, using modern technologies, like Sqlite3, IRC, 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.
If you want to install Magicka BBS, follow these steps.
2016-08-04 21:34:32 +00:00
1. Ensure you have git, c compiler, libsqlite3-dev, libreadline-dev, libssl-dev and gnu make
`sudo apt-get install build-essential libsqlite3-dev libreadline-dev git libssl-dev`
should work on debian and debian derivatives.
2016-03-23 08:43:44 +00:00
2. Clone the repo `git clone https://github.com/apamment/MagickaBBS`
3. Build JamLib
2016-03-25 00:58:57 +00:00
`cd MagickaBBS/jamlib`
2016-08-04 21:34:32 +00:00
2016-04-09 06:17:07 +00:00
`make -f Makefile.linux` (Linux) `gmake -f Makefile.linux` (*BSD)
2016-03-25 00:58:57 +00:00
2016-04-03 01:07:20 +00:00
3. Build libzmodem
`cd MagickaBBS/Xmodem`
2016-08-04 21:34:32 +00:00
2016-04-09 06:17:07 +00:00
`make` (Linux) `gmake` (*BSD)
2016-08-04 21:34:32 +00:00
2016-04-14 00:42:22 +00:00
4. Build LUA
`cd MagickaBBS/lua`
`make linux` (Linux) `gmake freebsd` (FreeBSD)
2016-08-04 21:34:32 +00:00
2016-04-03 01:07:20 +00:00
5. Build the BBS (You may have to adjust the Makefile for your system)
2016-04-14 00:42:22 +00:00
`make -f Makefile.linux` (Linux) `gmake -f Makefile.freebsd` (FreeBSD)
2016-08-04 21:34:32 +00:00
2016-04-14 00:42:22 +00:00
6. Make a directory for logs.
2016-08-04 21:34:32 +00:00
2016-04-14 00:42:22 +00:00
`mkdir logs`
7. Copy the config-default directory to a config directory.
`cp -r config_default config`
2016-04-14 00:42:22 +00:00
8. Edit the config files and update essential information, like system paths and BBS name etc
9. Copy the ansi-default directory to the one specified in your system path
2016-03-23 08:41:45 +00:00
eg.
2016-08-04 21:34:32 +00:00
`cp -r ansi_default ansis`
2016-04-14 00:42:22 +00:00
10. Run Magicka BBS on a port over 1024 (Below require root, and we're not ready for that).
2016-03-23 08:40:40 +00:00
`./magicka config/bbs.ini 2300`
2016-08-04 21:34:32 +00:00
11. Your BBS is now running on port 2300, 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
For information on how to configure your BBS, check the wiki https://github.com/apamment/MagickaBBS/wiki