source: trunk/INSTALL @ 703

Last change on this file since 703 was 613, checked in by kake, 17 years ago

city or city -> city or country

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.7 KB
Line 
1OpenGuides installation instructions
2====================================
3
4
5If while following the instructions below or while trying to use your
6OpenGuides install you see an error that you don't understand, please
7consult the TROUBLESHOOTING file.
8
9For details about installing multiple OpenGuides sites on a single
10server, see further down this file.
11
12* Basic installation
13
14Unpack the distribution (using for example 'tar' or 'WinZip'), and set
15your working directory to be the top level of the distribution.
16
17If you have an existing "wiki.conf" configuration file and you wish
18to keep using the values in that, copy it to this directory.
19
20Now execute the following commands:
21
22perl Build.PL
23perl Build
24perl Build test
25perl Build install
26
27The very first of these commands asks a number of questions regarding
28the installation.
29
30
31  "Skip OpenGuides configuration?"
32
33Answer "n" to this question unless you really know what you're doing.
34It's mainly there for developers.
35
36
37  "What type of database do you want the site to run on?"
38
39Answer "postgres", "mysql", or "sqlite".
40
41
42  "What's the name of the database that this site runs on?"
43  "...the database user that can access that database?"
44  "...the password that they use to access the database?"
45
46You should create (or ask your ISP/sysadmin to create) a database
47specifically for the use of OpenGuides.  If you have more than one
48OpenGuides installation, for example if you run guides for more than
49one city, each installation will need its own database.
50
51
52  "...the machine that the database is hosted on? (blank if local"
53
54If the database is running on a local machine with username/password
55authentication then just press RETURN to skip this question.  If it
56is running on a local machine with IDENT authentication then you may
57need to answer "localhost" to this question.  If it is running on a
58remote machine then enter the full hostname of that machine.
59
60
61  "What do you want the script to be called?"
62
63The default is for the main script to be called "wiki.cgi", but
64you may prefer to name it after your city - "leeds-guide.cgi" for
65example.  Note that your webserver may be configured to only allow
66execution of scripts ending in, for example, ".cgi"
67
68
69  "What directory should I install it in?"
70
71You need to pick a directory for the OpenGuides software to be
72installed in.  This must be one known to the webserver as containing
73CGI scripts.  You will need to have write permission on this directory
74when you come to run "perl Build install"; unless this is a private
75directory belonging to you then this might require an 'su' or 'sudo'
76to root under Unix.
77
78
79  "What directory should I install the templates in?"
80  "Where should I look for custom templates?"
81
82Normally these will be in the install directory, but they can be anywhere.
83Custom templates are intended to be user-modified, so you might want to
84put them somewhere in /etc.
85
86
87  "What URL does the install directory map to?"
88
89Give the full address needed to access the installation directory with
90a web browser - for example http://london.openguides.org/cgi-bin/
91
92
93  "Do you want me to munge a custom lib path into the scripts?"
94
95If you have installed some or all of the required Perl modules (or indeed
96the OpenGuides modules themselves) into a private directory, you will
97need to tell the scripts where to find these modules.  Enter the paths
98to search here just as you would enter them in a 'use lib qw( ... );'
99in a Perl script.
100
101
102  "Do you want to use Plucene for searching?"
103
104From version 0.39 of OpenGuides, you have the option of using Plucene
105to index your wiki instead of Search::InvertedIndex.  If you answer
106yes to this question, you will need to make sure you have installed
107both Plucene, and CGI::Wiki version 0.56 or later.
108
109If you are changing to Plucene from Search::InvertedIndex, you will
110need to do two things:
111    - either delete your old indexes (they're just files in the index
112      directory) or use a different index directory
113    - reindex your entire wiki (see reindex.pl in the examples/
114      directory of this distribution)
115
116
117  "What directory can I use to store indexes in for searching?"
118
119You need a directory to store files used as indexes for the site. The
120user that your script will run as will need write permission on this
121directory.  Under some webserver configurations this might be a
122dedicated user - 'nobody' or 'www-data' for example, but for many
123multi-user systems this will just be yourself.
124
125
126  "Do you want to enable page deletion?"
127  "Please specify a password for the site admin."
128
129The default is to disable page deletion.  If you choose to enable the
130page deletion mechanism then you will need to add a password to your
131wiki.conf by answering the question above or manually using a line such as
132  admin_pass = putyourpasswordhere
133Users who know this password will be able to delete unwanted pages -
134along with all their history - from your wiki.
135*** USE WITH CAUTION.  DELETED PAGES CANNOT BE RECOVERED. ***
136
137
138  "What's the URL of the site's stylesheet?"
139
140Supplying an answer to this question is optional.  There are example
141stylesheets in the examples/ directory - note that these will not be
142automatically installed.
143
144
145  "What's the wiki called?"
146
147This is a title which will appear at the top of every page.  If you have
148more than one OpenGuides installation at the same site then each should
149have a unique name, since this name is used to manage user preferences.
150
151
152  "Do you want the navigation bar included on the home page?"
153
154Answer "y" or "n".
155
156
157  "What should the home page of the wiki be called?"
158  "How would you describe the wiki?"
159
160Self-explanatory.
161
162
163  "What city is the wiki based in?"
164  "What country is the wiki based in?"
165
166If the wiki will not be city or country specific you can leave either or
167both of these blank.
168
169
170  "Contact email address for the wiki admin?"
171
172Self explanatory.
173
174
175  "What language will the site be in? (Please give an ISO language code.)"
176
177eg "en" for English, "it" for Italian.
178See http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt
179
180
181  "What's the name of the node or page to use for the text formatting
182   rules link?"
183  "What URL do you want to use for the text formatting rules"
184
185From 0.19, OpenGuides allows users to choose whether or not to have a
186permanent link to the text formatting rules node or page in their navbar.
187You need to put the name of that node or URL in here for it to work, though.
188You might want to call the node "Text Formatting Examples",
189"Text Formatting Rules", "House Style" or whatever.
190
191Note that these the latter question will override the former, so if you
192want to use a local node make sure to leave the latter blank.
193
194
195  "Distance calculation methods available are:
196      1) British National Grid
197      2) Irish National Grid
198      3) UTM ellipsoid
199   Which would you like to use?"
200
201  (and if you choose UTM ellipsoid)
202  "Which ellipsoid would you like to use? (eg 'Airy', 'WGS-84')"
203
204See http://www.vterrain.org/Projections/ for how this all works.
205A UTM (Universal Transverse Mercator) ellipsoid maps latitude and
206longitude to eastings and northings on a square grid, which allows
207more accurate distance calculations within the guide.  The British and
208Irish National Grids are scaled and parametrised versions of UTM
209ellipsoids (Airy 1830 in the British case, Modified Airy in the Irish).
210
211Please note that at the moment there is no provision for changing your
212mind later about which ellipsoid to use, but it shouldn't be too hard
213to write a conversion script so don't worry too much about picking the
214wrong one.  However do note that once you've entered some location
215data you should not change this value in the config file without running
216some kind of converter.
217
218If you decide to use the British or Irish National Grid, your users
219will be able to choose between entering location data as lat/long
220or as grid co-ordinates.
221
222You must have Geography::NationalGrid::GB installed to use the British
223National Grid, Geography::NationalGrid::IE to use the Irish National
224Grid, and Geo::Coordinates::UTM to use a UTM ellipsoid.
225
226* Dependency errors
227
228If, after you have answered these questions, the build script complains
229about missing dependencies, don't panic! Simply install them from CPAN and
230then try again. Note that a wiki.conf file will have been written out at
231this point, so if you retain it you won't have to answer all the questions
232again.
233
234* Custom templates and CSS
235
236Once you have installed OpenGuides you may wish to edit templates that
237provide site-specific design. These templates are stored in the directory
238custom-templates/ by default and are described in the file CUSTOMISATION.
239The id and class tags used for the CSS in OpenGuides are specified in
240README.CSS.
241
242* Security
243
244The installer will try to create (or modify an existing) a .htaccess file
245to protect wiki.conf, which contains sensitive data (ie passwords).
246However we cannot tell whether apache (or any other web server you may be
247using) is using this file, so you should check that it functioning and that
248you cannot access wiki.conf over HTTP.
249
250You should also configure wiki.conf with the minimum permissions required
251so that local users cannot read the file. This is difficult to automate,
252but the file should be probably be mode 0640, owned by root or an admin
253user, and set to the group the web server runs with.
254
255* Web server configuration
256
257In order to let your web server serve up OpenGuides correctly, you will
258have to tell it to recognise your installation directory as one
259containing CGI scripts. However you can make your URLs nicer by
260employing mod_rewrite as well. The following Apache configuration
261directives show how:
262
263        Alias /myguide /usr/lib/cgi-bin/myguide
264        <Directory /usr/lib/cgi-bin/myguide>
265            Options FollowSymLinks Indexes ExecCGI
266            RewriteEngine on
267            RewriteBase /myguide/
268            RewriteRule ^$      wiki.cgi        [L]
269        </Directory>
270        Redirect /cgi-bin/myguide/ http://www.example.com/myguide/
271
272You will of course need to make the appropriate substitutions for
273your site. You also need to make sure that mod_rewrite is enabled in
274your web server before adding such a configuration. The final step in
275this URL tidying is to tell OpenGuides that the main CGI script can be
276assumed to be called from the root of the install directory; do this by
277setting the script name to be empty in wiki.conf:
278
279        # what do you want the script to be called?
280        script_name =
281
282Currently the Build script does not support this value, so you will
283have to make sure that you fix this up after an upgrade.
284
285
286* Multiple installations
287
288If you want to run multiple OpenGuides sites on one machine, you can use
289some tricks to make life easier. This isn't currently part of the official
290install routine, but will generally work. In the rest of this section we
291will assume that you already have a working OpenGuides install for a
292single site.
293
294Make a directory for the new site, and populate it with a set of symlinks
295to the main installation directory (ie. for wiki.cgi, supersearch.cgi,
296newpage.cgi, preferences.cgi, and the templates directory). wiki.conf
297will not be a symlink, since this will differ from the original site.
298In this case, simply copy the wiki.conf from the original install and
299modify it in the obvious way; most importantly, by giving it a different
300database name (we'll create the database in a moment). Don't forget to
301set up a separate directory for indices for the new site.
302
303Normally, the database is created by the installation process described
304above; however since we only want one copy of the modules and CGI
305programs, it isn't appropriate to run them again. So we will make use of
306the utility program "cgi-wiki-setupdb" which is included with the
307CGI::Wiki distribution. Documentation for this command can be found in
308its man page; run this with the appropriate arguments to create the
309new database.
310
311Once the key step of setting up the database has been performed, and the
312web server configured appropriately, the new site should be ready to go!
Note: See TracBrowser for help on using the repository browser.