root/trunk/INSTALL

Revision 605, 5.4 KB (checked in by yomguy, 5 days ago)

- now depends on TimeSide? for the web audio components
- removed old processors based on audiolab & subprocess pipes (bye bye)
- analyzers are working but removed *temporaly* from templates
- improve caching for image and audio media streaming
- fixed many bugs around timeside, BE CAREFUL, needed more tests for 0.5.2

Line 
1==================
2Telemeta - INSTALL
3==================
4
5Requirements
6============
7
8Telemeta is designed to run on Linux and other UNIX based architectures.
9The following third party applications or libraries are required:
10
11:dependencies: python (>= 2.3.5-7), python-xml, python-mutagen, python-django (>= 1.0-1),
12               python-imaging (>= 1.1.6), sox (>= 14.2), vorbis-tools, flac, normalize-audio,
13               python-mysqldb, mysql-server, python-timeside (>= 0.2), python-numpy, python-scipy
14               python-ctypes (>= 1.0.1), python-setuptools (>= 0.6b3),
15               python-support (>= 0.3), python-docutils (>= 0.5)
16
17:optional:     ecasound, festival, par2
18
19Here, package names are taken from the Debian OS and could be different on other platforms.
20
21
22Install
23=======
24
25-----------------------
261. Install the software
27-----------------------
28
291.1 Install Telemeta
30--------------------
31
32* On Debian (Testing recommended) or Ubuntu Hoary
33
34    Just add these lines to your /etc/apt/sources-list::
35
36        deb http://debian.parisson.org/ binary/
37        deb-src http://debian.parisson.org/ source/
38        deb http://www.debian-multimedia.org etch main
39
40    Then::
41
42    $ sudo apt-get update
43    $ sudo apt-get install telemeta
44
45    This method provides the installation of all needed packages
46    thanks to the Debian dependency system.
47    Go to 1.2.
48
49* On other linux platforms
50
51    Install all dependencies.
52
53    Download the latest release of telemeta at
54    http://telemeta.org
55
56    Uncompress the archive like::
57
58    $ tar xzvf telemeta_0.3.2.tar.gz
59
60    Go to the main folder of telemeta and run this command
61    in a shell as root::
62
63    $ sudo python setup.py install
64
65
661.2. Install TimeSide
67---------------------
68
69In order to get all the Web Audio Components from TimeSide,
70you have to download and install it from source.
71
72So, checkout the last archives at :
73http://code.google.com/p/timeside/downloads/list
74
75Install it like in the following example::
76
77$ tar xzf timeside-0.2.tar.gz
78$ cd timeside-0.2
79
80Read the README and INSTALL file, install dependencies and then::
81
82$ sudo python setup.py install
83
84
851.3. Install the Django framework version 1.0
86---------------------------------------------
87
88* On Debian (Lenny recommended) or Ubuntu Hoary::
89
90    $ sudo apt-get install python-django
91
92* On other linux platforms, download and install it from:
93
94    http://www.djangoproject.com/download/
95
96
97--------------------------
982. Create a Django project
99--------------------------
100
101If you haven't already done it, start a new django project::
102
103    $ cd ~/my_projects
104    $ django-admin startproject mysite
105
106
107-----------------------------------------
1083. Create the media and cache directories
109-----------------------------------------
110
111We need 2 directories for media and caching::
112
113    $ cd mysite
114    $ mkdir media cache
115
116You might want to place these somewhere else...
117
118
119----------------------------------
1204. Configure the telemeta project
121----------------------------------
122
123Edit the file settings.py in a text editor.
124Modifiy the following variables:
125
126    :ADMINS:            telemeta requires that you indicate an administrator here
127    :DATABASE_*:        your database settings (don't forget to create the database if needed)
128    :MEDIA_ROOT:        absolute path to the media directory you just created
129    :INSTALLED_APPS:    add 'telemeta'
130    :TEMPLATE_CONTEXT_PROCESSORS: include 'django.core.context_processors.request' and
131                                  'django.core.context_processors.auth' in this tuple
132
133Add the following variables:
134
135    :TELEMETA_ORGANIZATION: name of the organization which hosts this installation
136    :TELEMETA_SUBJECTS:     tuple of subject keywords (used for Dublin Core), such
137                            as "Ethnology", etc...
138    :TELEMETA_CACHE_DIR:    absolute path to the cache directory that you just created
139    :TELEMETA_GMAP_KEY:     your Google Map API key
140    :TELEMETA_DOWNLOAD_ENABLED: True to enable audio data download
141
142Just paste the lines below::
143
144    LOGIN_URL = '/login'
145    LOGIN_REDIRECT_URL = '/'
146    TELEMETA_EXPORT_CACHE_DIR = TELEMETA_CACHE_DIR + "/export"
147    TELEMETA_DATA_CACHE_DIR = TELEMETA_CACHE_DIR + "/data"
148    CACHE_BACKEND = "file://" + TELEMETA_CACHE_DIR + "/data"
149
150
151--------------------------
1525. Initialize the database
153--------------------------
154
155This synchronizes the DB with the model::
156
157    $ python manage.py syncdb
158
159
160----------------------
1616. Configure your urls
162----------------------
163
164    The simplest case is to have telemeta running at public root. To do so, add this url in urls.py::
165
166    (r'^', include('telemeta.urls')),
167
168
169--------------------
1707. Start the project
171--------------------
172
173We are ready to start the telemeta server::
174
175    $ python manage.py runserver
176
177By default, the server starts on the port 8000. You can override this with, for example::
178
179    $ python manage.py runserver 9000
180
181
182------------------------------------
1838. Go the web page with your browser
184------------------------------------
185
186    http://localhost:8000
187
188    or
189
190    http://localhost:9000
191
192
193See README and http://telemeta.org for more informations.
194
195
196-------------------
1979. Configure Apache
198-------------------
199
200If you want to use Telemeta through a web server, it is highly recommended to use Apache 2
201with the mod_wsgi module as explained in the following page :
202
203http://docs.djangoproject.com/en/1.1/howto/deployment/modwsgi/#howto-deployment-modwsgi
204
205This will prevent Apache to put some audio data in the cache memory as it is usually the case with mod_python.
Note: See TracBrowser for help on using the browser.