-------------------------------------------
SlightBBS - Simple, Light telnet BBS in PHP
-------------------------------------------
Version 0.91
MIT license, Joe Lyman, tfurrows@sdf.org

[ABOUT]
bbs.php is an sdf.org BBoard style telnet BBS for Linux. It
is not a "clone" but a "bboard inspired" project. Really, 
this is for anyone that wants a simple/light bulletin board 
answering on a telnet port.

This is a flatfile/directory based project, to keep 
dependencies somewhat light (if you call CLI PHP light.)

For information on how the board works from a user
perspective, read the "help" and "help2" files included
in the "bbs/docs" folder.

The source is released under the MIT license for you to use 
as you like. Try it out live at jozhaus.com port 2323. Make
sure to leave a comment in the Guestbook.  


[DIRECTORY STRUCTURE]
The "bbs" folder is where all of your bbs content will be
stored. You must set the full path of your bbs root in
the bbs.php file.

- "docs" folder:
This folder holds ascii (with ansi codes if you want) text
files that are served up at various points by the system.
The files are self-explanatory, change them as needed.

- "boards" folder:
This folder contains various "board" sub-directories. If you
want to add a board, just create a folder. Names should be
all upper-case.

- "boards" sub-folders:
Inside each of the board sub-folders you'll find a file named
"topic." It should have one line of text, which is the topic
of the board. You'll also find sub-directories here, which
represent posts. Inside those post sub-directories, you'll
find text files, which are the posts themselves. The first
post file is named "original."


[INSTALL]
1. Move the "bbs" folder where you want it to reside. The
directory structure comes with some content so you can see
how it works.

2. Open the bbs.php file and set your variables properly, set 
the bbs.php file executable. Move the bbs.php file somewhere
where inetd/xinetd will run it.

3. Setup your inetd/xinetd or other solution to answer on 
the port of your choice with the bbs.php program. You may also
want to setup a "bbs" user/group on your system with a
secure password and no shell access. Detailed instructions
for how to do this for your particular system are available
online.

4. The "bbs" folder needs to be writeable by the user that
you are running the program through. The entire "bbs" folder
tree should be owned by the "bbs" user you create as well.
Inside the "bbs" folder, you should set the permissions on
the "codes" and "validated" files so they are not world
readable; only the bbs user needs read access.

