source: trunk/README @ 57

Last change on this file since 57 was 57, checked in by kake, 19 years ago

Added note on PREREQUISITES, added Search::InvertedIndex? to prereqs

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.8 KB
Line 
1OpenGuides Version 0.03
2=======================
3
4This distribution contains the OpenGuides wiki software. It requires:
5
6 - Module::Build for installation
7 - other prerequisite modules as detailed in PREREQUISITES
8 - a webserver (such as Apache)
9 - a Postgres database dedicated to the OpenGuides installation
10
11Unpack the distribution (using for example 'tar' or 'WinZip'), and set
12your working directory to be the top level of the distribution, then
13execute the following commands:
14
15perl Build.PL
16perl Build
17perl Build test
18perl Build install
19
20The very first of these commands asks a number of questions regarding
21the installation.
22
23"What do you want the script to be called?"
24
25The default is for the main script to be called "wiki.cgi", but
26you may prefer to name it after your city - "leeds-guide.cgi" for
27example.  Note that your webserver may be configured to only allow
28execution of scripts ending in, for example, ".cgi"
29
30"What directory should I install it in?"
31
32You need to pick a directory for the OpenGuides software to be
33installed in.  This must be one known to the webserver as containing
34CGI scripts.  You will need to have write permission on this directory
35when you come to run "perl Build install"; unless this is a private
36directory belonging to you then this might require an 'su' or 'sudo'
37to root under Unix.
38
39"What URL does the install directory map to?"
40
41Give the full address needed to access the installation directory with
42a web browser - for example http://london.openguides.org/cgi-bin/
43
44"What directory can I use to store indexes in for searching?"
45
46You need a directory to store files used as indexes for the site. The
47webserver will need write permission on this directory.  Under some
48webserver configurations this might be a dedicated user - 'nobody' or
49'www-data' for example, but for many multi-user systems this will just
50be yourself.
51
52"What's the URL of the wiki's stylesheet?"
53
54Supplying an answer to this question is optional.  TODO - supply and
55optionally install a simple stylesheet with the OpenGuides distribution.
56
57"What's the name of the postgres database that this site runs on?"
58"And the database user that can access that database?"
59"And the password that they use to access the database?"
60
61You should create (or ask your ISP/sysadmin to create) a Postgres
62database specifically for the use of OpenGuides.  If you have more
63than one OpenGuides installation, for example if you run guides for
64more than one city, each installation will need its own database.
65
66TODO - support MySQL and SQLite as well (this is really going to be
67pretty trivial).
68
69"What's the wiki called?"
70
71This is a title which will appear at the top of every page.
72
73"What should the home page of the wiki be called?"
74"How would you describe the wiki?"
75"What city is the wiki based in?"
76"What country is the wiki based in?"
77"Contact email address for the wiki admin?"
78
79Self explanatory.
80
Note: See TracBrowser for help on using the repository browser.