INSTALL.DOC

16.5 KB cc443bd057c255f3…
                  Telegard Bulletin Board Software, v3.10
                         Installation Documentation

                   Copyright (C) 1995,1998 by Tim Strike
                            All Rights Reserved.


       INTRODUCTION
       
       Welcome to Telegard Bulletin Board Software, version 3.10.  This 
       documentation contains quick instructions for installing Telegard 
       for the first time, or for completing an upgrade from previous 
       versions of the Telegard software.
       
       Please read README.DOC before continuing with this installation.

       Please follow these instructions very carefully.  The steps we have 
       outlined are designed to ensure that you install our system with
       minimal effort and with success the FIRST time!

       If you are upgrading from a previous version of Telegard, you should 
       refer to the section titled "UPGRADE INSTRUCTIONS", otherwise if you 
       are a first time user of Telegard, please follow the "NEW 
       INSTALLATION" section.
       
        
       SYSTEM REQUIREMENTS

       DOS (Telegard):
          Memory                        440K minimum
          Diskspace, installation       2 megs
                     post-installation  1 meg + msgs + files + doors + data
                     recommended        10+ megs at least
          Fossil Driver (level 5)
          Share/OS-equivalent (for multinode)

       OS/2 (Telegard/2):
          Memory                        440K minimum
          Diskspace, installation       2 megs
                     post-installation  1 meg + msgs + files + doors + data
                     recommended        10+ megs at least
          SIO/compatible communications driver


       TELEGARD/2 INSTALLATION NOTES

       Please note that this document references only DOS installation 
       files; the Telegard/2 installation is identical, except please note 
       the following:
       
                INSTALL2.TWS  replaces INSTALL.TWS
                INSTALL2.EXE  replaces INSTALL.EXE
                TG2.EXE       replaces TELEGARD.EXE

                ; both DOS and OS/2 utilities are included in Telegard/2 
                UPDATE2.EXE   may be used in place of UPDATE.EXE
                UNPACK2.EXE   may be used in place of UNPACK.EXE
                MAKLANG2.EXE  may be used in place of MAKELANG.EXE
                FA2FB2.EXE    may be used in place of FA2FB.EXE
                FB2FA2.EXE    may be used in place of FB2FA.EXE
                INDEX2.EXE    may be used in place of INDEX.EXE

       No other changes to the installation process are required.


       NEW INSTALLATION

       1)  Create a new directory for your Telegard BBS

       2)  Copy INSTALL.* into your bbs directory

       3)  Run INSTALL.EXE from your bbs directory.  When prompted, enter 
           the case-sensitive unarchiving password 'READYTOGO'.  This will 
           extract the remaining installation files for your system.

       4)  Run TELEGARD.EXE from your bbs directory, which will start the 
           installation process.  It will ask you a few simple questions 
           regarding the placement of the remaining data files.  For 
           security reasons, you should consider configuring these 
           directories in such a manner that the directory structure is not 
           obvious (i.e. do not use /DATA/ as your data directory).

           The installation process will build the desired directory 
           structure, unpack the enclosed data files, and create any other
           data files which are needed for BBS installation.  In addition,
           the installation process will attempt to build and compile your
           index and language files automatically (errors will be noted; if 
           errors exist, you can run the command line utilities instead).

       5)  Run "TELEGARD -?" to familiarize yourself with the commands 
           available from the command line.

       6)  Run "TELEGARD -L" to load the BBS locally -- Hit "ESC" for the
           menu commands available -- Use the System Configuration and
           System Manager commands to setup the remainder of your BBS
           system (remember to change the information in the first user
           record to your OWN personal information!).

       7)  You may delete INSTALL.EXE and *.TWS after the installation has 
           been completed.  These files are only temporary installation 
           files and are not used in the general operation of the BBS.  You 
           should save a copy of the original archive (TG_nnn@n.ZIP) in 
           case you want or need to reinstall the software at a later date.

           You can also delete the UPDATE.EXE file, which is only used if
           updating from a previous version of Telegard.

       8)  Remember to read /docs/faq.doc at some point in the near future.

       NOTE: You will need to install a fossil driver before you can use 
       Telegard remotely (for Telegard/2, you will need a SIO compatible 
       communications driver).  A fossil or communications driver should 
       likely be available on a local BBS.


       UPGRADING INSTRUCTIONS

       We don't have any upgrade instructions for any versions of Telegard
       prior to 3.02.  If you are upgrading from Telegard 2.7, or from one
       of the (expired) gamma releases (2.99.x), or old final releases 
       (3.0/3.01), then please get the TG_302.ZIP package and update your 
       system to 3.02 before continuing the upgrade to 3.10.

       TELEGARD 3.09 GAMMA 1 UPGRADING INSTRUCTIONS

       If you are still using 3.02, you may upgrade by following the 3.02
       instructions found later in this document.

       1)  Make a backup of your BBS configuration/data files (your data,
           language, menu and text folders), your file section data files
           (*.FB?, *.FSI) and your message section data files (*.MSI),
           and the main Telegard executables.  A thorough backup is your 
           best defense. 

       2)  Copy INSTALL.* into your bbs directory

       3)  Run INSTALL.EXE from your bbs directory.  When prompted, enter 
           the case-sensitive unarchiving password 'READYTOGO'.  This will 
           extract the remaining installation files for your system.

       4)  Create a folder (directory) off your main BBS directory called
           /docs/.  You can remove /notes/ at your leisure.

       5)  You should then run UNPACK for each of the .TWS files in order
           to update the data files that are in use on the system.  To do
           this type "UNPACK <filename> <location>" at the DOS command 
           prompt, without the quotes, replacing <filename> with the .TWS
           filename and <location> with the directory for the unpacking.
           
           Say NO to extract new/non-existant files.  You want to replace
           some files which already exist; saying NO will ensure that you
           can do that.

           For existing files, UNPACK lists current (C=xx) and new (N=xx) 
           file dates for comparison. If the file dates are different, then 
           the line is highlighted in YELLOW.
                
           If you say YES to overwrite the file, the NEW file (the one in 
           the .TWS archive) will be extracted over the current file.  
           NOTE: The file in the archive is not necessarily newer then the 
           file on disk.  Files which have not changed from 3.02 are listed 
           with a file time of 3:02a.

               FILENAME        LOCATION                  OVERWRITE?
               docs.tws        /docs/ directory             yes
               defaults.tws    data directory               yes*1 
               language.tws    languages directory          yes*2
               bin.tws         main bbs directory           yes
               bin2.tws        main bbs directory           yes*3
               text.tws        default text directory       no*4
               menus.tws       default menus directory      no*5
        
           *1 overwrite TELEGARD.* files, MENUS.DAT and HARDWARE.DAT files.
           *2 overwrite ENGLISH.TXT if you desire (this will wipe out any 
              changes that you did to your language file)
           *3 Telegard/2 installation only
           *4 several of the scripts have changed, as have some of the
              standard text files; you might want to update these as you
              desire (replace DOORFILE.SCR, for instance)
           *5 several of the menus have changed cosmetically, only the
              new menus are required
              
       6)  Completely review /docs/WHATSNEW.G2 for all changes, and then 
           return to these installation instructions.

       7)  Run UPDATE.EXE from the main BBS directory.  Select version 
           3.09.g1 (option 8) and the let the utility update your data 
           files--which will update new fields, create new files, and 
           convert old files to their new format.  In case of error, 
           restore from your backup, report the error and abort the upgrade 
           {for now}.

       8)  Run "INDEX BUILD ALL" to update and correct your files.

       9)  Review /docs/LANGUAGE.G2 for instructions on updating your 
           language files.  Remember to update -all- your languages.  If 
           you replaced your language with the default ENGLISH.TXT in step 
           5 and you only use ENGLISH, you are already done.
       
       10) From your main bbs directory run "MAKELANG .\LANGUAGE\ENGLISH"
           to compile your new language file (Note: Replace \LANGUAGE\ with
           your correct language path).  Repeat as neccessary for each of
           your remaining languages.

       11) Review the new configuration options to ensure that your system 
           is setup the way that you desire.  For more information on these 
           options, refer to /docs/WHATSNEW.G2.

       12) You may delete INSTALL.EXE and *.TWS after the upgrade has 
           been completed, and UPDATE.EXE after it has been run (step 6).

       13) Remember to read /docs/FAQ.DOC at some point in the near future.


       TELEGARD 3.02 RELEASE UPGRADING INSTRUCTIONS
       
       1)  Make a backup of your BBS configuration/data files (your data,
           language, menu and text folders), your file section data files
           (*.FB?, *.FSI) and your message section data files (*.MSI),
           and the main Telegard executables.  A thorough backup is your 
           best defense. 

       2)  Copy INSTALL.* into your bbs directory

       3)  Run INSTALL.EXE from your bbs directory.  When prompted, enter 
           the case-sensitive unarchiving password 'READYTOGO'.  This will 
           extract the remaining installation files for your system.

       4)  Create a folder (directory) off your main BBS directory called
           /docs/.  You can remove /notes/ at your leisure.

       5)  You should then run UNPACK for each of the .TWS files in order
           to update the data files that are in use on the system.  To do
           this type "UNPACK <filename> <location>" at the DOS command 
           prompt, without the quotes, replacing <filename> with the .TWS
           filename and <location> with the directory for the unpacking.
           
           Say NO to extract new/non-existant files.  You want to replace
           some files which already exist; saying NO will ensure that you
           can do that.

           For existing files, UNPACK lists current (C=xx) and new (N=xx) 
           file dates for comparison. If the file dates are different, then 
           the line is highlighted in YELLOW.
                
           If you say YES to overwrite the file, the NEW file (the one in 
           the .TWS archive) will be extracted over the current file.  
           NOTE: The file in the archive is not necessarily newer then the 
           file on disk.  Files which have not changed from 3.02 are listed 
           with a file time of 3:02a.

               FILENAME        LOCATION                  OVERWRITE?
               docs.tws        /docs/ directory             yes
               defaults.tws    data directory               yes*1 
               language.tws    languages directory          yes*2
               bin.tws         main bbs directory           yes
               bin2.tws        main bbs directory           yes*3
               text.tws        default text directory       no*4
               menus.tws       default menus directory      no*5
        
           *1 overwrite TELEGARD.* files, MENUS.DAT and HARDWARE.DAT files.
           *2 overwrite ENGLISH.TXT if you desire (this will wipe out any 
              changes that you did to your language file)
           *3 Telegard/2 installation only
           *4 several of the scripts have changed, as have some of the
              standard text files; you might want to update these as you
              desire (replace DOORFILE.SCR, for instance)
           *5 several of the menus have changed cosmetically, only the
              new menus are required
              
       6)  Completely review /docs/WHATSNEW.* for all changes, and then 
           return to these installation instructions.

       7)  Run UPDATE.EXE from the main BBS directory.  Select version 3.02 
           and the let the utility update your data files--which will 
           update new fields, create new files, and convert old files to 
           their new format.  In case of error, restore from your backup,
           report the error and abort the upgrade {for now}.

           A disk cache is extremely helpful in the upgrade process, which 
           may take anywhere from several seconds to many minutes, 
           depending on how many message and file areas, and how many users
           you have, how big your history file is, etc.  Please be patient,
           the update utility will inform you have it's progress.

       8)  Run FB2FA.EXE from the main BBS directory to convert your old
           file section to the new file section.  This will take several
           minutes as well.

       9)  Run "INDEX BUILD ALL" to update your files and to create the new 
           index formats (QFILES.IDX, among others).

       10) Review /docs/LANGUAGE.G1 and /docs/LANGUAGE.G2 for instructions 
           on updating your language files.  Remember to update -all- your 
           languages. If you replaced your language with the default 
           ENGLISH.TXT in step 5 and you only use ENGLISH, you are done.
       
       11) From your main bbs directory run "MAKELANG .\LANGUAGE\ENGLISH"
           to compile your new language file (Note: Replace \LANGUAGE\ with
           your correct language path).  Repeat as neccessary for each of
           your remaining languages.

       12) Several new menus were added in step 5: NEWUSERV, MSGREAD,
           FILETAGP, WFCQFILE, WFCQMSG.  Review these menus as you see fit-
           I do not suggest any changes until you have updated your entire
           system and it has been running in a stable environment for a few
           days.
       
       13) Update your ACS strings (menus, msg & file areas, access control
           items in msg & file configuration) to reflect the new Ixxx ACS
           (which changed from I00-nnnn to Innnn).   If you have doors 
           which still expect the old format, then use I00-~UU instead of
           just ~UU.  Please read OTHER section of /docs/WHATSNEW.G1 for 
           further information.

       14) DOOR.SYS file format was changed; your doors will not likely 
           work correctly if they use the DOOR.SYS format.  You have to 
           edit your users' door records to reflect their real name instead 
           of handle in the door configuration, or you must use the 
           OLDDOORS script.  YOU HAVE BEEN WARNED!  Please read DOORS 
           section of /docs/WHATSNEW.G1 for further information.
           
       15) Review the new configuration options to ensure that your system
           is setup the way that you desire.  For more information on these
           options, refer to /docs/WHATSNEW.G1 and /docs/WHATSNEW.G2.

       16) You may delete INSTALL.* and *.TWS after the upgrade has 
           been completed, and UPDATE.EXE after it has been run (step 6).

       17) Remember to read /docs/FAQ.DOC at some point in the near future.