source: INSTALL @ 88eba7a

==================
Telemeta - INSTALL
==================

-----------------
0. Requirements
-----------------

Telemeta is designed to run on Linux and other UNIX based architectures.
It depends on several python librairies like Django (version >= 1.1.1).
See http://djangoproject.com.

Other needed librairies are listed below.

-----------------------
1. Install the software
-----------------------

Install the dependencies
-------------------------

* On Debian (Squeeze recommended) or Ubuntu Lucid:

    Install all dependencies like this::
        
        sudo aptitude install python python-xml python-mutagen python-django \
                              python-imaging python-mysqldb mysql-server python-numpy python-scipy \
                              python-ctypes python-setuptools python-support python-docutils

    Just add these lines to your /etc/apt/sources-list::

        deb http://debian.parisson.org/ binary/
        deb-src http://debian.parisson.org/ source/
        deb http://www.debian-multimedia.org stable main

    Then::

        sudo apt-get update

* On other linux platforms:

    Please install all dependencies thanks to your application manager.


Install TimeSide
-----------------

In order to get all the Web Audio Components from TimeSide,
you have to download and install it from source.

So, checkout the last archives at :
http://code.google.com/p/timeside/downloads/list

Install it like in the following example::

    tar xzf timeside-0.2.tar.gz
    cd timeside-0.2

Read the README and INSTALL file, install dependencies and then::

    sudo python setup.py install


Install Telemeta
------------------

* On Debian style systems, if you have added our repositories::

    sudo apt-get install telemeta

* Else:

    Download the latest release of telemeta at
    http://telemeta.org

    Uncompress the archive like::

        tar xzvf telemeta_0.5.1.tar.gz

    Go to the main folder of telemeta and run this command
    in a shell as root::

        sudo python setup.py install


--------------------------
2. Create a Django project
--------------------------

If you haven't already done it, start a new django project::

    cd ~/my_projects
    django-admin startproject mysite


-----------------------------------------
3. Create the media and cache directories
-----------------------------------------

We need 2 directories for media and caching::

    cd mysite
    mkdir media cache cache/data cache/export


You might want to place these data directories somewhere else, no pb.


----------------------------------
4. Configure the telemeta project
----------------------------------

Edit the file settings.py in a text editor.
Modifiy the following variables:

    ADMINS =            telemeta requires that you indicate an administrator here
    DATABASE_* =        your database settings (don't forget to create the database if needed)
    MEDIA_ROOT =        absolute path to the media directory you just created
    INSTALLED_APPS =    add 'telemeta' to the tuple
    
Add the following variables:

    TELEMETA_ORGANIZATION =  name of the organization which hosts this installation
    TELEMETA_SUBJECTS =      tuple of subject keywords (used for Dublin Core), such as "Ethnology", etc...
    TELEMETA_CACHE_DIR =     absolute path to the cache directory that you just created
    TELEMETA_GMAP_KEY =      your Google Map API key
    TELEMETA_DOWNLOAD_ENABLED =  True to enable audio data download

Just paste the lines below::

    LOGIN_URL = '/login'
    LOGIN_REDIRECT_URL = '/'
    TELEMETA_EXPORT_CACHE_DIR = TELEMETA_CACHE_DIR + "/export"
    TELEMETA_DATA_CACHE_DIR = TELEMETA_CACHE_DIR + "/data"
    CACHE_BACKEND = "file://" + TELEMETA_CACHE_DIR + "/data"


--------------------------
5. Initialize the database
--------------------------

This synchronizes the DB with the model::

    python manage.py syncdb


----------------------
6. Configure your urls
----------------------

    The simplest case is to have telemeta running at public root. To do so, add this url in urls.py::

    (r'^', include('telemeta.urls')),


--------------------
7. Start the project
--------------------

We are ready to start the telemeta server::

    python manage.py runserver

By default, the server starts on the port 8000. You can override this with, for example::

    python manage.py runserver 9000


------------------------------------
8. Go the web page with your browser
------------------------------------

    http://localhost:8000

    or

    http://localhost:9000

Enjoy it !

-------------------
9. Configure Apache
-------------------

If you want to use Telemeta through a web server, it is highly recommended to use Apache 2
with the mod_wsgi module as explained in the following page :

http://docs.djangoproject.com/en/1.1/howto/deployment/modwsgi/#howto-deployment-modwsgi

This will prevent Apache to put some audio data in the cache memory as it is usually the case with mod_python.

-------------------------
10. Contact / More infos
-------------------------

See README and http://telemeta.org.