Changeset 40 for trunk/README

Show
Ignore:
Timestamp:
04/20/03 23:13:16 (6 years ago)
Author:
kake
Message:

Rewritten a bit and added some examples

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/README

    r39 r40  
    1 OpenGuides Version ?.?? 
     1OpenGuides Version 0.01 
    22======================= 
    33 
    4 This module is for installing the OpenGuides wiki software. Note that it 
    5 uses Module::Build, which is a major prerequisite to installation. This 
    6 is website software, hence requires a webserver such as Apache to be  
    7 available on the host you are installing onto. The installation also 
    8 requires a Postgres database to be available, with the user ID and password 
    9 that the site will use. 
     4This distribution contains the OpenGuides wiki software. It requires: 
    105 
    11 Expand out the distribution, and set your working directory to be the 
    12 top level of the distribution, then execute the following commands: 
     6 - Module::Build for installation 
     7 - a webserver (such as Apache) 
     8 - a Postgres database dedicated to the OpenGuides installation 
     9 
     10Unpack the distribution (using for example 'tar' or 'WinZip'), and set 
     11your working directory to be the top level of the distribution, then 
     12execute the following commands: 
    1313 
    1414perl Build.PL 
    … …  
    2121 
    2222"What do you want the script to be called?" 
    23 You can call it what you like. The program is a perl script (file.pl), and 
    24 calling it a .pl will definitely work, but some may argue that this conveys 
    25 too much information to a cracker about your site - that you are running a 
    26 perl script. 
    2723 
    28 "what directory should I install it in?" 
    29 At the time you come to do "Build install", you need to have write permission 
    30 to this directory. This may require a su or sudo as root, to place files in 
    31 a directory such as /usr/lib/cgi-bin/openguides/. Note: you want to put the  
    32 file into a directory known to the webserver as containing CGI scripts. 
     24The default is for the main script to be called "wiki.cgi", but 
     25you may prefer to name it after your city - "leeds-guide.cgi" for 
     26example.  Note that your webserver may be configured to only allow 
     27execution of scripts ending in, for example, ".cgi" 
    3328 
    34 "what URL does the install directory map to?" 
    35 Give the full http: address of the cgi-bin directory in the previous answer. 
     29"What directory should I install it in?" 
    3630 
    37 "what directory can I use to store indexes in for searching?" 
    38 You need a directory to store files used as indexes for the site. The  
    39 webserver will need write permission to this directory. 
     31You need to pick a directory for the OpenGuides software to be 
     32installed in.  This must be one known to the webserver as containing 
     33CGI scripts.  You will need to have write permission on this directory 
     34when you come to run "perl Build install"; unless this is a private 
     35directory belonging to you then this might require an 'su' or 'sudo' 
     36to root under Unix. 
    4037 
    41 "what's the URL of the wiki's stylesheet?" 
    42 The distribution comes supplied with a sample stylesheet for use with an 
    43 OpenGuides site. You need to install this to a place where the webserver 
    44 can see it. !!Todo!! 
     38"What URL does the install directory map to?" 
    4539 
    46 "what's the name of the postgres database that this site runs on?" 
    47 "and the database user that can access that database?" 
    48 "and the password that they use to access the database?" 
    49 These questions refer to the postgres database referred to at the start. 
     40Give the full address needed to access the installation directory with 
     41a web browser - for example http://london.openguides.org/cgi-bin/ 
    5042 
    51 "what's the wiki called?" 
     43"What directory can I use to store indexes in for searching?" 
     44 
     45You need a directory to store files used as indexes for the site. The 
     46webserver will need write permission on this directory.  Under some 
     47webserver configurations this might be a dedicated user - 'nobody' or 
     48'www-data' for example, but for many multi-user systems this will just 
     49be yourself. 
     50 
     51"What's the URL of the wiki's stylesheet?" 
     52 
     53Supplying an answer to this question is optional.  TODO - supply and 
     54optionally install a simple stylesheet with the OpenGuides distribution. 
     55 
     56"What's the name of the postgres database that this site runs on?" 
     57"And the database user that can access that database?" 
     58"And the password that they use to access the database?" 
     59 
     60You should create (or ask your ISP/sysadmin to create) a Postgres 
     61database specifically for the use of OpenGuides.  If you have more 
     62than one OpenGuides installation, for example if you run guides for 
     63more than one city, each installation will need its own database. 
     64 
     65TODO - support MySQL and SQLite as well (this is really going to be 
     66pretty trivial). 
     67 
     68"What's the wiki called?" 
     69 
    5270This is a title which will appear at the top of every page. 
    5371 
    54 "what should the home page of the wiki be called?" 
    55 "how would you describe the wiki?" 
    56 "what city is the wiki based in?" 
    57 "what country is the wiki based in?" 
    58 "contact email address for the wiki admin?" 
     72"What should the home page of the wiki be called?" 
     73"How would you describe the wiki?" 
     74"What city is the wiki based in?" 
     75"What country is the wiki based in?" 
     76"Contact email address for the wiki admin?" 
     77 
    5978Self explanatory. 
    6079