source: trunk/README @ 66

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

Mentioned MySQL support and TROUBLESHOOTING file

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