source: trunk/INSTALL @ 823

Last change on this file since 823 was 785, checked in by Dominic Hargreaves, 16 years ago

Use Wiki::Toolkit. Note that CGI::Wiki::Plugin::Diff hasn't been converted yet,
so tests will be broken for now.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.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 Wiki::Toolkit 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  "Make node titles link to node backlinks (C2 style)?"
195
196This refers to turning titles into links which bring up a list of referring
197pages. This was the convention with older wikis, but is not intuitive.
198
199  "Do you have a Google Maps API key to use with this guide?"
200
201If you want Google Maps integration, you need to register with Google to get
202an API key. Visit http://www.google.com/apis/maps/signup.html and follow the
203instructions. Paste the great long string into the console window where you
204are installing. See README.GMAPS for more information.
205
206  "What is the longitude of the centre point of a map to draw for your guide?"
207  "What is the latitude of the centre point of a map to draw for your guide?"
208
209It's probably a good idea to pick some notionally central point for your
210guide. For example, Carfax for Oxford, Charing Cross for London.
211
212  "What default zoom level shall we use for Google Maps?"
213  "What default zoom level shall we use for Google Maps in the search results?"
214
215The defaults are probably appropriate in most cases.
216
217  "Forcibly treat stored lat/long data as if they used the WGS84 ellipsoid?"
218
219Default this answer if you don't know what it means.
220
221  "What licence will you use for the guide?"
222
223We strongly recommend that you think at the outset about the licence your
224guide will use, for maximum usefulness. In particular for a guide that will
225be on the OpenGuides network, we recommend the
226"Creative Commons Attribution-ShareAlike 2.5" licence.
227
228  "What is the URL to your licence?"
229
230If you used our recommendation above the URL you will want here is:
231http://creativecommons.org/licenses/by-sa/2.5/
232
233  "What is the URL to your local page about your licensing policy?"
234
235You should probably include a page on your wiki about your local licensing
236policy, but you can leave this blank for now if you don't have one yet.
237
238  "Distance calculation methods available are:
239      1) British National Grid
240      2) Irish National Grid
241      3) UTM ellipsoid
242   Which would you like to use?"
243
244  (and if you choose UTM ellipsoid)
245  "Which ellipsoid would you like to use? (eg 'Airy', 'WGS-84')"
246
247See http://www.vterrain.org/Projections/ for how this all works.
248A UTM (Universal Transverse Mercator) ellipsoid maps latitude and
249longitude to eastings and northings on a square grid, which allows
250more accurate distance calculations within the guide.  The British and
251Irish National Grids are scaled and parametrised versions of UTM
252ellipsoids (Airy 1830 in the British case, Modified Airy in the Irish).
253
254Please note that at the moment there is no provision for changing your
255mind later about which ellipsoid to use, but it shouldn't be too hard
256to write a conversion script so don't worry too much about picking the
257wrong one.  However do note that once you've entered some location
258data you should not change this value in the config file without running
259some kind of converter.
260
261If you decide to use the British or Irish National Grid, your users
262will be able to choose between entering location data as lat/long
263or as grid co-ordinates.
264
265You must have Geography::NationalGrid::GB installed to use the British
266National Grid, Geography::NationalGrid::IE to use the Irish National
267Grid, and Geo::Coordinates::UTM to use a UTM ellipsoid.
268
269If you want to use a UTM ellipsoid, WGS-84 is the best choice, as it
270will allow you to use the Google Maps support with the minimum of fuss.
271
272* Dependency errors
273
274If, after you have answered these questions, the build script complains
275about missing dependencies, don't panic! Simply install them from CPAN and
276then try again. Note that a wiki.conf file will have been written out at
277this point, so if you retain it you won't have to answer all the questions
278again.
279
280* Custom templates and CSS
281
282Once you have installed OpenGuides you may wish to edit templates that
283provide site-specific design. These templates are stored in the directory
284custom-templates/ by default and are described in the file CUSTOMISATION.
285The id and class tags used for the CSS in OpenGuides are specified in
286README.CSS.
287
288* Security
289
290The installer will try to create (or modify an existing) a .htaccess file
291to protect wiki.conf, which contains sensitive data (ie passwords).
292However we cannot tell whether apache (or any other web server you may be
293using) is using this file, so you should check that it functioning and that
294you cannot access wiki.conf over HTTP.
295
296You should also configure wiki.conf with the minimum permissions required
297so that local users cannot read the file. This is difficult to automate,
298but the file should be probably be mode 0640, owned by root or an admin
299user, and set to the group the web server runs with.
300
301* Web server configuration
302
303In order to let your web server serve up OpenGuides correctly, you will
304have to tell it to recognise your installation directory as one
305containing CGI scripts. However you can make your URLs nicer by
306employing mod_rewrite as well. The following Apache configuration
307directives show how:
308
309        Alias /myguide /usr/lib/cgi-bin/myguide
310        <Directory /usr/lib/cgi-bin/myguide>
311            Options FollowSymLinks Indexes ExecCGI
312            RewriteEngine on
313            RewriteBase /myguide/
314            RewriteRule ^$      wiki.cgi        [L]
315        </Directory>
316        Redirect /cgi-bin/myguide/ http://www.example.com/myguide/
317
318You will of course need to make the appropriate substitutions for
319your site. You also need to make sure that mod_rewrite is enabled in
320your web server before adding such a configuration. The final step in
321this URL tidying is to tell OpenGuides that the main CGI script can be
322assumed to be called from the root of the install directory; do this by
323setting the script name to be empty in wiki.conf:
324
325        # what do you want the script to be called?
326        script_name =
327
328Currently the Build script does not support this value, so you will
329have to make sure that you fix this up after an upgrade.
330
331
332* Multiple installations
333
334If you want to run multiple OpenGuides sites on one machine, you can use
335some tricks to make life easier. This isn't currently part of the official
336install routine, but will generally work. In the rest of this section we
337will assume that you already have a working OpenGuides install for a
338single site.
339
340Make a directory for the new site, and populate it with a set of symlinks
341to the main installation directory (ie. for wiki.cgi, supersearch.cgi,
342newpage.cgi, preferences.cgi, and the templates directory). wiki.conf
343will not be a symlink, since this will differ from the original site.
344In this case, simply copy the wiki.conf from the original install and
345modify it in the obvious way; most importantly, by giving it a different
346database name (we'll create the database in a moment). Don't forget to
347set up a separate directory for indices for the new site.
348
349Normally, the database is created by the installation process described
350above; however since we only want one copy of the modules and CGI
351programs, it isn't appropriate to run them again. So we will make use of
352the utility program "cgi-wiki-setupdb" which is included with the
353Wiki::Toolkit distribution. Documentation for this command can be found in
354its man page; run this with the appropriate arguments to create the
355new database.
356
357Once the key step of setting up the database has been performed, and the
358web server configured appropriately, the new site should be ready to go!
Note: See TracBrowser for help on using the repository browser.