Mercurial > p > roundup > code
diff doc/installation.txt @ 2407:ef226254ef46 maint-0.7
some more documentation work
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Wed, 09 Jun 2004 00:11:49 +0000 |
| parents | c8f426142289 |
| children | e12a610eb7f3 |
line wrap: on
line diff
--- a/doc/installation.txt Tue Jun 08 23:45:03 2004 +0000 +++ b/doc/installation.txt Wed Jun 09 00:11:49 2004 +0000 @@ -2,7 +2,7 @@ Installing Roundup ================== -:Version: $Revision: 1.76 $ +:Version: 1.76 .. contents:: @@ -49,8 +49,9 @@ Install the "CSV" module ------------------------ -Note: CSV stands for Comma-Separated-Value. These files are used by all - manner of programs (eg. spreadsheets) to exchange data. +.. hint:: + CSV stands for Comma-Separated-Value. These files are used by all + manner of programs (eg. spreadsheets) to exchange data. The "CSV" module is required if you wish to import or export data in the tracker, or if you wish to use the online generic class editing facility. @@ -115,10 +116,11 @@ Installation ============ -:Note: Some systems, such as Debian and NetBSD, already have Roundup - installed. Try running the command "roundup-admin" with no arguments, - and if it runs you may skip the `Basic Installation Steps`_ - below and go straight to `configuring your first tracker`_. +.. note:: + Some systems, such as Debian and NetBSD, already have Roundup + installed. Try running the command "roundup-admin" with no arguments, + and if it runs you may skip the `Basic Installation Steps`_ + below and go straight to `configuring your first tracker`_. Set aside 15-30 minutes. Please make sure you're using a supported version of Python -- see `testing your python`_. There's several steps to follow in your @@ -195,7 +197,7 @@ You will now be directed to edit the tracker configuration and initial schema. At a minimum, you must set ``MAILHOST``, - ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. Note that the + ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. The configuration file uses Python syntax, so almost every value must be ``'quoted'`` using single or double quotes. If you get stuck, and get configuration file errors, then see the `tracker configuration`_ section @@ -209,7 +211,7 @@ The URL *must* end in a '/', or your web interface *will not work*. See `Customising Roundup`_ for details on configuration and schema - changes. Note that you may change any of the configuration after + changes. You may change any of the configuration after you've initialised the tracker - it's just better to have valid values for this stuff now. @@ -312,7 +314,7 @@ restrict access to your tracker to only use HTTPS. Access will be slower than through the `stand-alone web server`_ though. -Note that if your Python isn't install as "python" then you'll need to edit +If your Python isn't install as "python" then you'll need to edit the ``roundup.cgi`` script to fix the first line. If you're using IIS on a Windows platform, you'll need to run this command
