Приглашаем посетить
WebBBS
DOCUMENTATION
WebBBS 2.14 by Darryl C. Burgdorf (burgdorf@awsd.com)
http://awsd.com/scripts/webbbs/
===========================================
WebBBS is, as the name implies, a Web-based bulletin board. Unlike
most other such boards, though, WebBBS stores messages as simple text
files and creates HTML pages "on the fly." This means that the message
index can be tailored by the user based on date and/or subject (via
built-in keyword search capability), and can be viewed as either a
chronological or a threaded list. It also means that administration is
a breeze! WebBBS supports automatic quoting of message text and e-mail
notification of those who want to know immediately when a new message
has been posted. It also offers an archive-only option and "cookie"
support!
===========================================
The files that you need are as follows:
webbbs.pl: This is the main program file. You don't actually need
to do anything to it; in fact, you don't even have to execute it.
config.pl: This is the configuration file. Most everything you need to
change or modify is contained here. This is also the file that you
will execute. (Things are set up this way so that you can effectively
maintain multiple discussion boards just by keeping separate config
files for each.)
As noted above, the WebBBS configuration file, and not the WebBBS
program itself, should be executed. The configuration file should, of
course, be set executable. Make sure that the first line of the script
matches the location of your system's Perl interpreter. As well, the
following variables need to be defined:
$dir: The absolute path (minus a trailing slash) of the directory
in which all the WebBBS files are stored. This directory must be
set world readable and world writable!
$cgiurl: The URL address of the WebBBS configuration script. If your
server setup allows it, it is probably most efficient to name this
file "index.cgi" (rather than the default config.pl) and put it in
the same directory ($dir) as the rest of the WebBBS files.
$datafile: The file which contains the current message number count.
This file must intially be created, and of course must also be
world readable and world writable.
$dupecheck_file: A file used to guard against duplicate postings. Like
everything else, it should be world readable and world writable.
$address_list: The name of the file which contains the list of e-mail
addresses to which notifications of new posts are sent. If you leave
the variable undefined, no notifications will be sent; however, even
if you don't want to allow others to receive notifications, you might
want to create the file with just your own e-mail address, so that you
know when someone posts! Again, the file must be world readable and
(at least if you want others to be able to add themselves to it) world
writable.
$maillist_address: The e-mail address from which you want e-mail
notifications to be addressed. Note that the "@" character must be
escaped with a slash (e.g., "scripts\@awsd.com").
$mailprog: The absolute path to your system's sendmail program. If
your system doesn't have "sendmail" or if you simply don't want the
mail notification functions activated, leave this variable
unassigned.
$bodyspec: Any attributes (BACKGROUND, BGCOLOR, TEXT, etc.) which
should be assigned to the <BODY> tag in message posts.
$HeaderFile & $FooterFile: Optional text files containing HTML code to
be placed immediately following the <BODY> tag and at the very end of
the BBS index page. These are included to allow you an easy way to
give your WebBBS index page the same "look" as the rest of your site's
pages.
$MessageHeaderFile & $MessageFooterFile: Optional text files containing
HTML code to be placed immediately following the <BODY> tag and at the
very end of the BBS message pages. You can use the same header and
footer on these pages as you use on the index page, or use different
ones, or use none at all.
$DefaultType: By design, WebBBS index displays default to a simple
chronological display. If you prefer the default to be a threaded
listing, set this variable to "By Threads" instead. If you prefer
the mixed-order listing of most Web-based bulletin boards, set it
to "By Threads, Reversed".
$DefaultTime: This variable sets the default for the age of messages
shown in the index list. If left unspecified, the index will display
messages posted within the past week. Valid values are: "Day"
"Two Days" "Week" "Two Weeks" "Month" and "Archive". The latter
instructs WebBBS to display *all* messages.
$boardname: The name of your specific discussion board.
$InputColumns & $InputRows: These variables define the size of the
text input box for messages. The default size is 80 columns by
15 rows. The smallest allowable size is 25 columns by 5 rows.
$HourOffset: If you are in one time zone and your Web host is in
another, you can use this variable to adjust the times shown for
posts on your BBS. For example, if your server is located in the
Eastern time zone, but you're in the Pacific time zone, set it to
"-3".
$ArchiveOnly: If this variable is set to "0" the board will function
normally. However, if it is set to "1" the message posting form will
not appear either on the index page or on individual message pages.
This allows you to set up a "read-only" archive board. (As a side
note, if you move files to a new directory from your active board to
set up such an archive, be sure to use the UNIX "mv" command rather
than the "cp" command. This will insure that the file modification
dates are not altered, so that searches by date will function
properly!)
$AllowHTML: If this variable is set to "1" people posting messages will
be able to embed HTML tags (hyperlinks, image references, formatting
commands, blinking text, etc.) in their messages. If it is set to "0"
they will not be able to do so. Be aware that allowing embedded HTML
virtually invites abuse of your bulletin board. Setting the variable
to "2" will allow any HTML codes to be displayed in the message rather
than being either interpreted or stripped. This can be handy, for
example, if the subject of your BBS is how to code HTML. SSI commands
will *never* be interpreted by the script. If this variable is set to
"2" they will be displayed along with any HTML tags; otherwise, they
will simply be stripped.
$AutoQuote: If this variable is set to "1" the new text of a message
will automatically be quoted in the message response input box. If it
is set to "0" the box will be empty.
$SingleLineBreaks: WebBBS automatically recognizes a double line break
or an indentation (either a tab or multiple spaces) as the start of a
new paragraph. If this variable is set to "0" any single line breaks
will be ignored. If it is set to "1" any single line breaks will be
converted to <BR> tags. The former option is usually preferable if
most posts consist of straight text. If, however, those posting on
your board frequently post itemized lists, you may want to use the
second option, to allow more accurate formatting.
$UseCookies: If this variable is set to "0" the use of "cookies" will
not be implemented. If it is set to "1" it will be. "Cookies" allow
the board to recognize return visitors, keep track of messages posted
since their previous visit, maintain their personal index display
preferences, and automatically insert their names and e-mail addresses
into the post forms. In other words, they're rather handy! IN ORDER
FOR "COOKIE" SUPPORT TO WORK, you must first install Matt Wright's
"cookie.lib" (available from <http://www.worldwidemart.com/scripts/>).
If you're not using "cookie" support, comment out the "require" line
in the configuration script. Otherwise, make sure it points to the
correct location on your system of Matt's "cookie" library.
$showbanners: If you're using WebAdverts to display advertising banners
on your site, and want to display banners on the BBS message index
page as well, set this variable to "1" and make sure the "require"
line points to the location of the "ads_cgi.pl" script. By default,
banners are displayed only on the main index page, immediately
underneath any header information you've specified. If you want them
displayed on other pages or in another location on the index page,
you'll have to move the "if ($showbanners) { &insertadvert; }" line
in the main WebBBS script.
$passwordfile: The file which contains your (encrypted)
administrative password. If you leave this variable unassigned,
the admin functions will simply be disabled.
===========================================
ADMIN FUNCTIONS
The admin index, from which you can easily delete any or all of the
messages on your board, is accessed by adding "?admin" to the URL of
your message index. For example, if your board index's URL was
"http://foo.com/index.cgi" you'd type "http://foo.com/index.cgi?admin".
The first time you access this index, you should be sure to use the
"change password" function to *set* a password. (For the first time
only, you can type anything or nothing in the "old password" box.)
Note that *regardless* of whether or not you've enabled the admin
delete capability, users will still be able to delete their own
posts if they've assigned passwords to them. The admin password,
if enabled, will also allow individual deletion of *any* post.
===========================================
NOTE: WebBBS is not designed to handle very large e-mail notification
lists, as the notifications are not handled in the most efficient manner
possible. If your notification list gets large (several hundred
addresses), you will notice a significant lag time in the processing
of postings. Eventually, I'll have to get around to correcting that.
===========================================
This documentation assumes that you have at least a general familiarity
with setting up Perl scripts. If you need more specific assistance,
check with your system administrators, consult the WebScripts FAQs
(frequently-asked questions) file <http://awsd.com/scripts/faqs.shtml>,
or ask on the WebScripts Forum <http://awsd.com/scripts/forum/>.
-- Darryl C. Burgdorf
