Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 60 lines (44 sloc) 2.633 kb
e148a76 @gohai initial import (beta0)
gohai authored
1 SERVER REQUIREMENTS
2
3 * Apache 2.x
4 * PHP 5.x
5 * (optional) mod_rewrite (for short URLs)
6 * (optional) php5-gd (for server-side image resizing)
7
8 The current version of Hotglue was only extensively tested on Linux hosts.
9
10
11 CLIENT REQUIREMENTS
12
13 * for editing: Mozilla Firefox (>= 3.6) or Google Chrome (>= 8.0)
14
15 While we haven't tested it, editing could also work on any recent Safari version.
16
17 * for viewing: the above plus Internet Explorer 8 (but keep IE8_COMPAT in the
18 config set to true)
19
20
21 INSTALLING HOTGLUE
22
23 * copy the directory of the tarball to a directory that is accessible to the
24 server
b3c1421 @gohai re-implement preliminary support for font-families
gohai authored
25 * make sure the webserver can write to the content directory and all contained
26 files (e.g. by running "chmod -R 0777 content" in the directory that you just copied the files to)
e148a76 @gohai initial import (beta0)
gohai authored
27 * it is recommended that you create a user-config.inc.php file where you
28 can overwrite the settings defined in config.inc.php. the former file won't
29 get overwritten by future updates.
30 * make sure that you at least set AUTH_PASSWORD to a non-default value.
31 * (optional) if your hosting environment allows you to use mod_rewrite and
32 you want to use short URLs for your pages, you can rename the htaccess-dist
33 file to .htaccess (e.g. by running "move htaccess-dist .htaccess")
7c5956a @gohai add support for hosts that run php on fastcgi (needs .htaccess installed...
gohai authored
34 * if php is not installed as a module to apache (mod_php), but rather installed
35 as (Fast-)CGI binary, installing the htaccess file is mandatory (see known
36 issues section in README)
e148a76 @gohai initial import (beta0)
gohai authored
37
38 and finally
39
40 * launch the directory's URL from a browser and add "?edit" to the address
41 (e.g. http://myserver.com/hotglue/?edit) to start editing
42
43 If you are using the optional .htaccess file you can also start editing by
44 just adding "edit" (e.g. http://myserver.com/hotglue/edit).
45
46
47 DEBUGGING HOTGLUE
48
49 If something breaks and you want to troubleshoot the problem it is helpful to
50 turn on PHP error reporting by setting or adding "error_reporting(E_ALL);" to
51 your user-config.inc.php file.
52 You can also set the LOG_LEVEL (see config.inc.php) to 'debug' in order to get
53 an overwhelming amount of logging information written to your log file, which
54 by default is in the content directory.
55 Requests from the client start in the log file with "--- request ---" and AJAX
56 requests with "--- json request ---". If you report a problem, make sure you
57 send with it only the relevant pieces of logging information (like the request
58d0d77 @gohai run pngcrush on all images
gohai authored
58 and all associated AJAX request that get written when the problem occurs).
59 For debugging frontend (JavaScript) issues, you can set USE_MIN_FILES to
ea96688 @gohai whitespace (and a css fix)
gohai authored
60 false.
Something went wrong with that request. Please try again.