source: trunk/INSTALL @ 501

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

Added option of munging in custom lib paths on install.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.6 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  "And the database user that can access that database?"
44  "And 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  "And 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 URL does the install directory map to?"
80
81Give the full address needed to access the installation directory with
82a web browser - for example http://london.openguides.org/cgi-bin/
83
84
85  "Do you want me to munge a custom lib path into the scripts?"
86
87If you have installed some or all of the required Perl modules (or indeed
88the OpenGuides modules themselves) into a private directory, you will
89need to tell the scripts where to find these modules.  Enter the paths
90to search here just as you would enter them in a 'use lib qw( ... );'
91in a Perl script.
92
93
94  "What directory can I use to store indexes in for searching?"
95
96You need a directory to store files used as indexes for the site. The
97user that your script will run as will need write permission on this
98directory.  Under some webserver configurations this might be a
99dedicated user - 'nobody' or 'www-data' for example, but for many
100multi-user systems this will just be yourself.
101
102
103  "Do you want to enable page deletion?"
104
105The default is to disable page deletion.  If you choose to enable the
106page deletion mechanism then you will need to add a password to your
107wiki.conf using a line such as
108  admin_pass = putyourpasswordhere
109Users who know this password will be able to delete unwanted pages -
110along with all their history - from your wiki.
111*** USE WITH CAUTION.  DELETED PAGES CANNOT BE RECOVERED. ***
112
113
114  "What's the URL of the wiki's stylesheet?"
115
116Supplying an answer to this question is optional.  There are example
117stylesheets in the examples/ directory - note that these will not be
118automatically installed.
119
120
121  "What's the wiki called?"
122
123This is a title which will appear at the top of every page.  If you have
124more than one OpenGuides installation at the same site then each should
125have a unique name, since this name is used to manage user preferences.
126
127
128  "Do you want the navigation bar included on the home page?"
129
130Answer "y" or "n".
131
132
133  "What should the home page of the wiki be called?"
134  "How would you describe the wiki?"
135  "What city is the wiki based in?"
136  "What country is the wiki based in?"
137  "Contact email address for the wiki admin?"
138
139Self explanatory.
140
141
142  "What's the name of the node to use for the text formatting rules link?"
143
144From 0.19, OpenGuides allows users to choose whether or not to have a
145permanent link to the text formatting rules node in their navbar.  You
146need to put the name of that node in here for it to work, though.  You
147might want to call the node "Text Formatting Examples", "Text
148Formatting Rules", "House Style" or whatever.
149
150
151* Web server configuration
152
153In order to let your web server serve up OpenGuides correctly, you will
154have to tell it to recognise your installation directory as one
155containing CGI scripts. However you can make your URLs nicer by
156employing mod_rewrite as well. The following Apache configuration
157directives show how:
158
159        Alias /myguide /usr/lib/cgi-bin/myguide
160        <Directory /usr/lib/cgi-bin/myguide>
161            Options FollowSymLinks Indexes ExecCGI
162            RewriteEngine on
163            RewriteBase /myguide/
164            RewriteRule ^$      wiki.cgi        [L]
165        </Directory>
166        Redirect /cgi-bin/myguide/ http://www.example.com/myguide/
167
168You will of course need to make the appropriate substitutions for
169your site. You also need to make sure that mod_rewrite is enabled in
170your web server before adding such a configuration. The final step in
171this URL tidying is to tell OpenGuides that the main CGI script can be
172assumed to be called from the root of the install directory; do this by
173setting the script name to be empty in wiki.conf:
174
175        # what do you want the script to be called?
176        script_name =
177
178Currently the Build script does not support this value, so you will
179have to make sure that you fix this up after an upgrade.
180
181
182* Multiple installations
183
184If you want to run multiple OpenGuides sites on one machine, you can use
185some tricks to make life easier. This isn't currently part of the official
186install routine, but will generally work. In the rest of this section we
187will assume that you already have a working OpenGuides install for a
188single site.
189
190Make a directory for the new site, and populate it with a set of symlinks
191to the main installation directory (ie. for wiki.cgi, supersearch.cgi,
192newpage.cgi, preferences.cgi, and the templates directory). wiki.conf
193will not be a symlink, since this will differ from the original site.
194In this case, simply copy the wiki.conf from the original install and
195modify it in the obvious way; most importantly, by giving it a different
196database name (we'll create the database in a moment). Don't forget to
197set up a separate directory for indices for the new site.
198
199Normally, the database is created by the installation process described
200above; however since we only want one copy of the modules and CGI
201programs, it isn't appropriate to run them again. So we will make use of
202the utility program "cgi-wiki-setupdb" which is included with the
203CGI::Wiki distribution. Documentation for this command can be found in
204its man page; run this with the appropriate arguments to create the
205new database.
206
207Once the key step of setting up the database has been performed, and the
208web server configured appropriately, the new site should be ready to go!
Note: See TracBrowser for help on using the repository browser.