Table of Contents

  1. Installation
    1. Requirements
    2. Installation
      1. Recommended Installation Path
      2. Manual Installation
    3. Updating
  2. Configuration
    1. Where modifications take place
    2. Modification at runtime
    1. General Configuration
    1. Setting up the Database
    2. Privacy considerations
    1. Download Settings
      1. Database Settings
      2. Miscellaneous Settings
    1. HistView
      1. Changelog formatting settings
      2. Icons to be used
      3. CSS classes
      4. Directory settings
      5. Miscellaneous settings
  7. How to use the Classes
    1. Setting it up
    2. Processing a file request
    3. Display the ChangeLog

Installation

Requirements

There are a few dependencies to consider in order to use HistView:

  • a Web server supporting PHP (tested only with Apache)
  • PHP version 4.1 or higher (recommended: loadable module for Apache - which again is the only tested variant), optionally compiled with support for the MySQL database to use the statistics of the Download class
  • optionally a MySQL database to store the statistics. This may be remote or local

Most (if not all) Linux distribution ship this along with their package manager, so it should be easy to install. On Windows it might be a bit more tricky. To test whether you meet these requirements, simply create a test PHP file containing a single line: <?php phpinfo();?>, put it into your document root, and call it with your browser. The resulting page will list your PHP configuration and tell you about available capabilities.

Installation

Recommended Installation Path

The best (and most recommended) way to install HistView is to use your Linux distributions package manager. There are *.deb and *.rpm packages available in the  IzzySoft APT repository, and you can even include this repository in your APT or YUM configuration (this is described on the webpages there). Doing so, all dependencies will be resolved automatically, and installation is done by a single command (apt-get install histview or yum install histview will perform all necessary steps).

If you can neither use *.deb nor *.rpm packages, you should download the TAR archive. Having this unpacked, change to the directories created and run make install after making sure that all dependencies are met.

All these mentioned methods have at least two advantages over the manual installation:

  • all files will automatically be put to the right places
  • everything can be easily cleanly uninstalled (apt-get remove histview, yum remove histview, make uninstall)

Using *.deb/*.rpm packages with the repository moreover will allow you easy updates.

Manual Installation

If you prefer to do a manual installation, you first need to make sure all requirements are met. Then:

  1. Unpack the TAR archive to the directory of your choice. This must either be inside your web servers document root, or linked there (and the web server configured to allow that - FollowSymLinks in the Apache options), or set up in your web servers configuration as an Alias
  2. Check the class.hvconfig.inc with the configuration page and create your hv-localconf.inc file (this step has to be done in all cases)

Updating

Depending on how you performed the installation, updating from a previous version of HistView can be done in different ways:

  • Using your package manager (apt-get update histview, yum update histview
  • using the Makefile (make install)
  • manually copying the files from the Tar archive

In any case, you afterwards may need to check your configuration again concerning new options.

Last modified by izzy, 12/30/08 17:51:58 (4 years ago)