4 1. Use omindex to build an index of your website::
6 $ omindex --db DBPATH --url / WEBPATH
8 Where DBPATH is where you want the database, such as
9 /var/lib/omega/data/default and WEBPATH is the directory containing
10 all your web documents - e.g. /var/www.
12 To start off with, it is advisable to have the final directory of the
13 database be called 'default'. This is what Omega expects, although it
14 can be changed once you've got things going.
18 This contains 3 settings, written one per line as "<SETTING> <VALUE>":
20 * database_dir - this should point to the directory containing your
21 database(s), for example /var/lib/omega/data (this should contain a
22 database called 'default' which is the database you indexed to above).
24 * template_dir - the directory where the OmegaScript templates are, for
25 example /var/lib/omega/templates (this should contain an OmegaScript
26 template called 'query' which is used by default).
28 * log_dir - the directory which the OmegaScript $log command writes log files
29 to, for example /var/log/omega .
31 3. Test omega from the command line::
33 $ /usr/lib/xapian-omega/bin/omega 'P=my search terms' HITSPERPAGE=10
35 (The path to omega may be different in your installation.)
37 This will output quite a lot of HTML. Normally you use omega via CGI, but it
38 also has this test mode which is useful for checking that everything works
39 independent of your webserver configuration. To actually use omega, you
40 should install it to run via CGI by copying or linking the omega executable
41 into your cgi-bin directory.
43 For more information, see the `overview <overview.html>`_ document. There
44 are other documents covering the `CGI parameters <cgiparams.html>`_ which
45 omega accepts, and the `OmegaScript <omegascript.html>`_ language used to
46 control the format of omega's output.