source: trunk/INSTALL @ 962

Last change on this file since 962 was 962, checked in by kake, 15 years ago

Add config option to place content above navbar in HTML.

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