home *** CD-ROM | disk | FTP | other *** search
/ C/C++ User's Journal & Wi…eveloper's Journal Tools / C-C__Users_Journal_and_Windows_Developers_Journal_Tools_1997.iso / scptease / readme.txt < prev    next >
Encoding:
Text File  |  1996-10-28  |  13.9 KB  |  298 lines
  1.             Installation and Configuration Guide
  2.  
  3.        A chapter devoted to the steps necessary to install and
  4.        configure ScriptEase:WSE on your Web server. Covers all
  5.        tested platforms and servers.
  6.  
  7. Installing ScriptEase:WebServer Edition
  8.  
  9.   Installation Files
  10.  
  11.     On all platforms, ScriptEase:WSE is installed using the SESETUP
  12.     program. If you're installing from floppy disks, SESETUP will
  13.     be found on the first disk and can be executed directly from
  14.     there. If you're installing from a download compressed file
  15.     (e.g.: zip, tar), create a temporary directory and uncompress
  16.     all of the files into that temporary directory.
  17.  
  18.     The files on your installation disks or in the installation
  19.     directory will be similar to these (not that some operating
  20.     systems will not have the ".EXE" extension for executable
  21.     files):
  22.  
  23.      SESETUP.EXE - The installation program
  24.      SEWSECFG.EXE - Configuration program (used after
  25.                     installation)
  26.      LICENSE.DOC - Software license agreement
  27.      SEWSE1.BIN, SEWSE2.BIN... - Executables and samples in bundled
  28.                                  form
  29.  
  30.     If you are using the WebMaster version, you will also find
  31.     these additional files used for remote development and
  32.     debugging:
  33.  
  34.      SEDBGW16.EXE - 16-bit Windows version of IDE
  35.      SEDBGW32.EXE - 32-bit Windows version of IDE
  36.      SEDBG.HLP - Help file for IDE
  37.      SEDBXW16.EXE - Debugging extension (proxy) for 16-bit Windows
  38.      SEDBXW16.EXE - Debugging extension (proxy) for 32-bit Windows
  39.  
  40.     Note that the installation program (SESETUP) will not copy any
  41.     of these files except for those in the SEWSE?.BIN files. All of
  42.     the other files are used for administering or debugging
  43.     ScriptEase:WSE and you can keep these files on the disk or copy
  44.     them to a more useful location.
  45.  
  46.   Installation Instructions: SESETUP
  47.  
  48.     To install ScriptEase:WSE on your system, you must first
  49.     determine where your Web server requires binary executables to
  50.     be placed. If this is your own site, this is straight forward
  51.     and configurable. If you are using an Independent Service
  52.     Provider (ISP) it may require getting to know your local
  53.     WebMaster. Some ISPs are uncomfortable when you try to install
  54.     your own executables. Most commercial Web sites from an ISP
  55.     give you cgi-bin access. If you have any trouble please contact
  56.     your ISP for assistance.
  57.  
  58.     Once you have located the bin directory on your Web server
  59.     (often this is called cgi-bin, although it can have any name)
  60.     you will need to install the ScriptEase:WSE files. The SESETUP
  61.     program copies all of the files to your server automatically.
  62.     Note that SESETUP must be executed from the server (or from a
  63.     remote shell on the server) and not from a web browser.
  64.     SESETUP runs in a slightly different form on all operating
  65.     systems. But the questions that must be answered are the same
  66.     across platforms. This chapter will use the 32-bit Windows
  67.     version as an example.
  68.  
  69.     When you run SESETUP, you will first see a licensing agreement
  70.     to read and accept, and then will be questions about these
  71.     fields:
  72.     
  73.     Local-Path of BIN/Executable: Enter the full path name of
  74.       the directory to place ScriptEase:WSE executables. SESETUP
  75.       will not create this directory and so it must already exist.
  76.       Most web servers are already pre-configured with a path for
  77.       placing script executables. On many systems this directory
  78.       has the name "cgi-bin". On systems supporting the Win-CGI
  79.       there may be a directory names "wcgi-bin" for placing
  80.       Win-CGI scripts, and "cgi-bin" for placing standard CGI
  81.       scripts; ScriptEase:WSE will support either interface
  82.       (remember which you chose in installation for the following
  83.       configuration settings).
  84.  
  85.     URL of BIN/Executable: Enter the full URL of the path
  86.       described above in Local-Path. Most web servers have a
  87.       configuration program for mapping physical directories to
  88.       URLs. Consult your webserver configuration program for
  89.       determining the URL for the BIN/Executable directory.
  90.  
  91.     Local path for sample files: Enter a path (SESETUP will
  92.       create the path if it doesn't already exist) where SESETUP
  93.       will copy the many ScriptEase:WSE sample scripts. This must
  94.       be a directory within a path that your WebServer is
  95.       configured to have available for web pages. A good place to
  96.       put this scripts is just below the directory where you have
  97.       a home page. These directories will be created if they don't
  98.       already exist.
  99.  
  100.     URL of that sample directory: Enter the URL needed to access
  101.       that sample directory. For example, if the your homepage is
  102.       local path C:\web and its URL is http://www.mysite.com/ and
  103.       if your local sample path was C:\web\sewse then the URL for
  104.       the sample path is http://www.mysite.com/sewse.
  105.  
  106.     Local path for data files: Enter a path that the
  107.       ScriptEase:WSE samples are free to write data into. This can
  108.       be the same directory as the local path for sample files.
  109.       You may want to specify a different directory here if you
  110.       are running a system with potential security problems, such
  111.       as a multi-user UNIX system with ftp and telnet
  112.       capabilities. These directories will be created if they
  113.       don't already exist.
  114.  
  115.     Use long filenames (.html instead of .htm): The
  116.       ScriptEase:WSE sample files can be copied using the .htm or
  117.       .html extension. The longer name is standard on must
  118.       UNIX-type systems. If your system does not support long
  119.       filename (e.g., Win-16 or OS/2 on a FAT partition) then
  120.       specify the shorter name.
  121.  
  122.     After selecting these responses, SESETUP will copy all of the
  123.     sample files onto your server system. Finally, SESETUP will
  124.     remind you of the URL to specify in any browser to view the
  125.     sample pages; remember this URL (e.g.
  126.     http://www.mysite.com/sewse/sewse.html).
  127.  
  128.     When SESETUP is finished, it will automatically start the
  129.     configuration program (SEWSECFG).
  130.  
  131.   Configuration Instructions: SEWSECFG
  132.  
  133.     SEWSECFG is the program to configure ScriptEase:WebServer
  134.     addition. SEWSECFG will be executed, and most fields will be
  135.     pre-filled with default values automatically after the
  136.     installation program (SESETUP) is run. But SEWSECFG can be
  137.     executed again any time after installation.
  138.  
  139.     SEWSECFG input varies between operating system, but the type of
  140.     input it uses is the same across all system. These explanation
  141.     will apply to all version of SEWSECFG:
  142.     
  143.     Password (WebMaster version only): Enter a password to be
  144.       used when remote-debugging ScriptEase:WSE. This password
  145.       will prevent other users from getting access to the powerful
  146.       features and command that the debugger will let you execute
  147.       directly on the server from a remote location. If this field
  148.       is left blank then there will be no password.
  149.     
  150.     SecurePath: Enter one or more paths from which
  151.       ScriptEase:WebServer Edition will be permitted to execute
  152.       .CMM scripts. ScriptEase:WSE will only permit scripts to be
  153.       executed if they are contained within the tree described by
  154.       this path. More than one path can be specified here.
  155.  
  156.     CmmPath: Enter the default path or paths where ScriptEase:WSE
  157.       will automatically search for scripts, #include, and #link
  158.       files. In the above example are the two scripts the SESETUP
  159.       may have created, separated by a semi-colon (in UNIX it
  160.       would be a colon, and a carriage-return for the Macintosh).
  161.  
  162.     WinCGI (windows only): Select this item if the Executable/BIN
  163.       directory you copy SEWSE.EXE or SEWSEDB.EXE to is configured
  164.       to use the Win-CGI protocol instead of the standard CGI
  165.       protocol. Note that this option is only available for Win16
  166.       and Win32 (not including ISAPI or NSAPI) versions of
  167.       ScriptEase:WebServer Edition.
  168.  
  169.     After this data has been entered, the SEWSE executable will be
  170.     stamped (overwritten) with this new configuration information.
  171.  
  172.   Un-Installing (Removing) ScriptEase:WebServer Edition
  173.  
  174.     ScriptEase:WebServer Edition does not modify any existing
  175.     system files. So to remove ScriptEase:WSE you only need to
  176.     delete the files that the installer copied to your disk. These
  177.     file will be the SEWSE*.* files that SESETUP copied to the
  178.     BIN/Executable directory (c:\web\cgi-bin in our example) and
  179.     the sample and data files contained in the paths specified in
  180.     SESETUP (c:\web\sewse and c:\web\sewsedat in our example). All
  181.     that is required to uninstall ScriptEase:WSE is to delete these
  182.     executables and the directory trees created.
  183.  
  184.   Testing Installation and Configuration
  185.  
  186.     After installation verify that the main sample page was
  187.     installed correctly by viewing it from any browser using the
  188.     URL and names specified when running SESETUP. From any browser
  189.     enter the URL for the SEWSE.HTML sample page. In our example
  190.     this would be http://www.mysite.com/sewse/sewse.htm. If this
  191.     page does not show (it shows "ScriptEase" in large letters at
  192.     the top) then verify that the server is running, that the URL
  193.     specified here matches the one you defined in SESETUP, and that
  194.     the URL defined in SESETUP matches the sample path defined in
  195.     SESETUP. If there was an error in SESETUP then delete then
  196.     uninstall SE:WSE (see previous section) and run SESETUP again.
  197.  
  198.     The sample page contains very many scripts to demonstrate the
  199.     use of ScriptEase:WebServer Edition. The first script to try
  200.     from your browser is the "Verify" script found just below the
  201.     "Miscellaneous" header. "Verify" runs ScriptEase:WSE with no
  202.     parameters. You should get text back looking like this:
  203.  
  204.      You have executed ScriptEase: Web Server Edition (SEWSE 3.0
  205.      Standard version) with no parameters. To learn about
  206.      ScriptEase visit Nombas
  207.  
  208.     If this text does not show then verify that the URL entered is
  209.     the one you specified for the BIN/Executable URL in SESETUP and
  210.     the BIN/Executable path in SESETUP matches that URL.
  211.  
  212.     The final script to test configuration is just below "Verify",
  213.     and is "Show CGI Input server fields". Click on this URL to
  214.     verify that all of the server parameters are returned and
  215.     available to ScriptEase:WebServer Edition.
  216.  
  217.     Now try all the examples. They're yours to modify, learn from,
  218.     and to play with. Have fun.
  219.  
  220. Specific Installation Instructions
  221.  
  222.   ** Folkweb **
  223.  
  224.     Check FolkWeb's control panel for the directories in which to place
  225.     CGI programs and the path for the homepages. FolkWeb can have problems
  226.     locating scripts if the "cgi-bin" name is used. If this is a problem
  227.     then select "cgibin" instead.
  228.  
  229.   ** IBM Internet Connection Server **
  230.  
  231.     No problems reported with IBM Internet Connection Server
  232.  
  233.   ** Microsoft IIS (Internet Information Server) **
  234.  
  235.     This server supports both the ISAPI and the CGI interface. No
  236.     problems reported with this server, although there have been
  237.     reports of larger scripts running slowly on ISAPI--we're looking
  238.     into this problem.
  239.  
  240.   ** Netscape Commerce Server **
  241.  
  242.     This server supprts CGI and Win-CGI interfaces. No problems reported
  243.     with this server.
  244.  
  245.   ** Quarterdeck Win-16 WebServer **
  246.  
  247.     This web server does not always return binary data sent through
  248.     CGIOut(), such as the data for a .GIF image. No problems with
  249.     text files. We hope this problem will be fixed soon.
  250.  
  251.   ** UNIX (LINUX/SUN-OS/FreeBSD currently) **
  252.  
  253.     Currently, all UNIX installations are identical regardless of the
  254.     particular flavor of UNIX or the http Daemon being used. You will need
  255.     access to the cgi-bin directory to install ScriptEase:WSE for UNIX. If
  256.     you are root on your system, this is not a problem. Some commercial
  257.     providers create virtual cgi-bin directories which you have access to.
  258.     Otherwise, you will need to talk to your System Administrator about this.
  259.  
  260.     The first and easiest way to install ScriptEase:WSE is to copy it to your
  261.     cgi-bin directory. However, this installation method has the disadvantage
  262.     (if you do not configure your scripts with a SEWSECFG secure path) of
  263.     allowing any user on your system to run any ScriptEase:WSE script from
  264.     their web pages. You might not want this. To reference such a script from
  265.     your web pages, use the URL [http://yoursite/cgi-bin/sewse?scriptname].
  266.     The script name must be the full path to the script.
  267.  
  268.       Ex: [http://www.nombas.com/cgibin/sewse?/home/httpd/html/sewse/test.cmm]
  269.  
  270.     A second (and perhaps safer) way to install ScriptEase:WSE is to put it in
  271.     either /usr/bin or /usr/local/bin. You can then put UNIX shell scripts which
  272.     use ScriptEase:WSE as their command processor in your cgi-bin directory.
  273.     Thus, you have control over what scripts you allow your users on your system
  274.     to put in their web pages.
  275.  
  276.       Ex: [http://www.nombas.com/cgi-bin/myscript.cmm]
  277.  
  278.     In this case, myscript.cmm must be executable and readable by the account
  279.     'nobody'. In addition, the first line of the script should read:
  280.  
  281.         #!/usr/local/bin/sewse
  282.  
  283.      ScriptEase:WSE must be executable by nobody.
  284.  
  285.   ** Website **
  286.  
  287.     In the "mapping" folder of the WebSite server administration folder
  288.     are instructions for specifying which directories support CGI,
  289.     Win-CGI, or ISAPI (Nombas has not yet tested SE:WES ISAPI version on
  290.     WebSite). Specify these directories/URLs in SESETUP to match the
  291.     CGI or ISAPI method chosen.
  292.  
  293.     One potential area of confusion with WebSite is in the escape sequences
  294.     on the "CGI" page of the WebSite Server Admin Program.  SE:WSE CGI
  295.     will suport sequences "~p ~v ~i ~o ~a" or "~s ~p ~v ~i ~o ~a", and
  296.     SE:WSE Win-CGI will support sequences "~s ~p ~a" or "~p ~a".
  297.  
  298.