home *** CD-ROM | disk | FTP | other *** search
/ Nebula 1 / Nebula One.iso / Internet / WWW / Perl_WWW_Utilities / total / wwwboard / README < prev    next >
Encoding:
Text File  |  1996-01-02  |  13.3 KB  |  301 lines
  1. ##############################################################################
  2. # WWWBoard
  3. # Version 2.0 ALPHA 2
  4. # Created by Matt Wright
  5. # Created on:  10/21/95         Last Modified on:  11/4/95
  6. # I can be reached at:          mattw@misha.net
  7. # Scripts Found at:             http://www.worldwidemart.com/scripts/
  8. ##############################################################################
  9. # If you run into any problems while trying to configure this scripts, help  #
  10. # is available.  The steps you should take to get the fastest results, are:  #
  11. #       1) Read this file thoroughly                         #
  12. #       2) Consult the Matt's Script Archive Frequently Asked Questions:     #
  13. #               http://www.worldwidemart.com/scripts/faq/                 #
  14. #       3) If you are still having difficulty installing this script, send   #
  15. #          e-mail to: scripts-help@tahoenet.com                     #
  16. #          Include any error messages you are receiving and as much detail   #
  17. #          as you can so we can spot your problem.  Also include the variable#
  18. #          configuration block that is located at the top of the script.     #
  19. #                                         #
  20. # Hopefully we will be able to help you solve your problems.  Thank you.     #
  21. ##############################################################################
  22.  
  23. WWWBoard is the Version 2.0 of my Bulletin Board Message System.  I think 
  24. that the name is much better, and a lot fewer characters.  Version 2.0 
  25. has many enhancements, which were never put into version 1.0.  MANY of 
  26. the bugs in version 1.0 were fixed, although I am sure you will probably 
  27. find more.  
  28.  
  29. This version of the message system is a complete re-write over the last 
  30. one, and is not at all backwards compatible.  To use this new version, 
  31. you will just need to remove all past messages and start again.  I think 
  32. it is definitely worth it.
  33.  
  34. WWWBoard Version 2.0 has managed to reduce the number of scripts required 
  35. to run the bulletin board from three down t one.  This makes it much more 
  36. efficient.
  37.  
  38. The following files should have come with WWWBoard Version 2.0 ALPHA 2:
  39.  
  40.         a.  ALPHA-2       - READ THIS.
  41.     1.  README      - The necessary Install Instructions.  This file.
  42.     2.  wwwboard.pl   - The Perl CGI script that runs everything.
  43.     3.  wwwboard.html - The HTML WWWBoard file that users will see.
  44.     4.  faq.html      - An FAQ file displayed for users of wwwboard.
  45.     5.  data.txt      - Where the file number is stored.
  46.     6.  messages/      - Where the messages will be created and stored.
  47.     7.  wwwadmin.pl      - An Admin tool to delete messages.
  48.     8.  passwd.txt    - The encoded password and username for WWWAdmin
  49.         9.  ADMIN_README  - WWWAdmin README file.
  50.  
  51. You will need to edit by hand several of the files that come with 
  52. WWWBoard Version 2.0.  Below is a description of how to modify all of the 
  53. necessary files:
  54. ___________________________________________________________________________
  55.  
  56.                 WWWBOARD.PL
  57.                 ===========
  58.  
  59. This file must be placed in your server's cgi-bin, or if your server has 
  60. .cgi extensions allowed, you can simply rename this file to wwwboard.cgi, 
  61. changing the $cgi_url variable below to reflect this.  The file must also 
  62. be chmoded 755. Ask your system administrator for more information on 
  63. either the cgi-bin or chmod command.
  64.  
  65. This is the most complicated file you will need to modify.  It comes with 
  66. a lot of variables and many options.  Below is a summary of how to 
  67. configure all of the variables and what the options do:
  68.  
  69. ###########################################################################
  70. # Define Variables
  71.  
  72. $basedir = "/path/to/wwwboard";
  73.     This variable should contain the absolute system path to your     
  74.         wwwboard directory.  So if you keep all of your files in     
  75.         /home/yourname/public_html and you make a directory under there
  76.         called 'wwwboard', then $basedir would be set to: 
  77.         /home/yourname/public_html/wwwboard.
  78.  
  79. $baseurl = "http://your.host.xxx/wwwboard";
  80.         This is the base URL to the directory where wwwboard is kept.  So
  81.      staying with the example above, if your main directory is called 
  82.         by: http://your.host.xxx/~yourname/, the $baseurl would be set to: 
  83.         http://your.host.xxx/~yourname/wwwboard/.
  84.  
  85. $cgi_url = "http://your.host.xxx/cgi-bin/wwwboard.pl";
  86.     This is the URL that points to wwwboard.pl.  This will be used in 
  87.         followup form responses, so this must be correct.
  88.  
  89. $mesgdir = "messages";
  90.     This is the name of your messages directory which will be appended
  91.      to $basedir.  All of the messages for wwwboard will be created and
  92.      held in this directory.
  93.  
  94. $datafile = "data.txt";
  95.     This is the name of the data file which will also be appended to 
  96.         $basedir.  It will hold the current filename count, and the script 
  97.         will read this in and determine the message filename from this     file.
  98.  
  99. $mesgfile = "wwwboard.html";
  100.     This is the name of the wwwboard.html file, which you might want to
  101.      rename to index.html for the sake of a shorter URL.  It will be 
  102.         appended to both $basedir and $baseurl to determine the URL and the 
  103.         absolute path to this file, both for URL references by the script 
  104.         and for editing of this file by the script.
  105.  
  106. $faqfile = "faq.html";
  107.     This is the path to the faq.html file which will be appended to 
  108.         $baseurl so users can find their way to the Frequently Asked
  109.      Questions file about WWWBoard.
  110.  
  111. $ext = "html";
  112.     This is the ext with which all individual files will be created 
  113.         with.  Most of the time it should be left as html, but on the 
  114.     occasion when you may be suing this on a dos based platform you can
  115.      switch it to 'htm'.
  116.  
  117. $date_command = "/bin/date";
  118.     This needs to be the path to your 'date' command.  This script uses
  119.      the date command to time stamp the messages individually with along
  120.      date and to place a short 'added' date on the wwwboard.html page.
  121.  
  122. $title = "WWWBoard Version 2.0 Test";
  123.     This is the title of your WWWBoard, which will be used on the 
  124.         individual message pages.  Call your message board whatever you 
  125.         like, but I do recommend changing the above to something a little 
  126.         more catchy. :-)
  127.  
  128. # Done
  129. ###########################################################################
  130.  
  131. There are also several options you will need to configure:
  132.  
  133. ###########################################################################
  134. # Configure Options
  135.  
  136. $show_faq = 1;          # 1 - YES; 0 = NO
  137.     This option allows you to choose whether or not you want to display
  138.      a link to the FAQ on every individual message page or not.  It
  139.      defaults to 1 and the link will be put in at the top of the message
  140.      along with links to Followups, Post Followup and Back to $title.
  141.       Setting this to 0 will turn it off, and keeping it at 1 will keep
  142.      the link.
  143.  
  144. $allow_html = 1;        # 1 = YES; 0 = NO
  145.     This option lets you choose whether or not you want to allow HTML 
  146.     mark-up in your posts.  If you do not want to allow it, then
  147.      everything that a user submits that has <>'s around it will be cut 
  148.     out of the message.  Setting this option to '1' will allow HTML in 
  149.     the posts and you can turn this option off by setting it to '0'.
  150.  
  151. $quote_text = 1;        # 1 = YES; 0 = NO
  152.     By keeping this option set to 1, the previous message will be 
  153.     quoted in the followup text input box.  The quoted text will have a 
  154.     ':' placed in front of it so you can distinguish what had been said 
  155.     in the previous posts from what the current poster is trying to get 
  156.     across.  Setting this option to '0' will leave the followup text 
  157.     box empty for the new poster.
  158.  
  159. $subject_line = 0;      # 0 = Quote Subject Editable; 1 = Quote Subject
  160.                         #   UnEditable; 2 = Don't Quote Subject, Editable.
  161.     There are three options for the way that you can display the 
  162.     subject line for the user posting a followup.  Leaving this option 
  163.     at '0' which is the default value, will put the previous subject 
  164.     line into the followup form and allow users to edit the subject 
  165.     however they like.  Setting this option to '1', however, will quote 
  166.     the subject, but simply display it to the user, not allowing him or 
  167.     her to edit the subject line.  The third and final option can be 
  168.     achieved by setting the $subject_line variable to '2'.  If it is 
  169.     set to '2' the subject will not be quoted and instead the user will 
  170.     be prompted with an empty subject block in their followup subject 
  171.     line.
  172.  
  173. $use_time = 1;        # 1 = YES; 0 = NO
  174.     This option allows you to choose whether or not you want to use the
  175.      hour:minute:second time with the day/month/year time on the main 
  176.     page.  Day/Month/Year will automatically be placed on the main 
  177.     wwwboard.html page when a new entry is added, but if you leave this 
  178.     variable at '1' the hour:minute:second time will also be put there. 
  179.     This is very useful for message boards that get a lot of posts, 
  180.     but if you would like to save space on your main page, you can set 
  181.     this to '0' causing the hour:minute:second display not to be added.
  182.  
  183. # Done
  184. ###########################################################################
  185.  
  186. WOW!  You made it through all that.  That was the hardest file to edit.
  187.  
  188. ___________________________________________________________________________
  189.  
  190.                WWWBOARD.HTML
  191.                =============
  192.  
  193. wwwboard.html must be placed in the directory that you defined in 
  194. $basedir of your wwwboard.pl file.  It must be chmoded 777 so that your 
  195. web server's uid (User ID) has permission to write to this file.
  196.  
  197. This file needs much less editing than the wwwboard.pl script.  There are 
  198. three things that you will want to edit in this file.  The first two are 
  199. simply the title of your WWWBoard.  Currently the two lines look like:
  200.  
  201. <title>WWWBoard Version 2.0!</title> and <h1>WWWBoard Version 2.0!</h1>
  202.  
  203. You will want to change the title and header "WWWBoard Version 2.0!" to 
  204. whatever you want to call your WWWBoard.  This should probably be the 
  205. same as the variable $title that you defined in wwwboard.pl.
  206.  
  207. The third line in this file that you will need to edit is the one that 
  208. looks like:
  209.  
  210. <form method=POST action="http://your.host.xxx/cgi-bin/wwwboard.pl">
  211.  
  212. You need to change the URL that is in action="" to the same URL that you 
  213. defined in wwwboard.pl as $cgi_url.
  214.  
  215. Once you have made these changes you can exit this file and save it.
  216.  
  217. ___________________________________________________________________________
  218.  
  219.                  FAQ.HTML
  220.                  ========
  221.  
  222. This file does not need to be edited, unless you want to change the 
  223. heading or title or add a link back to your wwwboard page.
  224.  
  225. It should be placed in the $basedir directory and its name should reflect 
  226. that of the $faq_file variable defined in wwwboard.pl
  227.  
  228. It should be chmoded 744, so that it is readable by all.
  229.  
  230. ___________________________________________________________________________
  231.  
  232.                    MESSAGES/
  233.                    =========
  234.  
  235. This is a directory that should also be placed in $basedir as defined in 
  236. wwwboard.pl.  This directory must be chmoded 777 so that messages can be 
  237. written into it by the server's UID.
  238.  
  239. ___________________________________________________________________________
  240.  
  241.                 DATA.TXT
  242.                 ========
  243.  
  244. Simply place this file into $basedir as defined in wwwboard.pl and chmod 
  245. it 777 so that the web server can write an incremented number to it.  
  246. This is where the file name number will be kept.
  247.  
  248. ___________________________________________________________________________
  249.  
  250.                  README
  251.                  ======
  252.  
  253.             This is the easiest.  Just READ it!
  254.  
  255. ___________________________________________________________________________
  256.  
  257. Version 2.0 Improvements Over 1.0:
  258.  
  259. * HTML does not mess up postings like the last version did.
  260. * There are many more options to allow flexibility in design.
  261. * One CGI program instead of three.  Makes everything smoother and
  262.   more efficient.
  263. * File names are derived from an incremented number up to 99999 so that
  264.   messages won't overlap, like they could have with the old pid numbers that
  265.   were used.
  266. * Many more things I can't even begin to list.
  267.  
  268. ___________________________________________________________________________
  269.  
  270. Version History:
  271.  
  272. Version 2.0:        Complete Re-Write of Version 1.0
  273.     11/4     -    ALPHA 1 Version Released because many people were 
  274.             writing asking if they could get a copy of it.
  275. ___________________________________________________________________________
  276.  
  277. As with all of my scripts which you can find at my scripts archive:
  278.  
  279. http://worldwidemart.com/scripts/
  280.  
  281. These are provided at no charge.  You can modify/edit/change/anything you 
  282. want to these scripts.  There are only two things that I ask, neither of 
  283. which will you be sued for if you don't follow.  :-)
  284.  
  285. 1)  Please let me know where these are being used  I like to see my work in
  286.     action.  you can let me know simply by filling out the on-line from
  287.     located at:       http://worldwidemart.com/scripts/implement.html
  288. 2)  Please keep my name somewhere in the script. It doesn't have to be
  289.     noticeable to users, but I appreciate it being in the script somewhere 
  290.     in case you ever pass it on or anything like that.
  291. 3)  Oh yah, there's a third one, but its the one I care least about.  I 
  292.     know how many people like to keep everyone at their own site and  
  293.     therefore do not link to the outside too often, but if at all possible, 
  294.     I would appreciate a link to my scripts archive.  Once again, this 
  295.     isn't necessary.
  296. 4)  Do the rules ever stop you say?  This last one is easy to follow:
  297.               ***HAVE FUN!***
  298.  
  299. ___________________________________________________________________________
  300.    Matt Wright * mattw@misha.net * http://worldwidemart.com/scripts/
  301.