source: trunk/INSTALL @ 175

Last change on this file since 175 was 175, checked in by kake, 19 years ago

Added example stylesheet. This is release 0.17

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.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
9
10
11Unpack the distribution (using for example 'tar' or 'WinZip'), and set
12your working directory to be the top level of the distribution, then
13execute the following commands:
14
15perl Build.PL
16perl Build
17perl Build test
18perl Build install
19
20The very first of these commands asks a number of questions regarding
21the installation.
22
23
24  "Skip OpenGuides configuration?"
25
26Answer "n" to this question unless you really know what you're doing.
27It's mainly there for developers.
28
29
30  "what type of database do you want the site to run on?  postgres/mysql"
31
32Answer either "postgres" or "mysql".
33
34
35  "What's the name of the database that this site runs on?"
36  "And the database user that can access that database?"
37  "And the password that they use to access the database?"
38
39You should create (or ask your ISP/sysadmin to create) a Postgres or
40MySQL database specifically for the use of OpenGuides.  If you have
41more than one OpenGuides installation, for example if you run guides
42for more than one city, each installation will need its own database.
43(TODO - support SQLite as well (requires faffing with install scripts,
44bit messy but CGI::Wiki already supports this so won't be hard))
45
46
47  "And the machine that the database is hosted on? (blank if local)",
48
49If the database is running on a local machine with username/password
50authentication then just press RETURN to skip this question.  If it
51is running on a local machine with IDENT authentication then you may
52need to answer "localhost" to this question.  If it is running on a
53remote machine then enter the full hostname of that machine.
54
55
56  "What do you want the script to be called?"
57
58The default is for the main script to be called "wiki.cgi", but
59you may prefer to name it after your city - "leeds-guide.cgi" for
60example.  Note that your webserver may be configured to only allow
61execution of scripts ending in, for example, ".cgi"
62
63
64  "What directory should I install it in?"
65
66You need to pick a directory for the OpenGuides software to be
67installed in.  This must be one known to the webserver as containing
68CGI scripts.  You will need to have write permission on this directory
69when you come to run "perl Build install"; unless this is a private
70directory belonging to you then this might require an 'su' or 'sudo'
71to root under Unix.
72
73
74  "What URL does the install directory map to?"
75
76Give the full address needed to access the installation directory with
77a web browser - for example http://london.openguides.org/cgi-bin/
78
79
80  "What directory can I use to store indexes in for searching?"
81
82You need a directory to store files used as indexes for the site. The
83user that your script will run as will need write permission on this
84directory.  Under some webserver configurations this might be a
85dedicated user - 'nobody' or 'www-data' for example, but for many
86multi-user systems this will just be yourself.
87
88
89  "What's the URL of the wiki's stylesheet?"
90
91Supplying an answer to this question is optional.  There is an example
92stylesheet supplied by the Oxford OpenGuides team in the examples/
93directory - note that this will not be automatically installed.
94
95
96  "What's the wiki called?"
97
98This is a title which will appear at the top of every page.  If you have
99more than one OpenGuides installation at the same site then each should
100have a unique name, since this name is used to manage user preferences.
101
102
103  "What should the home page of the wiki be called?"
104  "How would you describe the wiki?"
105  "What city is the wiki based in?"
106  "What country is the wiki based in?"
107  "Contact email address for the wiki admin?"
108
109Self explanatory.
110
Note: See TracBrowser for help on using the repository browser.