Updated TODO.
[gruta.git] / INSTALL
blobbef2921fbe8c67baa3a13bfab328edb0e4e743aa
1 Gruta INSTALL
2 =============
4 1. Install the Artemus and Grutatxt modules, available from:
6         http://triptico.com/software/artemus.html
7         http://triptico.com/software/grutatxt.html
9 If you want to use the DBI source driver, you'll need DBI and a
10 corresponding DBD, of course. SQLite is fine and probably what
11 you want.
13 2. Install this package:
15         $ perl Makefile.PL
16         $ make
17         $ su -c "make install"
19 3. Create the directories under your Apache tree. For example, if you
20 plan to host the _grutasample_ site and you have Apache files in /var/www,
21 then run
23         # mkdir /var/www/grutasample /var/www/grutasample/img
24         # chown -R www-data:www-data /var/www/grutasample
26 Change `www-data' to whatever user your Apache runs as.
28 4. Create a directory where your application data will be stored. The
29 Apache user needs to write there, so make him the owner. For organization
30 purposes, it can be under the .../grutasample directory; just ensure
31 it's not accesible via web by means of an Apache authorization directive
32 (see below).
34 5. Copy the `g.cgi' file from the `examples' subdirectory in the
35 distribution source.
37 6. Modify it to suit your needs. You'll have to change the $base variable,
38 the source driver (choose between DBI or FS) and the `base_url'. If your
39 data directory is not under $base, change the reference in the Source
40 object creation accordingly. You'll probably also have to change the
41 language of your application templates (look for available languages in
42 /usr/share/gruta/templates/artemus) and the setlocale() call.
44 7. Touch your Apache configuration. First, make the `g.cgi' program be the
45 document index, by adding the following to your configuration file:
47         DirectoryIndex g.cgi
49 If your data directory is under the Apache tree, forbid raw access to
50 it by adding
52         <Location /var>
53                 order allow,deny
54                 deny from all
55         </Location>
57 This will probably be under a virtual host configuration. Use your Apache
58 knowledge, this is not an Apache manual.
60 8. Point your browser to the URL. As it's the first time, an `admin' user
61 with a random password has been created and the program flow redirected
62 to the administration page. Select the `admin' user from the 'Users' section
63 and set the password.
65 9. Create some topics. New topics will appear in the top menu. Clicking on
66 them will allow you to create new stories. If you create a topic with the
67 topic id 'info', the stories with ids 'about' and 'legal' will be magically
68 added to the top header. For the rest of your stories, create another topic.
69 One with id 'main' will be OK.
71 ---
72 Angel Ortega <angel@triptico.com>