Changeset 72


Ignore:
Timestamp:
Apr 26, 2003, 1:54:29 PM (19 years ago)
Author:
kake
Message:

Improved docs a bit, moved install stuff out of README to INSTALL

Location:
trunk
Files:
1 added
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/Changes

    r71 r72  
    44        Added PREREQUISITES file as requested by Cal.
    55        Fixed OpenGuides::Build to die if it can't find its prereqs.
    6         Ivor did something to supersearch.cgi
    7         Loads more shit I didn't write down.
     6        Ivor did something to supersearch.cgi, not sure what.
     7        Fixed bug noticed by Earle where website URLs were getting escaped
     8          (added check with URI::Find before writing that we only allow
     9           storage of an actual URL).
     10        Fixed bug where nodes without location metadata were defaulting to
     11          the origin of the British National Grid.
     12        Improved docs.
     13        Loads more stuff I didn't write down.
    814
    9150.02    23 April 2003
  • trunk/MANIFEST

    r71 r72  
    11Build.PL
    22Changes
    3 lib/OpenGuides/Build.pm
    4 lib/OpenGuides/RDF.pm
     3INSTALL
    54MANIFEST
    65META.yml
     
    87README
    98TROUBLESHOOTING
     9lib/OpenGuides/Build.pm
     10lib/OpenGuides/RDF.pm
    1011preferences.cgi
    1112supersearch.cgi
  • trunk/README

    r71 r72  
    99 - a Postgres or MySQL database dedicated to the OpenGuides installation
    1010
     11See the INSTALL file for details on how to install OpenGuides.
    1112
    1213
    13 If while following the instructions below or while trying to use your
    14 OpenGuides install you see an error that you don't understand, please
    15 consult the TROUBLESHOOTING file.
     14About OpenGuides
     15================
    1616
    1717
    18 
    19 Unpack the distribution (using for example 'tar' or 'WinZip'), and set
    20 your working directory to be the top level of the distribution, then
    21 execute the following commands:
    22 
    23 perl Build.PL
    24 perl Build
    25 perl Build test
    26 perl Build install
    27 
    28 The very first of these commands asks a number of questions regarding
    29 the installation.
     18**** THIS SOFTWARE IS VERY ALPHA.  It is released solely for those who ****
     19****     know what they're doing and want to play around with it.      ****
    3020
    3121
    32   "Skip OpenGuides configuration?"
     22The OpenGuides software provides the framework for a collaboratively-written
     23city guide.  It is similar to a wiki but provides somewhat more structured
     24data storage allowing you to annotate wiki pages with information such as
     25category, location, and much more.  It provides searching facilities
     26including "find me everything within a certain distance of this place".
     27Every page includes a link to a machine-readable (RDF) version of the page.
    3328
    34 Answer "n" to this question unless you really know what you're doing.
    35 It's mainly there for developers.
     29At the moment, the location data uses a United-Kingdom-specific module,
     30so the location features might not work so well outside the UK.
    3631
    3732
    38   "what type of database do you want the site to run on?  postgres/mysql"
     33Feedback
     34========
    3935
    40 Answer either "postgres" or "mysql".
    41 
    42 
    43   "What's the name of the database that this site runs on?"
    44   "And the database user that can access that database?"
    45   "And the password that they use to access the database?"
    46 
    47 You should create (or ask your ISP/sysadmin to create) a Postgres or
    48 MySQL database specifically for the use of OpenGuides.  If you have
    49 more than one OpenGuides installation, for example if you run guides
    50 for more than one city, each installation will need its own database.
    51 
    52 (TODO - support SQLite as well (requires faffing with install scripts,
    53 bit messy but CGI::Wiki already supports this so won't be hard))
    54 
    55 
    56   "What do you want the script to be called?"
    57 
    58 The default is for the main script to be called "wiki.cgi", but
    59 you may prefer to name it after your city - "leeds-guide.cgi" for
    60 example.  Note that your webserver may be configured to only allow
    61 execution of scripts ending in, for example, ".cgi"
    62 
    63 
    64   "What directory should I install it in?"
    65 
    66 You need to pick a directory for the OpenGuides software to be
    67 installed in.  This must be one known to the webserver as containing
    68 CGI scripts.  You will need to have write permission on this directory
    69 when you come to run "perl Build install"; unless this is a private
    70 directory belonging to you then this might require an 'su' or 'sudo'
    71 to root under Unix.
    72 
    73 
    74   "What URL does the install directory map to?"
    75 
    76 Give the full address needed to access the installation directory with
    77 a 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 
    82 You need a directory to store files used as indexes for the site. The
    83 user that your script will run as will need write permission on this
    84 directory.  Under some webserver configurations this might be a
    85 dedicated user - 'nobody' or 'www-data' for example, but for many
    86 multi-user systems this will just be yourself.
    87 
    88 
    89   "What's the URL of the wiki's stylesheet?"
    90 
    91 Supplying an answer to this question is optional.  TODO - supply and
    92 optionally install a simple stylesheet with the OpenGuides distribution.
    93 
    94 
    95   "What's the wiki called?"
    96 
    97 This is a title which will appear at the top of every page.
    98 
    99 
    100   "What should the home page of the wiki be called?"
    101   "How would you describe the wiki?"
    102   "What city is the wiki based in?"
    103   "What country is the wiki based in?"
    104   "Contact email address for the wiki admin?"
    105 
    106 Self explanatory.
    107 
     36If you have a question, a bug report, or a patch, or you're interested
     37in joining the development team, please contact grubstreet@hummous.earth.li
     38(moderated mailing list, will reach all current developers but you'll have
     39to wait for your post to be approved) or kake@earth.li (a real person who
     40may take a little while to reply to your mail if she's busy).
Note: See TracChangeset for help on using the changeset viewer.