diff --git a/livesupport/doc/developmentTools.html b/livesupport/doc/developmentTools.html index 04a194adc..05c90b3d9 100644 --- a/livesupport/doc/developmentTools.html +++ b/livesupport/doc/developmentTools.html @@ -3,7 +3,7 @@ LiveSupport developer tools - +

Preface

@@ -12,8 +12,8 @@ project, Copyright © 2004 Media Development Loan Fund, under the GNU GPL.
@@ -37,7 +37,8 @@ The following tools are expected on the development system:
1.9
  • autoconf >= 2.5
    -(If you have an older version installed as well, don't forget to set the +(If you have an older version installed as well, don't forget to set +the environment variable WANT_AUTOCONF_2_5="1" before compiling the tools.)
  • libtool
    • @@ -49,7 +50,8 @@ environment variable WANT_AUTOCONF_2_5="1" before compiling the tools.)
  • doxygen
  • tar
  • gzip
    • -
  • bzip2
    +
  • bzip2
    • +
  • curl

    • Libraries

    diff --git a/livesupport/doc/gettingStarted.html b/livesupport/doc/gettingStarted.html index 41a88001f..8f98ba6ec 100644 --- a/livesupport/doc/gettingStarted.html +++ b/livesupport/doc/gettingStarted.html @@ -13,7 +13,7 @@ Development Loan Fund, under the GNU GPL.
    @@ -43,7 +43,10 @@ see the development tools document for a list of tools needed.

    Set up additional system resources

    The LiveSupport development environment uses some system resources, -that are not reasonable to include in the environment itself. One such +that are not reasonable to include in the environment itself.
    +

    Test database
    +

    +One such resource is an ODBC datasource to a test database. This database has to be accessible for executing the test suites and applications within the LiveSupport development environment.
    @@ -63,12 +66,34 @@ This data source should point to a PostgreSQL instance. Only one developer at the time should access this datasource, as the test suites regularly create and destroy database tables.

    +The test environment assumes that it can connect to the PostgreSQL +database as localhost via a TCP/IP connection, as the user test. To +achieve this access, please make sure to edit postgresql.conf +(usually /var/lib/postgres/data/postgresql.conf), to have +to following line:
    +
    +
    tcpip_socket = true
    +
    +and also edit pg_hba.conf (usually /var/lib/postgres/data/pg_hba.conf) +to include the following line, before other lines related to access +through localhost:
    +
    +
    host    all         all         127.0.0.1         255.255.255.255   password
    +
    +After the above two manual edits to the PostgreSQL configuration, +execute the script livesupport/bin/setup_test_db.sh , as +root to create the required database user, database and ODBC datasource.
    +

    Web server
    +

    Second, LiveSupport expects:

    Generated documentation

    diff --git a/livesupport/doc/install.html b/livesupport/doc/install.html new file mode 100644 index 000000000..a35b3d89a --- /dev/null +++ b/livesupport/doc/install.html @@ -0,0 +1,253 @@ + + + + + LiveSupport installation documentation + + + +

    Preface

    +This document is part of the LiveSupport +project, Copyright © 2004 Media +Development Loan Fund, under the GNU GPL.
    + +

    Scope

    +This document describes how to compile and install LiveSupport on your +system.
    +

    Introduction

    +LiveSupport has an installation procedure to make sure LiveSupport will +work properly on your system. This procedure consists of the following +steps:
    + +

    For the impatient

    +Those who think they know everything, the quick steps to install +LiveSupport are (make sure to run at least the ./bin/install.sh +script as root):
    +
    +
    wget http://ls-demo.campware.org/download/livesupport-<version>.tar.bz2
    wget http://ls-demo.campware.org/download/livesupport-libraries-<version>.tar.bz2
    tar xfj livesupport-<version>.tar.bz2
    tar xfj livesupport-libraries-<version>.tar.bz2
    cd livesupport-<version>
    make setup && make compile
    ./bin/install.sh -d /usr/local/livesupport -g apache
    ln -s /usr/local/livesupport/var /var/www/livesupport
    +
    +Then try the URL http://localhost/livesupport/htmlUI/var/html/ , +and log in using username: root, password: q.
    +
    +Everyone else, please read the lines below carefully.
    +

    Installing required compilation tools

    +This steps makes sure that all the required compilation tools and +libraries are installed.  Please refer to your systems package +management or the appropriate tools documentation for installation +instructions for the tools and libraries listed below.
    +

    Tools

    +The following tools are expected on the system.
    + +

    Libraries

    +The following development libraries are expected on the system. Please +note that for all the libraries below, the development packages are +expected to be installed as well.
    + +

    Installing and configuring required external services

    +LiveSupport depends on some external services to be able to run, most +importantly a PHP-capable web server (we assume apache), and a database +server (we assume PostgreSQL).
    +

    Database

    +LiveSupport expects a PostgreSQL +database, version 7.4 or later, to be installed on your system. The +database will be accessed through TCP/IP, usually via the localhost +interface. To achieve this, make sure to make the following changes to +the PostgreSQL configuration files.
    +
    +Edit postgresql.conf +(usually /var/lib/postgres/data/postgresql.conf), to have +to following line:
    +
    +
    tcpip_socket = true
    +
    +and also edit pg_hba.conf (usually /var/lib/postgres/data/pg_hba.conf) +to include the following line, before any other lines related to access +through localhost:
    +
    +
    host    all         all         127.0.0.1         255.255.255.255   password

    +These changes will make sure that the PostgreSQL database is accessible +via TCP/IP from localhost.
    +

    Web server

    +LiveSupport expects an apache web server with PHP and some additional +PHP modules installed. In particular: + +Please note the user group your apache daemon is running as (usually apache +or www-data), you will need this information later. Later +on in this document, this group will be referred to as <apache-group>.
    +

    Obtaining LiveSupport sources

    +LiveSupport sources come in two different tarballs:
    + +These files are accessible through the following URLs:
    + +After downloading the files, untar them in the same directory:
    +
    +
    tar xfj livesupport-<version>.tar.bz2
    tar xfj livesupport-libraries-<version>.tar.bz2
    +
    +which will create a livesupport-<version> +directory, with all the required files to compile and install +LiveSupport.
    +

    Compiling LiveSupport

    +To compile LiveSupport, enter the LiveSupport directory, and execute +the following commands:
    +
    +
    cd livesupport-<version>
    make setup && make compile
    +
    +This will take quite a while, so go have a tea, watch a movie, relax, +etc.
    +

    Installing LiveSupport
    +

    +After a successful compilation, to install LiveSupport, you have to +decide which directory you want LiveSupport installed into. This +directory will be referred to as <ls-installdir> +later on in this document.
    +
    +The installation is done using the bin/install.sh script +found in the LiveSupport base directory. This script has to be run as root. +To see the possible options to the script, invoke it with the --help +parameter. A brief overview of the most frequently used parameters:
    +
    +
      -d, --directory     The installation directory, required.

    +The installation directory, a required parameter. Supply the previously +decided LiveSupport installation directory here, <ls-installdir> +(as mentioned above). A sensible value to use here is /usr/local/livesupport.
    +

      -g, --apache-group  The group the apache daemon runs as.
                          [default: apache]

    +The user group the apache web server daemon runs at (see the section +above on installing apache). Supply the <apache-group> +value here, as mentioned above, which is usually either apache +or www-data.
    +

      -H, --host          The fully qualified host name of the system
                          [default: guess].

    +The fully qualified domain name of your system. If the install script +cannot determine your host name correctly, please supply the FQDN via +this parameter.
    +
    +Thus a typical invocation of the install script is the following:
    +
    +
    ./bin/install.sh -d <ls-installdir> -g <apache-group>
    +
    +The install script has more options, which enable you to customize your +installation of LiveSupport. Note that the defaults are usually quite +sensible values, which will create the following setup:
    +
    + +

    Configuring apache

    +After a successful run of the installation script, all LiveSupport +files are copied to <ls-installdir>. An additional +manual installation step is required, to make sure that the LiveSupport +web and XML-RPC interfaces are accessible through your apache web +server. LiveSupport expects that the URL http://<yourhost>/livesupport +points to the directory <ls-installdir>/var. To +achieve this, create a symbolic link from your apache document root to +the LiveSupport installation directory:
    +
    +
    ln -s <ls-installdir>/var <apache-docroot>/livesupport
    +
    +Where <apache-docroot> is dependent on your +installation, but is usually something like /var/www or /var/www/htdocs +or /var/www/<yourhost>/htdocs.
    +

    Try it out

    +The only thing left to do is to try out the LiveSupport web interface. +For this purpose, point your browser to the following URL: http://<yourhost>/livesupport/htmlUI/var/html/ +. For your first login, use the following values:
    + +Have fun!
    +
    +
    +
    + +