initial import from pitchfork-0.5.5
[patchfork.git] / doc / INSTALL
1 Installation instructions
2
3 1. Put either the pitchfork.conf or pitchfork_domain.conf file, found in this doc/ directory,
4    in /etc/http/conf.d (or where your extra config-files are) 
5    and make sure they specify the correct directories for pitchfork.
6 2. Apache needs to have write access to the config directory: 
7    - Go to where you installed pitchfork
8    - chown apache config (or whatever user apache is run as, can be 'nobody')
9      to find out who the apache-user is check output from "ps auxww | grep httpd || ps auxww|grep apache"
10 3. Reload/restart apache
11 4. Open your web-browser to where you installed apache and answer the questions ;)
12
13 Apache access logs
14 The client by default requests information every second from the server, this means that a lot of 
15 stuff will end up in your access log. To disable logging of the these requests you will have to 
16 change the CustomLog directive in apache. It should be sufficient to add env=!pitchforknolog after it 
17 (if you have used the given .conf file)
18
19 Example customlog directive:
20 CustomLog logs/access_log combined env=!pitchforknolog
21
22 For more information about logs: 
23 http://httpd.apache.org/docs/2.0/logs.html#accesslog
24
25 Required PHP-Modules:
26 Usually shipped with the php-distribution, but listed here for modular php-implementations.
27  - Hash
28  - SimpleXML
29  - JSON (not required, but highly recommended)
30
31
32 When you have problems: 
33
34  * apache refuses to start and you see "invalid command php_flag"
35  * The only thing you see is some PHP-code
36         - You have to enable PHP in httpd.conf, make sure you have 
37         "LoadModule php5_module modules/libphp5.so" somewhere in the config file
38
39  * All you see is a blank page OR
40  * Warning: require_once(PEAR/Exception.php) [function.require-once]: 
41      failed to open stream: No such file or 
42      directory in <something>/pitchfork/inc/Net/MPD.php
43         - You need to install php-pear (might also be called PEAR-PEAR)
44  
45  * Allowed memory size of .. bytes exhausted in apache error log
46         - You need to increase the allowed memory size in php.ini, 
47           set memory_limit to at least 64M
48  
49  * No metadata (ie. images/lyrics/etc) is showing
50         - make sure allow_url_fopen is set to on in php.ini and that the config/ directory 
51           is writeable by apache
52
53
This page took 0.019184 seconds and 4 git commands to generate.