DGS Search v0.9.2 (06/14/00) - http://www.digitalgenesis.com

Quick Install:

  0. Untar the distribution into your websites tree. It will create a dgssearch
     directory. Several examples follow:

     For .tar.gz files:
       tar xvzf dgssearch-0.9.2.tar.gz
     For .tar.bz2 files:
       tar xvIf dgssearch-0.9.2.tar.bz2
        -or-
       tar xvf dgssearch-0.9.2.tar.bz2 --with-compress-program=bzip2
     For .zip files:
       pkunzip -x dgssearch_0.9.2.zip
        -or-
       Use WinZip or other GUI zip program.

  1. Open and configure config.php as needed. (in the config directory.)
     Most options are described to the right of the option.

  2. Test your install. Use the included index.php file as a quick test.

Configuration:

  config.php - This file contains all configuration options for DGS Search.

  Below is a full list of options and descriptions of how they work:

  General Options
  ---------------

    $config["installbase"] - Datatype: (String) - Ex: "/usr/local/apache/htdocs/dgssearch"

      The directory that DGS Search was installed into.


    $config["header"]	- Datatype: (String) - Ex: "config/header.php"

      The file that is used for the header on the results page.


    $config["footer"] - Datatype: (String) - Ex: "config/footer.php"

      The file that is used for the footer on the results page.


    $config["displayHeader"] - Datatype: (String) - Ex: "Search Results"

      The string that is used as a header on the results page.


    $config["boldQuery"] - Datatype: (Boolean) - Ex: true

      If set to true, the search word(s) will be bolded in the description on
      the results page.


    $config["timed"] - Datatype: (Boolean) - Ex: true

      If set to true, the results page will include the time taken to search.


    $config["debug"] - Datatype: (Boolean) - Ex: false

      If set to true, debugging information will be displayed on the results
      page. Unless you are a developer, this won't do much for you.


    $config["fsfirst"] - Datatype: (Boolean) - Ex: true

      If set to true, the filesystem search will take place before a database
      search. If set to false, the database will be searched first.


    $config["searchfs"] - Datatype: (Boolean) - Ex: true

      If set to false, the filesystem search will not be done.
      This is set to true in the distribution config.php.


    $config["searchdb"] - Datatype: (Boolean) - Ex: false

      If set to false, the database search will not be done.
      This is set to false in the distribution config.php.


    $config["persistent"] - Datatype: (Boolean) - Ex: true

      If set to true, persistent database connections will be used.
      Non-persistent connections are slower, but may be needed for compatiblity
      with some databases. (For example, MSSQL's ODBC driver isn't able to
      handle parallel selects on a persistent connection.)


    $config["hidecredits"] - Datatype: (Boolean) - Ex: false

      If set to false, the string "DGS Search" and link to our site will be
      removed from the bottom of the results page. We would like to ask that
      you leave this option set to false, as makes it easy for others to 
      locate DGS Search.


   Filesystem Options
   ------------------

    $config["urlbase"] - Datatype: (String) - Ex: "http://www.digitalgenesis.com"

      The base URL for your site. The URL will be used to generate links to your 
      search results.


    $config["fsbase"] - Datatype: (String) - Ex: "/usr/local/apache/htdocs"

      The directory on your local filesystem to begin searching.


    $config["fsexclude"] - Datatype: (Array of String) - Ex: array("cgi-bin", "dgssearch")

      A list of directories that should be excluded from your search.


    $config["exts"] - Datatype: (Array of String) - Ex: array("html", "php", "php3", "txt")

      A list of extensions that will be read looking for your search word(s).


    $config["maxDesc"] - Datatype: (Integer) - Ex: 128

      The length of the description on the results page.


    $config["descEnd"] - Datatype: (String) - Ex: "..."

      The string that to be added to the beginning and end of the description.


    $config["bufferSize"] - Datatype: (Integer) - Ex: 192

      The number of bytes to read at a time from a file. A value between 128
      and 1024 is optimal. Values too large or small will make your filesystem
      searches slow. 


  Database Options
  ----------------

    $database[x]["type"] - Datatype: (String) - Ex: "mysql"

      This is the database type. This can be different on each database entry.
      Currently supported types are: odbc, mysql, and mssql.


    $database[x]["server"] - Datatype: (String) - Ex: "localhost"

      The hostname or IP address of the SQL server.

      NOTE: This options is ignored if $database[x]["type"] is set to 'odbc'.


    $database[x]["username"] - Datatype: (String) - Ex: "username"

      The username used to connect to your database.


    $database[x]["password"] - Datatype: (String) - Ex: "password"

      The password used to connect to your database.


    $database[x]["database"] - Datatype: (String) - Ex: "database"

      The name of the database to search.


    $database[x]["table"] - Datatype: (String) - Ex: "links"

      The name of the table in your database to search.


    $database[x]["returnfield"] - Datatype: (Array of String) - Ex: array("url", "title")

      The fields returned from the database. This will usually be the urlfield and descfield.


    $database[x]["searchfield"] - Datatype: (Array of String) - Ex: array("title")

      The fields to search within your table.


    $database[x]["urlfield"] - Datatype: (String) - Ex: "url"

      The field in your table to use as the URL on the results page.


    $database[x]["descfield"] - Datatype: (String) - Ex: "title"

      The field in your table to use as the description on the results page.


   Constants
   ---------

	NOTE: These options generally don't need to be changed.

    $config["fileSeperator"] - Datatype: (String) - Ex: "/"

      The seperator used in your filesystem. UNIX based systems use '/'.
      DOS/Win based systems use '\'. 


    $config["extSeperator"] - Datatype: (String) - Ex: "."

      The file extension seperator used to in your filesystem.


    $config["thisDir"] - Datatype: (String) - Ex: "."

      The string used in denote the current directory.


    $config["parentDir"] - Datatype: (String) - Ex: ".."

      The string used in denote the parent directory.
