doc/installation.txt

   1 ==================
   2 Installing Roundup
   3 ==================
   4
   5 :Version: $Revision: 1.14 $
   6
   7 .. contents::
   8
   9
  10 Overview
  11 ========
  12
  13 Broken out separately, there are several conceptual pieces to a
  14 Roundup installation:
  15
  16 Roundup support code
  17  Installed into your Python install's lib directory
  18
  19 Roundup scripts
  20  These include the email gateway, the roundup
  21  HTTP server, the roundup administration command-line interface, etc.
  22
  23 Roundup instances
  24  Instances consist of core support files, issues
  25  (be they bug reports or otherwise), instance configuration file(s),
  26  etc.  Roundup instances also adhere to a specific "Template" which
  27  defines the fields usable/assignable on a per-issue basis.  A
  28  description of the provided templates follows.
  29
  30 Classic Template
  31 ----------------
  32
  33 The classic template is the one defined in the `Roundup Specification`_. It
  34 holds issues which have priorities and statuses. Each issue may also have a
  35 set of messages which are disseminated to the issue's list of nosy users.
  36
  37
  38 Extended Template
  39 -----------------
  40
  41 The extended template adds additional information to issues: product,
  42 platform, version, targetversion and supportcall.
  43 There is an additional class for
  44 handling support calls, which includes a time log, customername, rate and
  45 source.
  46
  47 The priorty class has different default entries too: "fatal-bug", "bug",
  48 "usability" and "feature".
  49
  50 Users of this template will want to change the contents of the product
  51 class as soon as the instance is created.
  52
  53
  54 Prerequisites
  55 =============
  56
  57 Python 2.1.1 or newer with a functioning anydbm or bsddb module. Download the
  58 latest version from http://www.python.org/. It is highly recommended that
  59 users install the latest patch version of python - 2.1.3 or 2.2.1 - as these
  60 contain many fixes to serious bugs.
  61
  62 If you want to use Berkeley DB bsddb3 with Roundup, use version 3.3.0 or
  63 later. Download the latest version from http://pybsddb.sourceforge.net/.
  64
  65
  66 Testing your Python
  67 -------------------
  68
  69 Run ``python ./run_tests`` and make sure there
  70 are no errors.  If there are errors, please let us know!
  71
  72 If the above fails, you may be using the wrong version of python. Try
  73 ``python2 ./run_tests``. If that works, you will need to substitute
  74 ``python2`` for ``python`` in all further commands you use in relation to
  75 Roundup -- from installation and scripts.
  76
  77 Getting Roundup
  78 ===============
  79
  80 Download the latest version from http://roundup.sf.net/.
  81
  82
  83 Installation
  84 ============
  85
  86 Set aside 15-30 minutes. Please make sure you're using a supported version of
  87 Python -- see `testing your python`_.
  88
  89 1. To install the Roundup support code into your Python tree and
  90    Roundup scripts into /usr/local/bin::
  91
  92        python setup.py install
  93
  94    If you would like to place the Roundup scripts in a directory other
  95    than ``/usr/local/bin``, use the ``--install-scripts`` option as follows,
  96    replacing ``/opt/roundup/bin`` with the location where you would like
  97    the scripts to reside::
  98
  99        python setup.py install --install-scripts=/opt/roundup/bin
 100
 101 2. To create a Roundup instance (necessary to do before you can
 102    use the software in any real fashion):
 103
 104    a. (Optional) If you intend to keep your roundup instances
 105       under one top level directory which does not exist yet,
 106       you should create that directory now.  Example:
 107
 108          mkdir /opt/roundup/instances
 109
 110    b. Either add the Roundup script location to your ``PATH``
 111       environment variable or specify the full path to
 112       the command in the next step.
 113
 114    c.  ``roundup-admin install``
 115
 116       You will be asked a series of questions.  A description of
 117       the Roundup-provided templates can be found under the Overview_::
 118
 119           Enter instance home: /opt/roundup/instances/support
 120           Templates: classic, extended
 121           Select template [classic]: classic
 122           Back ends: anydbm, bsddb
 123           Select backend [anydbm]: anydbm
 124
 125       You will now be directed to edit the instance configuration and
 126       initial schema. See `Customising Roundup`_ for details on configuration
 127       and schema changes.
 128
 129    d.  ``roundup-admin initialise``
 130
 131       This step initialises the instance database. You will need to supply
 132       an admin password at this step. You will be prompted:
 133
 134           Admin Password:
 135                  Confirm:
 136
 137       Once this is done, the instance has been created.
 138
 139 3. Each instance ideally should have its own UNIX group, so create
 140    a UNIX group (edit ``/etc/group`` or your appropriate NIS map if
 141    you're using NIS).  To continue with my examples so far, I would
 142    create the UNIX group 'support', although the name of the UNIX
 143    group does not have to be the same as the instance name.  To this
 144    'support' group I then add all of the UNIX usernames who will be
 145    working with this Roundup instance.  In addition to 'real' users,
 146    the Roundup email gateway will need to have permissions to this
 147    area as well, so add the user your mail service runs as to the
 148    group.  The UNIX group might then look like::
 149
 150         support:*:1002:jblaine,samh,geezer,mail
 151
 152    If you intend to use the web interface (as most people do), you
 153    should also add the username your web server runs as to the group.
 154    My group now looks like this::
 155
 156         support:*:1002:jblaine,samh,geezer,mail,apache
 157
 158 4. Configure your new instance by editing the file ``instance_config.py``
 159    located in the instance home you specified in step 2c above.  This
 160    file is Python code and must adhere to Python syntax rules, but
 161    don't be daunted if you do not know Python - it should look pretty
 162    straightfoward if you carefully read the comments in the file.
 163
 164 5. There are two supported ways to get emailed issues into the
 165    Roundup instance.  You should pick ONE of the following, both
 166    of which will continue my example setup from above:
 167
 168    a. Set up a mail alias called "support" as::
 169
 170        "|/opt/roundup/bin/roundup-mailgw /opt/roundup/instances/support"
 171
 172       If you use Sendmail's ``smrsh`` mechanism, please read the notes
 173       under 'Platform-Specific Notes'
 174
 175    b. OR... Configure roundup-mailgw to run every 10 minutes or
 176       so via ``cron``.  My cron job would be (these 2 lines all on one
 177       line)::
 178
 179        10 * * * * /opt/roundup/bin/roundup-mailgw
 180                 /opt/roundup/instances/support /var/mail/support
 181
 182 6. TODO (mention perms)
 183
 184 7. Test the email gateway.  Under most flavors of UNIX, this
 185    can be done by::
 186
 187      echo test | mail -s '[issue] test' support@YOUR_DOMAIN_HERE
 188
 189
 190 Upgrading
 191 =========
 192
 193 Read the separate `upgrading document`_, which describes the steps needed to
 194 upgrade existing tracker instances for each version of Roundup that is
 195 released.
 196
 197
 198 ZRoundup
 199 ========
 200
 201 Install roundup as usual (see installation_).
 202
 203 ZRoundup installs as a regular Zope product. Copy the ZRoundup directory to
 204 your Products directory either in an INSTANCE_HOME/Products or the Zope
 205 code tree lib/python/Products.
 206
 207 You will need to create the instance using the roundup-admin tool (step 2 in
 208 installation_).
 209
 210 When you next (re)start up Zope, you will be able to add a ZRoundup object
 211 that interfaces to your new instance.
 212
 213
 214 Further Reading
 215 ===============
 216
 217 If you intend to use Roundup with anything other than the defualt
 218 templates, if you would like to hack on Roundup, or if you would
 219 like implementation details, you should read `Customising Roundup`_.
 220
 221
 222 Platform-Specific Notes
 223 =======================
 224
 225 Sendmail smrsh
 226 --------------
 227
 228 If you use Sendmail's ``smrsh`` mechanism, you will need to tell
 229 smrsh that roundup-mailgw is a valid/trusted mail handler
 230 before it will work.
 231
 232 This is usually done via the following 2 steps:
 233
 234 1. make a symlink in ``/etc/smrsh`` called ``roundup-mailgw``
 235    which points to the full path of your actual ``roundup-mailgw``
 236    script.
 237
 238 2. change your alias to ``"|roundup-mailgw <instance_home>"``
 239
 240
 241 Linux
 242 -----
 243
 244 Python 2.1.1 as shipped with SuSE7.3 might be missing module
 245 ``_weakref``.
 246
 247 -------------------------------------------------------------------------------
 248
 249 Back to `Table of Contents`_
 250
 251 Next: `Getting Started`_
 252
 253 .. _`table of contents`: index.html
 254 .. _`getting started`: getting_started.html
 255 .. _`roundup specification`: spec.html
 256 .. _`customising roundup`: customizing.html
 257 .. _`upgrading document`: upgrading.html
 258