Document some requirements in the README.
[rockboxthemes.git] / README
blobf8c099b0ea344eafb3e871a14be1c69704606f0c
1 == REQUIREMENTS ==
3 1. Apache with PHP5
4 2. Smarty (http://smarty.net/ or the 'smarty' package on Debian systems)
5 3. magic_quotes_gpc = Off in your apache config (or .htaccess)
7 == INSTALLATION ==
9 1. Put the dir "public" somewhere where your webserver can see it. If you're
10    running the main site, making it the document root is expected.
11 2. Edit public/preconfig.inc.php to point to the location of
12    private/config.inc.php. This directory should absolutely NOT be reachable
13    through the webserver.
14 3. Edit private/config.inc.php and fix all the paths/settings.
15 4. The following dirs/files need to be writable by the webserver user:
16     - private/themes.db
17     - private/templates/cache
18     - private/templates/compiled
19     - public/themes
20     - private/themes
21 5. Compile checkwps for all targets and put them in private/checkwps/release
22    and private/checkwps/current. Put their versions in a file named VERSION
23    in each dir. See private/checkwps/current/update.sh for an easy way to do
24    this.
25 6. Add some admin users using private/adduser.sh. This is done through the
26    console to create an implicit "superadmin".