bbs/magicka
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Mess with formatting in README

Browse Source
This commit is contained in:
Andrew Pamment 2017-09-17 12:26:36 +10:00
parent 94f3678cd4
commit 4e52eaca54
1 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -2,7 +2,7 @@
[![Build Status](https://build.magickabbs.com/buildStatus/icon?job=MagickaBBS-Linux)](https://build.magickabbs.com/job/MagickaBBS-Linux) [![Build Status](https://build.magickabbs.com/buildStatus/icon?job=MagickaBBS-Linux)](https://build.magickabbs.com/job/MagickaBBS-Linux)
Linux/FreeBSD bulletin board system (Should also work on NetBSD and OpenBSD, if it doesn't it's a bug) Linux/FreeBSD bulletin board system (Should also work on NetBSD and Mac OS X, if it doesn't it's a bug)
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 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
lose it again! lose it again!
@ -14,7 +14,7 @@ If you want to install Magicka BBS, follow these steps.
1. Ensure you have git, c compiler, libsqlite3-dev, libreadline-dev, libssl-dev, libssh-dev libncurses5-dev and gnu make 1. Ensure you have git, c compiler, libsqlite3-dev, libreadline-dev, libssl-dev, libssh-dev libncurses5-dev and gnu make
`sudo apt-get install build-essential libsqlite3-dev libreadline-dev git libssl-dev libssh-dev libncurses5-dev` sudo apt-get install build-essential libsqlite3-dev libreadline-dev git libssl-dev libssh-dev libncurses5-dev
should work on debian and debian derivatives. should work on debian and debian derivatives.
2. Clone the repo `git clone https://github.com/MagickaBBS/MagickaBBS` 2. Clone the repo `git clone https://github.com/MagickaBBS/MagickaBBS`
@ -25,43 +25,43 @@ If you want to install Magicka BBS, follow these steps.
4. Make a directory for logs. 4. Make a directory for logs.
`mkdir logs` mkdir logs
5. Copy the config-default directory to a config directory. 5. Copy the config-default directory to a config directory.
`cp -r config_default config` cp -r config_default config
6. Edit the config files and update essential information, like system paths and BBS name etc 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 7. Copy the ansi-default directory to the one specified in your system path
eg. eg.
`cp -r ansi_default ansis` cp -r ansi_default ansis
8. Copy the menus-default directory to the one specified in your system path 8. Copy the menus-default directory to the one specified in your system path
eg. eg.
`cp -r menus_default menus` cp -r menus_default menus
9. Magicka also include optional lua scripts for menus and login / logoff. If you want to use these, copy 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. the scripts-examples to the one specified in your system path.
eg. eg.
`cp -r scripts_examples scripts` cp -r scripts_examples scripts
10. If you are going to run SSH, you will need to create keys. To do this 10. If you are going to run SSH, you will need to create keys. To do this
`mkdir keys` mkdir keys
`ssh-keygen -f keys/ssh_host_rsa_key -N '' -t rsa` ssh-keygen -f keys/ssh_host_rsa_key -N '' -t rsa
`ssh-keygen -f keys/ssh_host_dsa_key -N '' -t dsa` ssh-keygen -f keys/ssh_host_dsa_key -N '' -t dsa
11. Run Magicka BBS on a port over 1024 (Below require root, and we're not ready for that). 11. Run Magicka BBS on a port over 1024 (Below require root, and we're not ready for that).
`./magicka config/bbs.ini` ./magicka config/bbs.ini
12. 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, 12. 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,
but you will need to use an SQLite Manager to modify users.sq3 and set security levels, as there is no user editor yet. but you will need to use an SQLite Manager to modify users.sq3 and set security levels, as there is no user editor yet.
@ -71,9 +71,8 @@ For information on how to configure your BBS, check the wiki https://github.com/
# About the webserver # 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 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
need a recent version of libmicrohttpd (raspbian doesn't have a recent enough version, and you will need to build it from source). need a recent version of libmicrohttpd. Once you have these prerequisites, you can build magicka with `make -f Makefile.linux.WWW`
Once you have these prerequisites, you can build magicka with `make -f Makefile.linux.WWW` or `make -f Makefile.freebsd.WWW` be or `make -f Makefile.freebsd.WWW` be sure to do this from a clean source tree.
sure to do this from a clean source tree.
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. 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.