source: trunk/INSTALL @ 837

Last change on this file since 837 was 837, checked in by Dominic Hargreaves, 15 years ago

Deprecate Search::InvertedIndex?

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.5 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
104This question is no longer asked, but documentation here is retained for
105the benefit of people upgrading.
106
107If you are changing to Plucene from Search::InvertedIndex, you will
108need to do two things:
109    - either delete your old indexes (they're just files in the index
110      directory) or use a different index directory
111    - reindex your entire wiki (see reindex.pl in the examples/
112      directory of this distribution)
113
114
115  "What directory can I use to store indexes in for searching?"
116
117You need a directory to store files used as indexes for the site. The
118user that your script will run as will need write permission on this
119directory.  Under some webserver configurations this might be a
120dedicated user - 'nobody' or 'www-data' for example, but for many
121multi-user systems this will just be yourself.
122
123
124  "Do you want to enable page deletion?"
125  "Please specify a password for the site admin."
126
127The default is to disable page deletion.  If you choose to enable the
128page deletion mechanism then you will need to add a password to your
129wiki.conf by answering the question above or manually using a line such as
130  admin_pass = putyourpasswordhere
131Users who know this password will be able to delete unwanted pages -
132along with all their history - from your wiki.
133*** USE WITH CAUTION.  DELETED PAGES CANNOT BE RECOVERED. ***
134
135
136  "What's the URL of the site's stylesheet?"
137
138Supplying an answer to this question is optional.  There are example
139stylesheets in the examples/ directory - note that these will not be
140automatically installed.
141
142
143  "What's the wiki called?"
144
145This is a title which will appear at the top of every page.  If you have
146more than one OpenGuides installation at the same site then each should
147have a unique name, since this name is used to manage user preferences.
148
149
150  "Do you want the navigation bar included on the home page?"
151
152Answer "y" or "n".
153
154
155  "What should the home page of the wiki be called?"
156  "How would you describe the wiki?"
157
158Self-explanatory.
159
160
161  "What city is the wiki based in?"
162  "What country is the wiki based in?"
163
164If the wiki will not be city or country specific you can leave either or
165both of these blank.
166
167
168  "Contact email address for the wiki admin?"
169
170Self explanatory.
171
172
173  "What language will the site be in? (Please give an ISO language code.)"
174
175eg "en" for English, "it" for Italian.
176See http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt
177
178
179  "What's the name of the node or page to use for the text formatting
180   rules link?"
181  "What URL do you want to use for the text formatting rules"
182
183From 0.19, OpenGuides allows users to choose whether or not to have a
184permanent link to the text formatting rules node or page in their navbar.
185You need to put the name of that node or URL in here for it to work, though.
186You might want to call the node "Text Formatting Examples",
187"Text Formatting Rules", "House Style" or whatever.
188
189Note that these the latter question will override the former, so if you
190want to use a local node make sure to leave the latter blank.
191
192  "Make node titles link to node backlinks (C2 style)?"
193
194This refers to turning titles into links which bring up a list of referring
195pages. This was the convention with older wikis, but is not intuitive.
196
197  "Do you have a Google Maps API key to use with this guide?"
198
199If you want Google Maps integration, you need to register with Google to get
200an API key. Visit http://www.google.com/apis/maps/signup.html and follow the
201instructions. Paste the great long string into the console window where you
202are installing. See README.GMAPS for more information.
203
204  "What is the longitude of the centre point of a map to draw for your guide?"
205  "What is the latitude of the centre point of a map to draw for your guide?"
206
207It's probably a good idea to pick some notionally central point for your
208guide. For example, Carfax for Oxford, Charing Cross for London.
209
210  "What default zoom level shall we use for Google Maps?"
211  "What default zoom level shall we use for Google Maps in the search results?"
212
213The defaults are probably appropriate in most cases.
214
215  "Forcibly treat stored lat/long data as if they used the WGS84 ellipsoid?"
216
217Default this answer if you don't know what it means.
218
219  "What licence will you use for the guide?"
220
221We strongly recommend that you think at the outset about the licence your
222guide will use, for maximum usefulness. In particular for a guide that will
223be on the OpenGuides network, we recommend the
224"Creative Commons Attribution-ShareAlike 2.5" licence.
225
226  "What is the URL to your licence?"
227
228If you used our recommendation above the URL you will want here is:
229http://creativecommons.org/licenses/by-sa/2.5/
230
231  "What is the URL to your local page about your licensing policy?"
232
233You should probably include a page on your wiki about your local licensing
234policy, but you can leave this blank for now if you don't have one yet.
235
236  "Distance calculation methods available are:
237      1) British National Grid
238      2) Irish National Grid
239      3) UTM ellipsoid
240   Which would you like to use?"
241
242  (and if you choose UTM ellipsoid)
243  "Which ellipsoid would you like to use? (eg 'Airy', 'WGS-84')"
244
245See http://www.vterrain.org/Projections/ for how this all works.
246A UTM (Universal Transverse Mercator) ellipsoid maps latitude and
247longitude to eastings and northings on a square grid, which allows
248more accurate distance calculations within the guide.  The British and
249Irish National Grids are scaled and parametrised versions of UTM
250ellipsoids (Airy 1830 in the British case, Modified Airy in the Irish).
251
252Please note that at the moment there is no provision for changing your
253mind later about which ellipsoid to use, but it shouldn't be too hard
254to write a conversion script so don't worry too much about picking the
255wrong one.  However do note that once you've entered some location
256data you should not change this value in the config file without running
257some kind of converter.
258
259If you decide to use the British or Irish National Grid, your users
260will be able to choose between entering location data as lat/long
261or as grid co-ordinates.
262
263You must have Geography::NationalGrid::GB installed to use the British
264National Grid, Geography::NationalGrid::IE to use the Irish National
265Grid, and Geo::Coordinates::UTM to use a UTM ellipsoid.
266
267If you want to use a UTM ellipsoid, WGS-84 is the best choice, as it
268will allow you to use the Google Maps support with the minimum of fuss.
269
270* Dependency errors
271
272If, after you have answered these questions, the build script complains
273about missing dependencies, don't panic! Simply install them from CPAN and
274then try again. Note that a wiki.conf file will have been written out at
275this point, so if you retain it you won't have to answer all the questions
276again.
277
278* Custom templates and CSS
279
280Once you have installed OpenGuides you may wish to edit templates that
281provide site-specific design. These templates are stored in the directory
282custom-templates/ by default and are described in the file CUSTOMISATION.
283The id and class tags used for the CSS in OpenGuides are specified in
284README.CSS.
285
286* Security
287
288The installer will try to create (or modify an existing) a .htaccess file
289to protect wiki.conf, which contains sensitive data (ie passwords).
290However we cannot tell whether apache (or any other web server you may be
291using) is using this file, so you should check that it functioning and that
292you cannot access wiki.conf over HTTP.
293
294You should also configure wiki.conf with the minimum permissions required
295so that local users cannot read the file. This is difficult to automate,
296but the file should be probably be mode 0640, owned by root or an admin
297user, and set to the group the web server runs with.
298
299* Web server configuration
300
301In order to let your web server serve up OpenGuides correctly, you will
302have to tell it to recognise your installation directory as one
303containing CGI scripts. However you can make your URLs nicer by
304employing mod_rewrite as well. The following Apache configuration
305directives show how:
306
307        Alias /myguide /usr/lib/cgi-bin/myguide
308        <Directory /usr/lib/cgi-bin/myguide>
309            Options FollowSymLinks Indexes ExecCGI
310            RewriteEngine on
311            RewriteBase /myguide/
312            RewriteRule ^$      wiki.cgi        [L]
313        </Directory>
314        Redirect /cgi-bin/myguide/ http://www.example.com/myguide/
315
316You will of course need to make the appropriate substitutions for
317your site. You also need to make sure that mod_rewrite is enabled in
318your web server before adding such a configuration. The final step in
319this URL tidying is to tell OpenGuides that the main CGI script can be
320assumed to be called from the root of the install directory; do this by
321setting the script name to be empty in wiki.conf:
322
323        # what do you want the script to be called?
324        script_name =
325
326Currently the Build script does not support this value, so you will
327have to make sure that you fix this up after an upgrade.
328
329
330* Multiple installations
331
332If you want to run multiple OpenGuides sites on one machine, you can use
333some tricks to make life easier. This isn't currently part of the official
334install routine, but will generally work. In the rest of this section we
335will assume that you already have a working OpenGuides install for a
336single site.
337
338Make a directory for the new site, and populate it with a set of symlinks
339to the main installation directory (ie. for wiki.cgi, supersearch.cgi,
340newpage.cgi, preferences.cgi, and the templates directory). wiki.conf
341will not be a symlink, since this will differ from the original site.
342In this case, simply copy the wiki.conf from the original install and
343modify it in the obvious way; most importantly, by giving it a different
344database name (we'll create the database in a moment). Don't forget to
345set up a separate directory for indices for the new site.
346
347Normally, the database is created by the installation process described
348above; however since we only want one copy of the modules and CGI
349programs, it isn't appropriate to run them again. So we will make use of
350the utility program "cgi-wiki-setupdb" which is included with the
351Wiki::Toolkit distribution. Documentation for this command can be found in
352its man page; run this with the appropriate arguments to create the
353new database.
354
355Once the key step of setting up the database has been performed, and the
356web server configured appropriately, the new site should be ready to go!
Note: See TracBrowser for help on using the repository browser.